AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . redshift-data ]
Fetches the temporarily cached result of an SQL statement in JSON format. The ExecuteStatement
or BatchExecuteStatement
operation that ran the SQL statement must have specified ResultFormat
as JSON
, or let the format default to JSON. 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 .
See also: AWS API Documentation
get-statement-result
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Records
get-statement-result
--id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--id
(string)
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 byBatchExecuteStatment
,ExecuteStatment
, andListStatements
.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
ColumnMetadata -> (list)
The properties (metadata) of a column.
(structure)
The properties (metadata) of a column.
columnDefault -> (string)
The default value of the column.isCaseSensitive -> (boolean)
A value that indicates whether the column is case-sensitive.isCurrency -> (boolean)
A value that indicates whether the column contains currency values.isSigned -> (boolean)
A value that indicates whether an integer column is signed.label -> (string)
The label for the column.length -> (integer)
The length of the column.name -> (string)
The name of the column.nullable -> (integer)
A value that indicates whether the column is nullable.precision -> (integer)
The precision value of a decimal number column.scale -> (integer)
The scale value of a decimal number column.schemaName -> (string)
The name of the schema that contains the table that includes the column.tableName -> (string)
The name of the table that includes the column.typeName -> (string)
The database-specific data type of the column.
NextToken -> (string)
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.
Records -> (list)
The results of the SQL statement in JSON format.
(list)
(tagged union structure)
A data value in a column.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:blobValue
,booleanValue
,doubleValue
,isNull
,longValue
,stringValue
.blobValue -> (blob)
A value of the BLOB data type.booleanValue -> (boolean)
A value of the Boolean data type.doubleValue -> (double)
A value of the double data type.isNull -> (boolean)
A value that indicates whether the data is NULL.longValue -> (long)
A value of the long data type.stringValue -> (string)
A value of the string data type.
TotalNumRows -> (long)
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 theGetStatementResult
operation needed to page through the results.