AWS Redshift #Action=BatchDeleteClusterSnapshots API
The #Action=BatchDeleteClusterSnapshots API from AWS Redshift — 1 operation(s) for #action=batchdeleteclustersnapshots.
The #Action=BatchDeleteClusterSnapshots API from AWS Redshift — 1 operation(s) for #action=batchdeleteclustersnapshots.
openapi: 3.0.0
info:
version: '2019-12-20'
x-release: v4
title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=BatchDeleteClusterSnapshots 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=BatchDeleteClusterSnapshots'
paths:
/#Action=BatchDeleteClusterSnapshots:
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: BatchDeleteClusterSnapshots
operationId: GET_BatchDeleteClusterSnapshots
description: Deletes a set of cluster snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteClusterSnapshotsResult'
'480':
description: BatchDeleteRequestSizeExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteRequestSizeExceededFault'
parameters:
- name: Identifiers
in: query
required: true
description: A list of identifiers for the snapshots that you want to delete.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/DeleteClusterSnapshotMessage'
- xml:
name: DeleteClusterSnapshotMessage
- name: Action
in: query
required: true
schema:
type: string
enum:
- BatchDeleteClusterSnapshots
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - G E T_ Batch Delete Cluster Snapshots
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=BatchDeleteClusterSnapshots'
post:
x-aws-operation-name: BatchDeleteClusterSnapshots
operationId: POST_BatchDeleteClusterSnapshots
description: Deletes a set of cluster snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteClusterSnapshotsResult'
'480':
description: BatchDeleteRequestSizeExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteRequestSizeExceededFault'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteClusterSnapshotsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- BatchDeleteClusterSnapshots
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - P O S T_ Batch Delete Cluster Snapshots
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=BatchDeleteClusterSnapshots'
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
schemas:
DeleteClusterSnapshotMessageList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DeleteClusterSnapshotMessage'
- xml:
name: DeleteClusterSnapshotMessage
BatchSnapshotOperationErrorList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotErrorMessage'
- xml:
name: SnapshotErrorMessage
SnapshotIdentifierList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: String
BatchDeleteClusterSnapshotsResult:
type: object
properties:
Resources:
allOf:
- $ref: '#/components/schemas/SnapshotIdentifierList'
- description: 'A list of the snapshot identifiers that were deleted. '
Errors:
allOf:
- $ref: '#/components/schemas/BatchSnapshotOperationErrorList'
- description: A list of any errors returned.
BatchDeleteClusterSnapshotsRequest:
type: object
required:
- Identifiers
title: BatchDeleteClusterSnapshotsRequest
properties:
Identifiers:
allOf:
- $ref: '#/components/schemas/DeleteClusterSnapshotMessageList'
- description: A list of identifiers for the snapshots that you want to delete.
DeleteClusterSnapshotMessage:
type: object
required:
- SnapshotIdentifier
title: DeleteClusterSnapshotMessage
properties:
SnapshotIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The unique identifier of the manual snapshot to be deleted.</p> <p>Constraints: Must be the name of an existing snapshot that is in the <code>available</code>, <code>failed</code>, or <code>cancelled</code> state.</p>'
SnapshotClusterIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.</p> <p>Constraints: Must be the name of valid cluster.</p>'
description: <p/>
SnapshotErrorMessage:
type: object
properties:
SnapshotIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: A unique identifier for the snapshot returning the error.
SnapshotClusterIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: A unique identifier for the cluster.
FailureCode:
allOf:
- $ref: '#/components/schemas/String'
- description: The failure code for the error.
FailureReason:
allOf:
- $ref: '#/components/schemas/String'
- description: The text message describing the error.
description: Describes the errors returned by a snapshot.
BatchDeleteRequestSizeExceededFault: {}
String:
type: string
maxLength: 2147483647
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