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

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.

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' {
- totalNumRows :: Maybe Integer
- nextToken :: Maybe Text
- columnMetadata :: Maybe [ColumnMetadata]
- httpStatus :: Int
- records :: [[Field]]
}
newGetStatementResultResponse :: Int -> GetStatementResultResponse
getStatementResultResponse_totalNumRows :: Lens' GetStatementResultResponse (Maybe Integer)
getStatementResultResponse_nextToken :: Lens' GetStatementResultResponse (Maybe Text)
getStatementResultResponse_columnMetadata :: Lens' GetStatementResultResponse (Maybe [ColumnMetadata])
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

Eq GetStatementResult Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult Methods (==) :: GetStatementResult -> GetStatementResult -> Bool # (/=) :: GetStatementResult -> GetStatementResult -> Bool #
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 #
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 #
NFData GetStatementResult Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult Methods rnf :: GetStatementResult -> () #
Hashable GetStatementResult Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult Methods hashWithSalt :: Int -> GetStatementResult -> Int # hash :: GetStatementResult -> Int #
ToJSON GetStatementResult Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult Methods toJSON :: GetStatementResult -> Value # toEncoding :: GetStatementResult -> Encoding # toJSONList :: [GetStatementResult] -> Value # toEncodingList :: [GetStatementResult] -> Encoding #
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 :: GetStatementResult -> Request GetStatementResult # response :: MonadResource m => Logger -> Service -> Proxy GetStatementResult -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStatementResult))) #
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 #
type Rep GetStatementResult Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult type Rep GetStatementResult = D1 ('MetaData "GetStatementResult" "Amazonka.RedshiftData.GetStatementResult" "libZSservicesZSamazonka-redshift-dataZSamazonka-redshift-data" '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)))
type AWSResponse GetStatementResult Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult type AWSResponse GetStatementResult = GetStatementResultResponse

newGetStatementResult Source #

Arguments

:: Text	`$sel:id: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:

$sel:nextToken: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.

$sel:id: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

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.
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.
columnMetadata :: Maybe [ColumnMetadata]
The properties (metadata) of a column.
httpStatus :: Int
The response's http status code.
records :: [[Field]]
The results of the SQL statement.

Instances

Instances details

Eq GetStatementResultResponse Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult Methods (==) :: GetStatementResultResponse -> GetStatementResultResponse -> Bool # (/=) :: GetStatementResultResponse -> GetStatementResultResponse -> Bool #
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 #
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 #
NFData GetStatementResultResponse Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult Methods rnf :: GetStatementResultResponse -> () #
type Rep GetStatementResultResponse Source #
Instance details Defined in Amazonka.RedshiftData.GetStatementResult type Rep GetStatementResultResponse = D1 ('MetaData "GetStatementResultResponse" "Amazonka.RedshiftData.GetStatementResult" "libZSservicesZSamazonka-redshift-dataZSamazonka-redshift-data" 'False) (C1 ('MetaCons "GetStatementResultResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "totalNumRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "columnMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ColumnMetadata])) :: (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: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:nextToken: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:columnMetadata:GetStatementResultResponse', getStatementResultResponse_columnMetadata - The properties (metadata) of a column.

$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_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_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_columnMetadata :: Lens' GetStatementResultResponse (Maybe [ColumnMetadata]) Source #

The properties (metadata) of a column.

getStatementResultResponse_httpStatus :: Lens' GetStatementResultResponse Int Source #

The response's http status code.

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

The results of the SQL statement.