openapi: 3.0.0
info:
  version: '2019-12-20'
  x-release: v4
  title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=DescribeClusters 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: '#Action=DescribeClusters'
paths:
  /#Action=DescribeClusters:
    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'
    get:
      x-aws-operation-name: DescribeClusters
      operationId: GET_DescribeClusters
      description: <p>Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned.</p> <p>If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.</p>
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ClustersMessage'
        '480':
          description: ClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '481':
          description: InvalidTagFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTagFault'
      parameters:
      - name: ClusterIdentifier
        in: query
        required: false
        description: <p>The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.</p> <p>The default is that all clusters defined for an account are returned.</p>
        schema:
          type: string
          maxLength: 2147483647
      - name: MaxRecords
        in: query
        required: false
        description: '<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>'
        schema:
          type: integer
      - name: Marker
        in: query
        required: false
        description: '<p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusters</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p> <p>Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. </p>'
        schema:
          type: string
          maxLength: 2147483647
      - name: TagKeys
        in: query
        required: false
        description: A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        schema:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/String'
            - xml:
                name: TagKey
      - name: TagValues
        in: query
        required: false
        description: A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
        schema:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/String'
            - xml:
                name: TagValue
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeClusters
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - '2012-12-01'
      summary: Amazon Redshift - G E T_ Describe Clusters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=DescribeClusters'
    post:
      x-aws-operation-name: DescribeClusters
      operationId: POST_DescribeClusters
      description: <p>Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned.</p> <p>If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.</p>
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ClustersMessage'
        '480':
          description: ClusterNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ClusterNotFoundFault'
        '481':
          description: InvalidTagFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTagFault'
      requestBody:
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/DescribeClustersMessage'
      parameters:
      - name: MaxRecords
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: Marker
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeClusters
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - '2012-12-01'
      summary: Amazon Redshift - P O S T_ Describe Clusters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=DescribeClusters'
