StatementData - Amazon Redshift Data API
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

StatementData

The SQL statement to run.

Contents

Note

In the following list, the required parameters are described first.

Id

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

Type: String

Pattern: ^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$

Required: Yes

CreatedAt

The date and time (UTC) the statement was created.

Type: Timestamp

Required: No

IsBatchStatement

A value that indicates whether the statement is a batch query request.

Type: Boolean

Required: No

QueryParameters

The parameters used in a SQL statement.

Type: Array of SqlParameter objects

Array Members: Minimum number of 1 item.

Required: No

QueryString

The SQL statement.

Type: String

Required: No

QueryStrings

One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

Type: Array of strings

Required: No

ResultFormat

The data format of the result of the SQL statement.

Type: String

Valid Values: JSON | CSV

Required: No

SecretArn

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

Type: String

Required: No

SessionId

The session identifier of the query.

Type: String

Pattern: ^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$

Required: No

StatementName

The name of the SQL statement.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

Status

The status of the SQL statement. An example is the that the SQL statement finished.

Type: String

Valid Values: SUBMITTED | PICKED | STARTED | FINISHED | ABORTED | FAILED | ALL

Required: No

UpdatedAt

The date and time (UTC) that the statement metadata was last updated.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: