Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-redshift:amazon-redshift-cluster-snapshot-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon Redshift Cluster Snapshot API
version: '2012-12-01'
description: Generated from AWS's published Smithy model for Amazon Redshift. 6 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://redshift.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/?Action=BatchDeleteClusterSnapshots:
post:
operationId: BatchDeleteClusterSnapshots
summary: Batch Delete Cluster Snapshots
description: Deletes a set of cluster snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteClusterSnapshotsResult'
'400':
description: BatchDeleteRequestSizeExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchDeleteRequestSizeExceededFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: BatchDeleteClusterSnapshots
Version:
type: string
const: '2012-12-01'
- $ref: '#/components/schemas/BatchDeleteClusterSnapshotsRequest'
tags:
- Cluster Snapshot
/?Action=BatchModifyClusterSnapshots:
post:
operationId: BatchModifyClusterSnapshots
summary: Batch Modify Cluster Snapshots
description: Modifies the settings for a set of cluster snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchModifyClusterSnapshotsOutputMessage'
'400':
description: BatchModifyClusterSnapshotsLimitExceededFault; InvalidRetentionPeriodFault
content:
text/xml:
schema:
$ref: '#/components/schemas/BatchModifyClusterSnapshotsLimitExceededFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: BatchModifyClusterSnapshots
Version:
type: string
const: '2012-12-01'
- $ref: '#/components/schemas/BatchModifyClusterSnapshotsMessage'
tags:
- Cluster Snapshot
/?Action=CreateClusterSnapshot:
post:
operationId: CreateClusterSnapshot
summary: Create Cluster Snapshot
description: Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more
information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management
Guide.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateClusterSnapshotResult'
'404':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'400':
description: ClusterSnapshotAlreadyExistsFault; ClusterSnapshotQuotaExceededFault; InvalidClusterStateFault; InvalidRetentionPeriodFault;
InvalidTagFault; TagLimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotAlreadyExistsFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateClusterSnapshot
Version:
type: string
const: '2012-12-01'
- $ref: '#/components/schemas/CreateClusterSnapshotMessage'
tags:
- Cluster Snapshot
/?Action=DeleteClusterSnapshot:
post:
operationId: DeleteClusterSnapshot
summary: Delete Cluster Snapshot
description: Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users
authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete
your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to
avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations
before you can delete the snapshot.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClusterSnapshotResult'
'404':
description: ClusterSnapshotNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotNotFoundFault'
'400':
description: InvalidClusterSnapshotStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterSnapshotStateFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteClusterSnapshot
Version:
type: string
const: '2012-12-01'
- $ref: '#/components/schemas/DeleteClusterSnapshotMessage'
tags:
- Cluster Snapshot
/?Action=DescribeClusterSnapshots:
post:
operationId: DescribeClusterSnapshots
summary: Describe Cluster Snapshots
description: Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default,
this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services
account. No information is returned for snapshots owned by inactive Amazon Web Services accounts. If you specify both
tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the
specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag
values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned
in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag
keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values
associated with them.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/SnapshotMessage'
'404':
description: ClusterNotFoundFault; ClusterSnapshotNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'400':
description: InvalidTagFault; UnsupportedOperationFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidTagFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeClusterSnapshots
Version:
type: string
const: '2012-12-01'
- $ref: '#/components/schemas/DescribeClusterSnapshotsMessage'
tags:
- Cluster Snapshot
/?Action=ModifyClusterSnapshot:
post:
operationId: ModifyClusterSnapshot
summary: Modify Cluster Snapshot
description: Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a
cluster snapshot.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyClusterSnapshotResult'
'404':
description: ClusterSnapshotNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotNotFoundFault'
'400':
description: InvalidClusterSnapshotStateFault; InvalidRetentionPeriodFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterSnapshotStateFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyClusterSnapshot
Version:
type: string
const: '2012-12-01'
- $ref: '#/components/schemas/ModifyClusterSnapshotMessage'
tags:
- Cluster Snapshot
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: redshift
schemas:
AccountWithRestoreAccess:
type: object
properties:
AccountId:
type: string
description: The identifier of an Amazon Web Services account authorized to restore a snapshot.
AccountAlias:
type: string
description: The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon
Web Services Support, the identifier is amazon-redshift-support.
BatchDeleteClusterSnapshotsRequest:
type: object
properties:
Identifiers:
type: array
items:
$ref: '#/components/schemas/DeleteClusterSnapshotMessage'
description: A list of identifiers for the snapshots that you want to delete.
required:
- Identifiers
BatchDeleteClusterSnapshotsResult:
type: object
properties:
Resources:
type: array
items:
type: string
description: A list of the snapshot identifiers that were deleted.
Errors:
type: array
items:
$ref: '#/components/schemas/SnapshotErrorMessage'
description: A list of any errors returned.
BatchDeleteRequestSizeExceededFault:
type: object
properties:
message:
type: string
BatchModifyClusterSnapshotsLimitExceededFault:
type: object
properties:
message:
type: string
BatchModifyClusterSnapshotsMessage:
type: object
properties:
SnapshotIdentifierList:
type: array
items:
type: string
description: A list of snapshot identifiers you want to modify.
ManualSnapshotRetentionPeriod:
type: integer
description: The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot
is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the
manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new
retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force
option.
Force:
type: boolean
description: A boolean value indicating whether to override an exception if the retention period has passed.
required:
- SnapshotIdentifierList
BatchModifyClusterSnapshotsOutputMessage:
type: object
properties:
Resources:
type: array
items:
type: string
description: A list of the snapshots that were modified.
Errors:
type: array
items:
$ref: '#/components/schemas/SnapshotErrorMessage'
description: A list of any errors returned.
ClusterNotFoundFault:
type: object
properties:
message:
type: string
ClusterSnapshotAlreadyExistsFault:
type: object
properties:
message:
type: string
ClusterSnapshotNotFoundFault:
type: object
properties:
message:
type: string
CreateClusterSnapshotMessage:
type: object
properties:
SnapshotIdentifier:
type: string
description: 'A unique identifier for the snapshot that you are requesting. This identifier must be unique for all
snapshots within the Amazon Web Services account. Constraints: Cannot be null, empty, or blank Must contain from
1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain
two consecutive hyphens Example: my-snapshot-id'
ClusterIdentifier:
type: string
description: The cluster identifier for which you want a snapshot.
ManualSnapshotRetentionPeriod:
type: integer
description: The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained
indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A list of tag instances.
required:
- SnapshotIdentifier
- ClusterIdentifier
CreateClusterSnapshotResult:
type: object
properties:
Snapshot:
$ref: '#/components/schemas/Snapshot'
DeleteClusterSnapshotMessage:
type: object
properties:
SnapshotIdentifier:
type: string
description: 'The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing
snapshot that is in the available, failed, or cancelled state.'
SnapshotClusterIdentifier:
type: string
description: 'The unique identifier of the cluster the snapshot was created from. This parameter is required if
your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the
cluster name. Constraints: Must be the name of valid cluster.'
required:
- SnapshotIdentifier
DeleteClusterSnapshotResult:
type: object
properties:
Snapshot:
$ref: '#/components/schemas/Snapshot'
DescribeClusterSnapshotsMessage:
type: object
properties:
ClusterIdentifier:
type: string
description: The identifier of the cluster which generated the requested snapshots.
SnapshotIdentifier:
type: string
description: The snapshot identifier of the snapshot about which to return information.
SnapshotArn:
type: string
description: The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.
SnapshotType:
type: string
description: 'The type of snapshots for which you are requesting information. By default, snapshots of all types
are returned. Valid Values: automated | manual'
StartTime:
type: string
format: date-time
description: 'A value that requests only snapshots created at or after the specified time. The time value is specified
in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z'
EndTime:
type: string
format: date-time
description: 'A time value that requests only snapshots created at or before the specified time. The time value
is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example:
2012-07-16T18:00:00Z'
MaxRecords:
type: integer
description: 'The maximum number of response records to return in each call. If the number of remaining response
records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can
retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints:
minimum 20, maximum 100.'
Marker:
type: string
description: An optional parameter that specifies the starting point to return a set of response records. When the
results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns
a value in the Marker field of the response. You can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and retrying the request.
OwnerAccount:
type: string
description: The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results
to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services
account, or do not specify the parameter.
TagKeys:
type: array
items:
type: string
description: A tag key or keys for which you want to return all matching cluster snapshots that are associated with
the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner
and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with
the snapshots that have either or both of these tag keys associated with them.
TagValues:
type: array
items:
type: string
description: A tag value or values for which you want to return all matching cluster snapshots that are associated
with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values
called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response
with the snapshots that have either or both of these tag values associated with them.
ClusterExists:
type: boolean
description: 'A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level
restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values
for this parameter work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If ClusterExists
is set to false and ClusterIdentifier isn''t specified, all snapshots associated with deleted clusters (orphaned
snapshots) are returned. If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster,
snapshots associated with that clust'
SortingEntities:
type: array
items:
$ref: '#/components/schemas/SnapshotSortingEntity'
InvalidClusterSnapshotStateFault:
type: object
properties:
message:
type: string
InvalidTagFault:
type: object
properties:
message:
type: string
ModifyClusterSnapshotMessage:
type: object
properties:
SnapshotIdentifier:
type: string
description: The identifier of the snapshot whose setting you want to modify.
ManualSnapshotRetentionPeriod:
type: integer
description: The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained
indefinitely. If the manual snapshot falls outside of the new retention period, you can specify the force option
to immediately delete the snapshot. The value must be either -1 or an integer between 1 and 3,653.
Force:
type: boolean
description: A Boolean option to override an exception if the retention period has already passed.
required:
- SnapshotIdentifier
ModifyClusterSnapshotResult:
type: object
properties:
Snapshot:
$ref: '#/components/schemas/Snapshot'
Snapshot:
type: object
properties:
SnapshotIdentifier:
type: string
description: The snapshot identifier that is provided in the request.
ClusterIdentifier:
type: string
description: The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime:
type: string
format: date-time
description: The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the
cluster data as of this exact time.
Status:
type: string
description: 'The snapshot status. The value of the status depends on the API operation used: CreateClusterSnapshot
and CopyClusterSnapshot returns status as "creating". DescribeClusterSnapshots returns status as "creating", "available",
"final snapshot", or "failed". DeleteClusterSnapshot returns status as "deleted".'
Port:
type: integer
description: The port that the cluster is listening on.
AvailabilityZone:
type: string
description: The Availability Zone in which the cluster was created.
ClusterCreateTime:
type: string
format: date-time
description: The time (UTC) when the cluster was originally created.
MasterUsername:
type: string
description: The admin user name for the cluster.
ClusterVersion:
type: string
description: The version ID of the Amazon Redshift engine that is running on the cluster.
EngineFullVersion:
type: string
description: The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
SnapshotType:
type: string
description: The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type
"manual".
NodeType:
type: string
description: The node type of the nodes in the cluster.
NumberOfNodes:
type: integer
description: The number of nodes in the cluster.
DBName:
type: string
description: The name of the database that was created when the cluster was created.
VpcId:
type: string
description: The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field
is not in the output.
Encrypted:
type: boolean
description: If true, the data in the snapshot is encrypted at rest.
KmsKeyId:
type: string
description: The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the
cluster from which the snapshot was taken.
EncryptedWithHSM:
type: boolean
description: A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess:
type: array
items:
$ref: '#/components/schemas/AccountWithRestoreAccess'
description: A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts
are authorized. Visible only to the snapshot owner.
OwnerAccount:
type: string
description: For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic
snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes:
type: number
description: The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes:
type: number
description: The size of the incremental backup.
BackupProgressInMegaBytes:
type: number
description: The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond:
type: number
description: The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed
backup.
EstimatedSecondsToCompletion:
type: integer
description: The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed
backup.
ElapsedTimeInSeconds:
type: integer
description: The amount of time an in-progress snapshot backup has been running, or the amount of time it took a
completed backup to finish.
SourceRegion:
type: string
description: The source region from which the snapshot was copied.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The list of tags for the cluster snapshot.
RestorableNodeTypes:
type: array
items:
type: string
description: The list of node types that this cluster snapshot is able to restore into.
EnhancedVpcRouting:
type: boolean
description: '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 Enhanced VPC
Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled.
Default: false'
MaintenanceTrackName:
type: string
description: The name of the maintenance track for the snapshot.
ManualSnapshotRetentionPeriod:
type: integer
description: The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained
indefinitely. The value must be either -1 or an integer between 1 and 3,653.
ManualSnapshotRemainingDays:
type: integer
description: The number of days until a manual snapshot will pass its retention period.
SnapshotRetentionStartTime:
type: string
format: date-time
description: A timestamp representing the start of the retention period for the snapshot.
MasterPasswordSecretArn:
type: string
description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId:
type: string
description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret.
SnapshotArn:
type: string
description: The Amazon Resource Name (ARN) of the snapshot.
SnapshotErrorMessage:
type: object
properties:
SnapshotIdentifier:
type: string
description: A unique identifier for the snapshot returning the error.
SnapshotClusterIdentifier:
type: string
description: A unique identifier for the cluster.
FailureCode:
type: string
description: The failure code for the error.
FailureReason:
type: string
description: The text message describing the error.
SnapshotMessage:
type: object
properties:
Marker:
type: 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 Marker parameter and retrying the command. If the Marker field is empty, all response records have
been retrieved for the request.
Snapshots:
type: array
items:
$ref: '#/components/schemas/Snapshot'
description: A list of Snapshot instances.
SnapshotSortingEntity:
type: object
properties:
Attribute:
type: string
enum:
- SOURCE_TYPE
- TOTAL_SIZE
- CREATE_TIME
description: The category for sorting the snapshots.
SortOrder:
type: string
enum:
- ASC
- DESC
description: The order for listing the attributes.
required:
- Attribute
Tag:
type: object
properties:
Key:
type: string
description: The key, or name, for the resource tag.
Value:
type: string
description: The value for the resource tag.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/redshift/service/2012-12-01/redshift-2012-12-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)