openapi: 3.0.0 info: version: '2019-12-20' x-release: v4 title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=CancelResize API' description:

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.

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.

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=CancelResize' paths: /#Action=CancelResize: 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: CancelResize operationId: GET_CancelResize description: Cancels a resize operation for a cluster. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResizeProgressMessage' '480': description: ClusterNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterNotFoundFault' '481': description: ResizeNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ResizeNotFoundFault' '482': description: InvalidClusterStateFault content: text/xml: schema: $ref: '#/components/schemas/InvalidClusterStateFault' '483': description: UnsupportedOperationFault content: text/xml: schema: $ref: '#/components/schemas/UnsupportedOperationFault' parameters: - name: ClusterIdentifier in: query required: true description: The unique identifier for the cluster that you want to cancel a resize operation for. schema: type: string maxLength: 2147483647 - name: Action in: query required: true schema: type: string enum: - CancelResize - name: Version in: query required: true schema: type: string enum: - '2012-12-01' summary: Amazon Redshift - G E T_ Cancel Resize x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=CancelResize' post: x-aws-operation-name: CancelResize operationId: POST_CancelResize description: Cancels a resize operation for a cluster. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResizeProgressMessage' '480': description: ClusterNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterNotFoundFault' '481': description: ResizeNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ResizeNotFoundFault' '482': description: InvalidClusterStateFault content: text/xml: schema: $ref: '#/components/schemas/InvalidClusterStateFault' '483': description: UnsupportedOperationFault content: text/xml: schema: $ref: '#/components/schemas/UnsupportedOperationFault' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CancelResizeMessage' parameters: - name: Action in: query required: true schema: type: string enum: - CancelResize - name: Version in: query required: true schema: type: string enum: - '2012-12-01' summary: Amazon Redshift - P O S T_ Cancel Resize x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=CancelResize' 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: ResizeProgressMessage: type: object properties: TargetNodeType: allOf: - $ref: '#/components/schemas/String' - description: The node type that the cluster will have after the resize operation is complete. TargetNumberOfNodes: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: The number of nodes that the cluster will have after the resize operation is complete. TargetClusterType: allOf: - $ref: '#/components/schemas/String' - description: '

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

' Status: allOf: - $ref: '#/components/schemas/String' - description: '

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

' ImportTablesCompleted: allOf: - $ref: '#/components/schemas/ImportTablesCompleted' - description: '

The names of tables that have been completely imported .

Valid Values: List of table names.

' ImportTablesInProgress: allOf: - $ref: '#/components/schemas/ImportTablesInProgress' - description: '

The names of tables that are being currently imported.

Valid Values: List of table names.

' ImportTablesNotStarted: allOf: - $ref: '#/components/schemas/ImportTablesNotStarted' - description: '

The names of tables that have not been yet imported.

Valid Values: List of table names

' AvgResizeRateInMegaBytesPerSecond: allOf: - $ref: '#/components/schemas/DoubleOptional' - description: The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation. TotalResizeDataInMegaBytes: allOf: - $ref: '#/components/schemas/LongOptional' - description: The estimated total amount of data, in megabytes, on the cluster before the resize operation began. ProgressInMegaBytes: allOf: - $ref: '#/components/schemas/LongOptional' - description: While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize). ElapsedTimeInSeconds: allOf: - $ref: '#/components/schemas/LongOptional' - description: The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation. EstimatedTimeToCompletionInSeconds: allOf: - $ref: '#/components/schemas/LongOptional' - description: The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0. ResizeType: allOf: - $ref: '#/components/schemas/String' - description: 'An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed. ' Message: allOf: - $ref: '#/components/schemas/String' - description: An optional string to provide additional details about the resize action. TargetEncryptionType: allOf: - $ref: '#/components/schemas/String' - description:

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None.

DataTransferProgressPercent: allOf: - $ref: '#/components/schemas/DoubleOptional' - description: The percent of data transferred from source cluster to target cluster. description: Describes the result of a cluster resize operation. ImportTablesInProgress: type: array items: $ref: '#/components/schemas/String' String: type: string maxLength: 2147483647 DoubleOptional: type: number format: double ImportTablesCompleted: type: array items: $ref: '#/components/schemas/String' InvalidClusterStateFault: {} ClusterNotFoundFault: {} CancelResizeMessage: type: object required: - ClusterIdentifier title: CancelResizeMessage properties: ClusterIdentifier: allOf: - $ref: '#/components/schemas/String' - description: The unique identifier for the cluster that you want to cancel a resize operation for. IntegerOptional: type: integer UnsupportedOperationFault: {} LongOptional: type: integer ImportTablesNotStarted: type: array items: $ref: '#/components/schemas/String' ResizeNotFoundFault: {} 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