Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
This operation returns paginated results.
Synopsis
- data ListStatements = ListStatements' {}
- newListStatements :: ListStatements
- listStatements_status :: Lens' ListStatements (Maybe StatusString)
- listStatements_nextToken :: Lens' ListStatements (Maybe Text)
- listStatements_statementName :: Lens' ListStatements (Maybe Text)
- listStatements_roleLevel :: Lens' ListStatements (Maybe Bool)
- listStatements_maxResults :: Lens' ListStatements (Maybe Natural)
- data ListStatementsResponse = ListStatementsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- statements :: [StatementData]
- newListStatementsResponse :: Int -> ListStatementsResponse
- listStatementsResponse_nextToken :: Lens' ListStatementsResponse (Maybe Text)
- listStatementsResponse_httpStatus :: Lens' ListStatementsResponse Int
- listStatementsResponse_statements :: Lens' ListStatementsResponse [StatementData]
Creating a Request
data ListStatements Source #
See: newListStatements
smart constructor.
ListStatements' | |
|
Instances
newListStatements :: ListStatements Source #
Create a value of ListStatements
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ListStatements'
, listStatements_status
- The status of the SQL statement to list. Status values are defined as
follows:
- ABORTED - The query run was stopped by the user.
- ALL - A status value that includes all query statuses. This value can be used to filter results.
- FAILED - The query run failed.
- FINISHED - The query has finished running.
- PICKED - The query has been chosen to be run.
- STARTED - The query run has started.
- SUBMITTED - The query was submitted, but not yet processed.
$sel:nextToken:ListStatements'
, listStatements_nextToken
- A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response,
you can retrieve the next set of records by providing this returned
NextToken value in the next NextToken parameter and retrying the
command. If the NextToken field is empty, all response records have been
retrieved for the request.
$sel:statementName:ListStatements'
, listStatements_statementName
- The name of the SQL statement specified as input to
BatchExecuteStatement
or ExecuteStatement
to identify the query. You
can list multiple statements by providing a prefix that matches the
beginning of the statement name. For example, to list myStatement1,
myStatement2, myStatement3, and so on, then provide the a value of
myStatement
. Data API does a case-sensitive match of SQL statement
names to the prefix value you provide.
$sel:roleLevel:ListStatements'
, listStatements_roleLevel
- A value that filters which statements to return in the response. If
true, all statements run by the caller's IAM role are returned. If
false, only statements run by the caller's IAM role in the current IAM
session are returned. The default is true.
$sel:maxResults:ListStatements'
, listStatements_maxResults
- The maximum number of SQL statements to return in the response. If more
SQL statements exist than fit in one response, then NextToken
is
returned to page through the results.
Request Lenses
listStatements_status :: Lens' ListStatements (Maybe StatusString) Source #
The status of the SQL statement to list. Status values are defined as follows:
- ABORTED - The query run was stopped by the user.
- ALL - A status value that includes all query statuses. This value can be used to filter results.
- FAILED - The query run failed.
- FINISHED - The query has finished running.
- PICKED - The query has been chosen to be run.
- STARTED - The query run has started.
- SUBMITTED - The query was submitted, but not yet processed.
listStatements_nextToken :: Lens' ListStatements (Maybe Text) Source #
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
listStatements_statementName :: Lens' ListStatements (Maybe Text) Source #
The name of the SQL statement specified as input to
BatchExecuteStatement
or ExecuteStatement
to identify the query. You
can list multiple statements by providing a prefix that matches the
beginning of the statement name. For example, to list myStatement1,
myStatement2, myStatement3, and so on, then provide the a value of
myStatement
. Data API does a case-sensitive match of SQL statement
names to the prefix value you provide.
listStatements_roleLevel :: Lens' ListStatements (Maybe Bool) Source #
A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
listStatements_maxResults :: Lens' ListStatements (Maybe Natural) Source #
The maximum number of SQL statements to return in the response. If more
SQL statements exist than fit in one response, then NextToken
is
returned to page through the results.
Destructuring the Response
data ListStatementsResponse Source #
See: newListStatementsResponse
smart constructor.
ListStatementsResponse' | |
|
Instances
newListStatementsResponse Source #
Create a value of ListStatementsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListStatements'
, listStatementsResponse_nextToken
- A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response,
you can retrieve the next set of records by providing this returned
NextToken value in the next NextToken parameter and retrying the
command. If the NextToken field is empty, all response records have been
retrieved for the request.
$sel:httpStatus:ListStatementsResponse'
, listStatementsResponse_httpStatus
- The response's http status code.
$sel:statements:ListStatementsResponse'
, listStatementsResponse_statements
- The SQL statements.
Response Lenses
listStatementsResponse_nextToken :: Lens' ListStatementsResponse (Maybe Text) Source #
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
listStatementsResponse_httpStatus :: Lens' ListStatementsResponse Int Source #
The response's http status code.
listStatementsResponse_statements :: Lens' ListStatementsResponse [StatementData] Source #
The SQL statements.