Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RedshiftData.ListStatements

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

This operation returns paginated results.

Synopsis

data ListStatements = ListStatements' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- roleLevel :: Maybe Bool
- statementName :: Maybe Text
- status :: Maybe StatusString
}
newListStatements :: ListStatements
listStatements_maxResults :: Lens' ListStatements (Maybe Natural)
listStatements_nextToken :: Lens' ListStatements (Maybe Text)
listStatements_roleLevel :: Lens' ListStatements (Maybe Bool)
listStatements_statementName :: Lens' ListStatements (Maybe Text)
listStatements_status :: Lens' ListStatements (Maybe StatusString)
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.

Constructors

ListStatements'

Fields

maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
roleLevel :: Maybe Bool
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.
statementName :: Maybe Text
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.
status :: Maybe StatusString
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.

Instances

Instances details

ToJSON ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods toJSON :: ListStatements -> Value # toEncoding :: ListStatements -> Encoding # toJSONList :: [ListStatements] -> Value # toEncodingList :: [ListStatements] -> Encoding #
ToHeaders ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods toHeaders :: ListStatements -> [Header] #
ToPath ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods toPath :: ListStatements -> ByteString #
ToQuery ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods toQuery :: ListStatements -> QueryString #
AWSPager ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods page :: ListStatements -> AWSResponse ListStatements -> Maybe ListStatements #
AWSRequest ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Associated Types type AWSResponse ListStatements # Methods request :: (Service -> Service) -> ListStatements -> Request ListStatements # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStatements -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStatements))) #
Generic ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Associated Types type Rep ListStatements :: Type -> Type # Methods from :: ListStatements -> Rep ListStatements x # to :: Rep ListStatements x -> ListStatements #
Read ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods readsPrec :: Int -> ReadS ListStatements # readList :: ReadS [ListStatements] # readPrec :: ReadPrec ListStatements # readListPrec :: ReadPrec [ListStatements] #
Show ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods showsPrec :: Int -> ListStatements -> ShowS # show :: ListStatements -> String # showList :: [ListStatements] -> ShowS #
NFData ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods rnf :: ListStatements -> () #
Eq ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods (==) :: ListStatements -> ListStatements -> Bool # (/=) :: ListStatements -> ListStatements -> Bool #
Hashable ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods hashWithSalt :: Int -> ListStatements -> Int # hash :: ListStatements -> Int #
type AWSResponse ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements type AWSResponse ListStatements = ListStatementsResponse
type Rep ListStatements Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements type Rep ListStatements = D1 ('MetaData "ListStatements" "Amazonka.RedshiftData.ListStatements" "amazonka-redshift-data-2.0-Hy9KEgtH5Bc3altuyuPuYo" 'False) (C1 ('MetaCons "ListStatements'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "roleLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "statementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusString))))))

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: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.

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: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.

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.

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.

Request Lenses

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.

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_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_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_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.

Destructuring the Response

data ListStatementsResponse Source #

See: newListStatementsResponse smart constructor.

Constructors

ListStatementsResponse'

Fields

nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.
statements :: [StatementData]
The SQL statements.

Instances

Instances details

Generic ListStatementsResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Associated Types type Rep ListStatementsResponse :: Type -> Type # Methods from :: ListStatementsResponse -> Rep ListStatementsResponse x # to :: Rep ListStatementsResponse x -> ListStatementsResponse #
Read ListStatementsResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods readsPrec :: Int -> ReadS ListStatementsResponse # readList :: ReadS [ListStatementsResponse] # readPrec :: ReadPrec ListStatementsResponse # readListPrec :: ReadPrec [ListStatementsResponse] #
Show ListStatementsResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods showsPrec :: Int -> ListStatementsResponse -> ShowS # show :: ListStatementsResponse -> String # showList :: [ListStatementsResponse] -> ShowS #
NFData ListStatementsResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods rnf :: ListStatementsResponse -> () #
Eq ListStatementsResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements Methods (==) :: ListStatementsResponse -> ListStatementsResponse -> Bool # (/=) :: ListStatementsResponse -> ListStatementsResponse -> Bool #
type Rep ListStatementsResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListStatements type Rep ListStatementsResponse = D1 ('MetaData "ListStatementsResponse" "Amazonka.RedshiftData.ListStatements" "amazonka-redshift-data-2.0-Hy9KEgtH5Bc3altuyuPuYo" 'False) (C1 ('MetaCons "ListStatementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "statements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StatementData]))))

newListStatementsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStatementsResponse'`
-> ListStatementsResponse

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:

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.