Describe Statement

redshiftdataapiservice_describe_statement

R Documentation

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API¶

Description¶

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

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.

Usage¶

redshiftdataapiservice_describe_statement(Id)

Arguments¶

Id: [required] The identifier of the SQL statement to describe. 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:2⁠ has a suffix of ⁠:2⁠ that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, execute_statement, and list_statements.

Value¶

A list with the following syntax:

list(
  ClusterIdentifier = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Database = "string",
  DbUser = "string",
  Duration = 123,
  Error = "string",
  HasResultSet = TRUE|FALSE,
  Id = "string",
  QueryParameters = list(
    list(
      name = "string",
      value = "string"
    )
  ),
  QueryString = "string",
  RedshiftPid = 123,
  RedshiftQueryId = 123,
  ResultRows = 123,
  ResultSize = 123,
  SecretArn = "string",
  SessionId = "string",
  Status = "SUBMITTED"|"PICKED"|"STARTED"|"FINISHED"|"ABORTED"|"FAILED"|"ALL",
  SubStatements = list(
    list(
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Duration = 123,
      Error = "string",
      HasResultSet = TRUE|FALSE,
      Id = "string",
      QueryString = "string",
      RedshiftQueryId = 123,
      ResultRows = 123,
      ResultSize = 123,
      Status = "SUBMITTED"|"PICKED"|"STARTED"|"FINISHED"|"ABORTED"|"FAILED",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  WorkgroupName = "string"
)

Request syntax¶

svc$describe_statement(
  Id = "string"
)