SubStatementData
Information about an SQL statement.
Contents
Note
In the following list, the required parameters are described first.
- Id
-
The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example,
d9b6c0c9-0747-4bf4-b142-e8883122f766:2has a suffix of:2that indicates the second SQL statement of a batch query.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
- Duration
-
The amount of time in nanoseconds that the statement ran.
Type: Long
Required: No
- Error
-
The error message from the cluster if the SQL statement encountered an error while running.
Type: String
Required: No
- HasResultSet
-
A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
Type: Boolean
Required: No
- QueryString
-
The SQL statement text.
Type: String
Required: No
- RedshiftQueryId
-
The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Type: Long
Required: No
- ResultRows
-
Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A
-1indicates the value is null.Type: Long
Required: No
- ResultSize
-
The size in bytes of the returned results. A
-1indicates the value is null.Type: Long
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 | FAILEDRequired: 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 AWS SDKs, see the following:
