AWS Redshift #X Amz Target=RedshiftData.DescribeStatement API

openapi: 3.0.0
info:
  version: '2019-12-20'
  x-release: v4
  title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #X Amz Target=RedshiftData.DescribeStatement API'
  description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: redshift-data
  x-aws-signingName: redshift-data
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://redshift-data.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=RedshiftData.DescribeStatement'
paths:
  /#X-Amz-Target=RedshiftData.DescribeStatement:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeStatement
      description: <p>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. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeStatementResponse'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeStatementRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RedshiftData.DescribeStatement
      summary: Amazon Redshift Data - Describe Statement
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=RedshiftData.DescribeStatement'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    StatusString:
      type: string
      enum:
      - SUBMITTED
      - PICKED
      - STARTED
      - FINISHED
      - ABORTED
      - FAILED
      - ALL
    ParameterName:
      type: string
      pattern: ^[0-9a-zA-Z_]+$
    WorkgroupNameString:
      type: string
      pattern: ^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$
      minLength: 3
      maxLength: 128
    String:
      type: string
    ParameterValue:
      type: string
      minLength: 1
    SubStatementData:
      type: object
      required:
      - Id
      properties:
        CreatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: 'The date and time (UTC) the statement was created. '
        Duration:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: The amount of time in nanoseconds that the statement ran.
        Error:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error message from the cluster if the SQL statement encountered an error while running.
        HasResultSet:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: 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.
        Id:
          allOf:
          - $ref: '#/components/schemas/StatementId'
          - description: 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, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
        QueryString:
          allOf:
          - $ref: '#/components/schemas/StatementString'
          - description: The SQL statement text.
        RedshiftQueryId:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. '
        ResultRows:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 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 <code>-1</code> indicates the value is null.
        ResultSize:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: The size in bytes of the returned results. A <code>-1</code> indicates the value is null.
        Status:
          allOf:
          - $ref: '#/components/schemas/StatementStatusString'
          - description: 'The status of the SQL statement. An example is the that the SQL statement finished. '
        UpdatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time (UTC) that the statement metadata was last updated.
      description: Information about an SQL statement.
    StatementString:
      type: string
    StatementStatusString:
      type: string
      enum:
      - SUBMITTED
      - PICKED
      - STARTED
      - FINISHED
      - ABORTED
      - FAILED
    StatementId:
      type: string
      pattern: ^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\d+)?$
    SubStatementList:
      type: array
      items:
        $ref: '#/components/schemas/SubStatementData'
    SqlParameter:
      type: object
      required:
      - name
      - value
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ParameterName'
          - description: The name of the parameter.
        value:
          allOf:
          - $ref: '#/components/schemas/ParameterValue'
          - description: 'The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the <i>Amazon Redshift Database Developer Guide</i>. '
      description: A parameter used in a SQL statement.
    SecretArn:
      type: string
    ResourceNotFoundException: {}
    SqlParametersList:
      type: array
      items:
        $ref: '#/components/schemas/SqlParameter'
      minItems: 1
    DescribeStatementResponse:
      type: object
      required:
      - Id
      properties:
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The cluster identifier. '
        CreatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: 'The date and time (UTC) when the SQL statement was submitted to run. '
        Database:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The name of the database. '
        DbUser:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The database user name. '
        Duration:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The amount of time in nanoseconds that the statement ran. '
        Error:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The error message from the cluster if the SQL statement encountered an error while running. '
        HasResultSet:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: 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. The value is true if any substatement returns a result set.
        Id:
          allOf:
          - $ref: '#/components/schemas/StatementId'
          - description: 'The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. '
        QueryParameters:
          allOf:
          - $ref: '#/components/schemas/SqlParametersList'
          - description: The parameters for the SQL statement.
        QueryString:
          allOf:
          - $ref: '#/components/schemas/StatementString'
          - description: 'The SQL statement text. '
        RedshiftPid:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The process identifier from Amazon Redshift. '
        RedshiftQueryId:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The identifier of the query generated by Amazon Redshift. These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. '
        ResultRows:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 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 <code>-1</code> indicates the value is null.
        ResultSize:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: The size in bytes of the returned results. A <code>-1</code> indicates the value is null.
        SecretArn:
          allOf:
          - $ref: '#/components/schemas/SecretArn'
          - description: 'The name or Amazon Resource Name (ARN) of the secret that enables access to the database. '
        Status:
          allOf:
          - $ref: '#/components/schemas/StatusString'
          - description: '<p>The status of the SQL statement being described. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>'
        SubStatements:
          allOf:
          - $ref: '#/components/schemas/SubStatementList'
          - description: The SQL statements from a multiple statement run.
        UpdatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: 'The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed. '
        WorkgroupName:
          allOf:
          - $ref: '#/components/schemas/WorkgroupNameString'
          - description: The serverless workgroup name or Amazon Resource Name (ARN).
    Boolean:
      type: boolean
    ValidationException: {}
    Long:
      type: integer
    Timestamp:
      type: string
      format: date-time
    DescribeStatementRequest:
      type: object
      required:
      - Id
      title: DescribeStatementRequest
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/StatementId'
          - description: '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, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. '
    InternalServerException: {}
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/redshift-data/
x-hasEquivalentPaths: true