components:
  schemas:
    ScheduleState:
      type: string
      enum:
      - MODIFYING
      - ACTIVE
      - FAILED
    NetworkInterface:
      type: object
      properties:
        NetworkInterfaceId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The network interface identifier. '
        SubnetId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The subnet identifier. '
        PrivateIpAddress:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The IPv4 address of the network interface within the subnet. '
        AvailabilityZone:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The Availability Zone. '
      description: 'Describes a network interface. '
    PendingActionsList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    ClustersMessage:
      type: object
      properties:
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '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 marker value in the <code>Marker</code> parameter and retrying the command. If the <code>Marker</code> field is empty, all response records have been retrieved for the request. '
        Clusters:
          allOf:
          - $ref: '#/components/schemas/ClusterList'
          - description: 'A list of <code>Cluster</code> objects, where each object describes one cluster. '
      description: 'Contains the output from the <a>DescribeClusters</a> action. '
    ClusterParameterStatus:
      type: object
      properties:
        ParameterName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the parameter.
        ParameterApplyStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.</p> <p>The following are possible statuses and descriptions.</p> <ul> <li> <p> <code>in-sync</code>: The parameter value is in sync with the database.</p> </li> <li> <p> <code>pending-reboot</code>: The parameter value will be applied after the cluster reboots.</p> </li> <li> <p> <code>applying</code>: The parameter value is being applied to the database.</p> </li> <li> <p> <code>invalid-parameter</code>: Cannot apply the parameter value because it has an invalid value or syntax.</p> </li> <li> <p> <code>apply-deferred</code>: The parameter contains static property changes. The changes are deferred until the cluster reboots.</p> </li> <li> <p> <code>apply-error</code>: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.</p> </li> <li> <p> <code>unknown-error</code>: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.</p> </li> </ul>'
        ParameterApplyErrorDescription:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error that prevented the parameter from being applied to the database.
      description: Describes the status of a parameter group.
    BooleanOptional:
      type: boolean
    TagValueList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/String'
        - xml:
            name: TagValue
    Double:
      type: number
      format: double
    ReservedNodeExchangeStatusType:
      type: string
      enum:
      - REQUESTED
      - PENDING
      - IN_PROGRESS
      - RETRYING
      - SUCCEEDED
      - FAILED
    InvalidTagFault: {}
    VpcEndpointsList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/VpcEndpoint'
        - xml:
            name: VpcEndpoint
    TStamp:
      type: string
      format: date-time
    Tag:
      type: object
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The key, or name, for the resource tag.
        Value:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The value for the resource tag.
      description: A tag consisting of a name/value pair for a resource.
    Integer:
      type: integer
    ClusterSecurityGroupMembershipList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/ClusterSecurityGroupMembership'
        - xml:
            name: ClusterSecurityGroup
    AquaConfiguration:
      type: object
      properties:
        AquaStatus:
          allOf:
          - $ref: '#/components/schemas/AquaStatus'
          - description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
        AquaConfigurationStatus:
          allOf:
          - $ref: '#/components/schemas/AquaConfigurationStatus'
          - description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
      description: The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
    String:
      type: string
      maxLength: 2147483647
    TagList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/Tag'
        - xml:
            name: Tag
    DeferredMaintenanceWindowsList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/DeferredMaintenanceWindow'
        - xml:
            name: DeferredMaintenanceWindow
    HsmStatus:
      type: object
      properties:
        HsmClientCertificateIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
        HsmConfigurationIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.</p> <p>Values: active, applying</p>'
      description: Describes the status of changes to HSM settings.
    AquaConfigurationStatus:
      type: string
      enum:
      - enabled
      - disabled
      - auto
    ReservedNodeExchangeStatus:
      type: object
      properties:
        ReservedNodeExchangeRequestId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the reserved-node exchange request.
        Status:
          allOf:
          - $ref: '#/components/schemas/ReservedNodeExchangeStatusType'
          - description: The status of the reserved-node exchange request. Statuses include in-progress and requested.
        RequestTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: A date and time that indicate when the reserved-node exchange was requested.
        SourceReservedNodeId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the source reserved node.
        SourceReservedNodeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The source reserved-node type, for example ds2.xlarge.
        SourceReservedNodeCount:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The source reserved-node count in the cluster.
        TargetReservedNodeOfferingId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the target reserved node offering.
        TargetReservedNodeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The node type of the target reserved node, for example ra3.4xlarge.
        TargetReservedNodeCount:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The count of target reserved nodes in the cluster.
      description: Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details.
    ClusterParameterGroupStatus:
      type: object
      properties:
        ParameterGroupName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the cluster parameter group.
        ParameterApplyStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of parameter updates.
        ClusterParameterStatusList:
          allOf:
          - $ref: '#/components/schemas/ClusterParameterStatusList'
          - description: <p>The list of parameter statuses.</p> <p> For more information about parameters and parameter groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
      description: Describes the status of a parameter group.
    DoubleOptional:
      type: number
      format: double
    ClusterSecurityGroupMembership:
      type: object
      properties:
        ClusterSecurityGroupName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the cluster security group.
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the cluster security group.
      description: Describes a cluster security group.
    ResizeInfo:
      type: object
      properties:
        ResizeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Returns the value <code>ClassicResize</code>.
        AllowCancelResize:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: A boolean value indicating if the resize operation can be cancelled.
      description: Describes a resize operation.
    AquaStatus:
      type: string
      enum:
      - enabled
      - disabled
      - applying
    Endpoint:
      type: object
      properties:
        Address:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The DNS address of the Cluster.
        Port:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The port that the database engine is listening on.
        VpcEndpoints:
          allOf:
          - $ref: '#/components/schemas/VpcEndpointsList'
          - description: Describes a connection endpoint.
      description: Describes a connection endpoint.
    RestoreStatus:
      type: object
      properties:
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the restore action. Returns starting, restoring, completed, or failed.
        CurrentRestoreRateInMegaBytesPerSecond:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: 'The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types. '
        SnapshotSizeInMegaBytes:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types. '
        ProgressInMegaBytes:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types. '
        ElapsedTimeInSeconds:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types. '
        EstimatedTimeToCompletionInSeconds:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: 'The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types. '
      description: Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
    ClusterList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/Cluster'
        - xml:
            name: Cluster
    ClusterParameterGroupStatusList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/ClusterParameterGroupStatus'
        - xml:
            name: ClusterParameterGroup
    Cluster:
      type: object
      properties:
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The unique identifier of the cluster.
        NodeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The node type for the nodes in the cluster.
        ClusterStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p> The current state of the cluster. Possible values are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>available, prep-for-resize</code> </p> </li> <li> <p> <code>available, resize-cleanup</code> </p> </li> <li> <p> <code>cancelling-resize</code> </p> </li> <li> <p> <code>creating</code> </p> </li> <li> <p> <code>deleting</code> </p> </li> <li> <p> <code>final-snapshot</code> </p> </li> <li> <p> <code>hardware-failure</code> </p> </li> <li> <p> <code>incompatible-hsm</code> </p> </li> <li> <p> <code>incompatible-network</code> </p> </li> <li> <p> <code>incompatible-parameters</code> </p> </li> <li> <p> <code>incompatible-restore</code> </p> </li> <li> <p> <code>modifying</code> </p> </li> <li> <p> <code>paused</code> </p> </li> <li> <p> <code>rebooting</code> </p> </li> <li> <p> <code>renaming</code> </p> </li> <li> <p> <code>resizing</code> </p> </li> <li> <p> <code>rotating-keys</code> </p> </li> <li> <p> <code>storage-full</code> </p> </li> <li> <p> <code>updating-hsm</code> </p> </li> </ul>
        ClusterAvailabilityStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The availability status of the cluster for queries. Possible values are the following:</p> <ul> <li> <p>Available - The cluster is available for queries. </p> </li> <li> <p>Unavailable - The cluster is not available for queries.</p> </li> <li> <p>Maintenance - The cluster is intermittently available for queries due to maintenance activities.</p> </li> <li> <p>Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.</p> </li> <li> <p>Failed - The cluster failed and is not available for queries.</p> </li> </ul>
        ModifyStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of a modify operation, if any, initiated for the cluster.
        MasterUsername:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The admin user name for the cluster. This name is used to connect to the database that is specified in the <b>DBName</b> parameter. '
        DBName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named <code>dev</code>dev was created by default. '
        Endpoint:
          allOf:
          - $ref: '#/components/schemas/Endpoint'
          - description: The connection endpoint.
        ClusterCreateTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: The date and time that the cluster was created.
        AutomatedSnapshotRetentionPeriod:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The number of days that automatic cluster snapshots are retained.
        ManualSnapshotRetentionPeriod:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: <p>The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p>
        ClusterSecurityGroups:
          allOf:
          - $ref: '#/components/schemas/ClusterSecurityGroupMembershipList'
          - description: <p>A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains <code>ClusterSecurityGroup.Name</code> and <code>ClusterSecurityGroup.Status</code> subelements. </p> <p>Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the <b>VpcSecurityGroups</b> parameter. </p>
        VpcSecurityGroups:
          allOf:
          - $ref: '#/components/schemas/VpcSecurityGroupMembershipList'
          - description: A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
        ClusterParameterGroups:
          allOf:
          - $ref: '#/components/schemas/ClusterParameterGroupStatusList'
          - description: The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
        ClusterSubnetGroupName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
        VpcId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the VPC the cluster is in, if the cluster is in a VPC.
        AvailabilityZone:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the Availability Zone in which the cluster is located.
        PreferredMaintenanceWindow:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
        PendingModifiedValues:
          allOf:
          - $ref: '#/components/schemas/PendingModifiedValues'
          - description: A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
        ClusterVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The version ID of the Amazon Redshift engine that is running on the cluster.
        AllowVersionUpgrade:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: 'A boolean value that, if <code>true</code>, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. '
        NumberOfNodes:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The number of compute nodes in the cluster.
        PubliclyAccessible:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: A boolean value that, if <code>true</code>, indicates that the cluster can be accessed from a public network.
        Encrypted:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: A boolean value that, if <code>true</code>, indicates that data in the cluster is encrypted at rest.
        RestoreStatus:
          allOf:
          - $ref: '#/components/schemas/RestoreStatus'
          - description: A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
        DataTransferProgress:
          allOf:
          - $ref: '#/components/schemas/DataTransferProgress'
          - description: <p/>
        HsmStatus:
          allOf:
          - $ref: '#/components/schemas/HsmStatus'
          - description: '<p>A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.</p> <p>Values: active, applying</p>'
        ClusterSnapshotCopyStatus:
          allOf:
          - $ref: '#/components/schemas/ClusterSnapshotCopyStatus'
          - description: A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
        ClusterPublicKey:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The public key for the cluster.
        ClusterNodes:
          allOf:
          - $ref: '#/components/schemas/ClusterNodesList'
          - description: The nodes in the cluster.
        ElasticIpStatus:
          allOf:
          - $ref: '#/components/schemas/ElasticIpStatus'
          - description: The status of the elastic IP (EIP) address.
        ClusterRevisionNumber:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The specific revision number of the database in the cluster.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The list of tags for the cluster.
        KmsKeyId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
        EnhancedVpcRouting:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: '<p>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>'
        IamRoles:
          allOf:
          - $ref: '#/components/schemas/ClusterIamRoleList'
          - description: A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
        PendingActions:
          allOf:
          - $ref: '#/components/schemas/PendingActionsList'
          - description: Cluster operations that are waiting to be started.
        MaintenanceTrackName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the maintenance track for the cluster.
        ElasticResizeNumberOfNodeOptions:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The number of nodes that you can resize the cluster to with the elastic resize method. '
        DeferredMaintenanceWindows:
          allOf:
          - $ref: '#/components/schemas/DeferredMaintenanceWindowsList'
          - description: Describes a group of <code>DeferredMaintenanceWindow</code> objects.
        SnapshotScheduleIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A unique identifier for the cluster snapshot schedule.
        SnapshotScheduleState:
          allOf:
          - $ref: '#/components/schemas/ScheduleState'
          - description: The current state of the cluster snapshot schedule.
        ExpectedNextSnapshotScheduleTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: 'The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. '
        ExpectedNextSnapshotScheduleTimeStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p> <ul> <li> <p>OnTrack - The next snapshot is expected to be taken on time. </p> </li> <li> <p>Pending - The next snapshot is pending to be taken. </p> </li> </ul>
        NextMaintenanceWindowStartTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: The date and time in UTC when system maintenance can begin.
        ResizeInfo:
          allOf:
          - $ref: '#/components/schemas/ResizeInfo'
          - description: '<p>Returns the following:</p> <ul> <li> <p>AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.</p> </li> <li> <p>ResizeType: Returns ClassicResize</p> </li> </ul>'
        AvailabilityZoneRelocationStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Describes the status of the Availability Zone relocation operation.
        ClusterNamespaceArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The namespace Amazon Resource Name (ARN) of the cluster.
        TotalStorageCapacityInMegaBytes:
          allOf:
          - $ref: '#/components/schemas/LongOptional'
          - description: 'The total storage capacity of the cluster in megabytes. '
        AquaConfiguration:
          allOf:
          - $ref: '#/components/schemas/AquaConfiguration'
          - description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
        DefaultIamRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
        ReservedNodeExchangeStatus:
          allOf:
          - $ref: '#/components/schemas/ReservedNodeExchangeStatus'
          - description: The status of the reserved-node exchange request. Statuses include in-progress and requested.
      description: Describes a cluster.
    NetworkInterfaceList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/NetworkInterface'
        - xml:
            name: NetworkInterface
    DescribeClustersMessage:
      type: object
      title: DescribeClustersMessage
      properties:
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.</p> <p>The default is that all clusters defined for an account are returned.</p>
        MaxRecords:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: '<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>'
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusters</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p> <p>Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. </p>'
        TagKeys:
          allOf:
          - $ref: '#/components/schemas/TagKeyList'
          - description: A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
        TagValues:
          allOf:
          - $ref: '#/components/schemas/TagValueList'
          - description: A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
      description: <p/>
    ClusterIamRoleList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/ClusterIamRole'
        - xml:
            name: ClusterIamRole
    ClusterIamRole:
      type: object
      properties:
        IamRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The Amazon Resource Name (ARN) of the IAM role, for example, <code>arn:aws:iam::123456789012:role/RedshiftCopyUnload</code>. '
        ApplyStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>A value that describes the status of the IAM role''s association with an Amazon Redshift cluster.</p> <p>The following are possible statuses and descriptions.</p> <ul> <li> <p> <code>in-sync</code>: The role is available for use by the cluster.</p> </li> <li> <p> <code>adding</code>: The role is in the process of being associated with the cluster.</p> </li> <li> <p> <code>removing</code>: The role is in the process of being disassociated with the cluster.</p> </li> </ul>'
      description: An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
    VpcEndpoint:
      type: object
      properties:
        VpcEndpointId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
        VpcId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The VPC identifier that the endpoint is associated. '
        NetworkInterfaces:
          allOf:
          - $ref: '#/components/schemas/NetworkInterfaceList'
          - description: 'One or more network interfaces of the endpoint. Also known as an interface endpoint. '
      description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
    ClusterSnapshotCopyStatus:
      type: object
      properties:
        DestinationRegion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
        RetentionPeriod:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
        ManualSnapshotRetentionPeriod:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: <p>The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely. </p> <p>The value must be either -1 or an integer between 1 and 3,653.</p>
        SnapshotCopyGrantName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the snapshot copy grant.
      description: Returns the destination region and retention period that are configured for cross-region snapshot copy.
    ClusterNodesList:
      type: array
      items:
        $ref: '#/components/schemas/ClusterNode'
    ClusterNode:
      type: object
      properties:
        NodeRole:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Whether the node is a leader node or a compute node.
        PrivateIPAddress:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The private IP address of a node within a cluster.
        PublicIPAddress:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The public IP address of a node within a cluster.
      description: The identifier of a node in a cluster.
    Boolean:
      type: boolean
    VpcSecurityGroupMembership:
      type: object
      properties:
        VpcSecurityGroupId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the VPC security group.
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the VPC security group.
      description: Describes the members of a VPC security group.
    PendingModifiedValues:
      type: object
      properties:
        MasterUserPassword:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pending or in-progress change of the admin user password for the cluster.
        NodeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pending or in-progress change of the cluster's node type.
        NumberOfNodes:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: The pending or in-progress change of the number of nodes in the cluster.
        ClusterType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pending or in-progress change of the cluster type.
        ClusterVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pending or in-progress change of the service version.
        AutomatedSnapshotRetentionPeriod:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: The pending or in-progress change of the automated snapshot retention period.
        ClusterIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The pending or in-progress change of the new identifier for the cluster.
        PubliclyAccessible:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: The pending or in-progress change of the ability to connect to the cluster from the public network.
        EnhancedVpcRouting:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: '<p>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>'
        MaintenanceTrackName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the maintenance track that the cluster will change to during the next maintenance window.
        EncryptionType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The encryption type for a cluster. Possible values are: KMS and None. '
      description: Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.
    IntegerOptional:
      type: integer
    ElasticIpStatus:
      type: object
      properties:
        ElasticIp:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The elastic IP (EIP) address for the cluster.
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the elastic IP (EIP) address.
      description: Describes the status of the elastic IP (EIP) address.
    VpcSecurityGroupMembershipList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/VpcSecurityGroupMembership'
        - xml:
            name: VpcSecurityGroup
    ClusterParameterStatusList:
      type: array
      items:
        $ref: '#/components/schemas/ClusterParameterStatus'
    Long:
      type: integer
    LongOptional:
      type: integer
    DeferredMaintenanceWindow:
      type: object
      properties:
        DeferMaintenanceIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A unique identifier for the maintenance window.
        DeferMaintenanceStartTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: ' A timestamp for the beginning of the time period when we defer maintenance.'
        DeferMaintenanceEndTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: ' A timestamp for the end of the time period when we defer maintenance.'
      description: Describes a deferred maintenance window
    TagKeyList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/String'
        - xml:
            name: TagKey
    ClusterNotFoundFault: {}
    DataTransferProgress:
      type: object
      properties:
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Describes the status of the cluster. While the transfer is in progress the status is <code>transferringdata</code>.
        CurrentRateInMegaBytesPerSecond:
          allOf:
          - $ref: '#/components/schemas/DoubleOptional'
          - description: Describes the data transfer rate in MB's per second.
        TotalDataInMegaBytes:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: Describes the total amount of data to be transfered in megabytes.
        DataTransferredInMegaBytes:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: Describes the total amount of data that has been transfered in MB's.
        EstimatedTimeToCompletionInSeconds:
          allOf:
          - $ref: '#/components/schemas/LongOptional'
          - description: Describes the estimated number of seconds remaining to complete the transfer.
        ElapsedTimeInSeconds:
          allOf:
          - $ref: '#/components/schemas/LongOptional'
          - description: Describes the number of seconds that have elapsed during the data transfer.
      description: Describes the status of a cluster while it is in the process of resizing with an incremental resize.
  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
  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