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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

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 GetStatementResult = GetStatementResult' {
- nextToken :: Maybe Text
- id :: Text
}
newGetStatementResult :: Text -> GetStatementResult
getStatementResult_nextToken :: Lens' GetStatementResult (Maybe Text)
getStatementResult_id :: Lens' GetStatementResult Text
data GetStatementResultResponse = GetStatementResultResponse' {
- columnMetadata :: Maybe [ColumnMetadata]
- nextToken :: Maybe Text
- totalNumRows :: Maybe Integer
- httpStatus :: Int
- records :: [[Field]]
}
newGetStatementResultResponse :: Int -> GetStatementResultResponse
getStatementResultResponse_columnMetadata :: Lens' GetStatementResultResponse (Maybe [ColumnMetadata])
getStatementResultResponse_nextToken :: Lens' GetStatementResultResponse (Maybe Text)
getStatementResultResponse_totalNumRows :: Lens' GetStatementResultResponse (Maybe Integer)
getStatementResultResponse_httpStatus :: Lens' GetStatementResultResponse Int
getStatementResultResponse_records :: Lens' GetStatementResultResponse [[Field]]

Creating a Request

data GetStatementResult Source #

See: newGetStatementResult smart constructor.

Constructors

GetStatementResult'

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.
id :: Text
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

Instances

Instances details

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

newGetStatementResult Source #

Arguments

:: Text	`GetStatementResult`
-> GetStatementResult

Create a value of GetStatementResult 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:

GetStatementResult, getStatementResult_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.

GetStatementResult, getStatementResult_id - The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

Request Lenses

getStatementResult_nextToken :: Lens' GetStatementResult (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.

getStatementResult_id :: Lens' GetStatementResult Text Source #

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

Destructuring the Response

data GetStatementResultResponse Source #

See: newGetStatementResultResponse smart constructor.

Constructors

GetStatementResultResponse'

Fields

columnMetadata :: Maybe [ColumnMetadata]
The properties (metadata) of a column.
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.
totalNumRows :: Maybe Integer
The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.
httpStatus :: Int
The response's http status code.
records :: [[Field]]
The results of the SQL statement.

Instances

Instances details

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

newGetStatementResultResponse Source #

Arguments

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

Create a value of GetStatementResultResponse 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:columnMetadata:GetStatementResultResponse', getStatementResultResponse_columnMetadata - The properties (metadata) of a column.

GetStatementResult, getStatementResultResponse_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:totalNumRows:GetStatementResultResponse', getStatementResultResponse_totalNumRows - The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

$sel:httpStatus:GetStatementResultResponse', getStatementResultResponse_httpStatus - The response's http status code.

$sel:records:GetStatementResultResponse', getStatementResultResponse_records - The results of the SQL statement.

Response Lenses

getStatementResultResponse_columnMetadata :: Lens' GetStatementResultResponse (Maybe [ColumnMetadata]) Source #

The properties (metadata) of a column.

getStatementResultResponse_nextToken :: Lens' GetStatementResultResponse (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.

getStatementResultResponse_totalNumRows :: Lens' GetStatementResultResponse (Maybe Integer) Source #

The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

getStatementResultResponse_httpStatus :: Lens' GetStatementResultResponse Int Source #

The response's http status code.

getStatementResultResponse_records :: Lens' GetStatementResultResponse [[Field]] Source #

The results of the SQL statement.