Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Redshift #Action=CopyClusterSnapshot API

The #Action=CopyClusterSnapshot API from AWS Redshift — 1 operation(s) for #action=copyclustersnapshot.

AWS Redshift #Action=CopyClusterSnapshot API is one of 130 APIs that AWS Redshift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #Action=CopyClusterSnapshot. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 2019-12-20.

Requests are made against 4 base URLs: http://redshift-data.{region}.amazonaws.com, https://redshift-data.{region}.amazonaws.com, http://redshift-data.{region}.amazonaws.com.cn, https://redshift-data.{region}.amazonaws.com.cn.

2 operations 1 paths 20 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2019-12-20
Base URL
https://redshift.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Redshift #Action=CopyClusterSnapshot API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

#Action=CopyClusterSnapshot 2
GET
/#Action=CopyClusterSnapshot
Amazon Redshift - G E T Copy Cluster Snapshot
GET_CopyClusterSnapshot 13 params → 200480481482483484
POST
/#Action=CopyClusterSnapshot
Amazon Redshift - P O S T Copy Cluster Snapshot
POST_CopyClusterSnapshot 9 params body → 200480481482483484

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Snapshot (34 properties), CopyClusterSnapshotMessage (4 properties), AccountWithRestoreAccess (2 properties), Tag (2 properties). Each schema is shown below with its type and property counts.

ClusterSnapshotNotFoundFault
Tag
object
A tag consisting of a name/value pair for a resource.
2 properties
TStamp
string
Double
number
CopyClusterSnapshotResult
object
1 property
Integer
integer
String
string
TagList
array
CopyClusterSnapshotMessage
object
4 properties 2 required
RestorableNodeTypeList
array
Snapshot
object
Describes a snapshot.
34 properties
InvalidClusterSnapshotStateFault
AccountWithRestoreAccess
object
Describes an Amazon Web Services account authorized to restore a snapshot.
2 properties
ClusterSnapshotAlreadyExistsFault
AccountsWithRestoreAccessList
array
Boolean
boolean
IntegerOptional
integer
ClusterSnapshotQuotaExceededFault
Long
integer
InvalidRetentionPeriodFault

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-action-copyclustersnapshot-api-openapi.yml Raw ↑

Other APIs AWS Redshift publishes across the network.

Amazon Redshift Serverless API
AWS Redshift #Action=AcceptReservedNodeExchange API
AWS Redshift #Action=AddPartner API
AWS Redshift #Action=AssociateDataShareConsumer API
AWS Redshift #Action=AuthorizeClusterSecurityGroupIngress API
AWS Redshift #Action=AuthorizeDataShare API
AWS Redshift #Action=AuthorizeEndpointAccess API
AWS Redshift #Action=AuthorizeSnapshotAccess API
AWS Redshift #Action=BatchDeleteClusterSnapshots API
AWS Redshift #Action=BatchModifyClusterSnapshots API
AWS Redshift #Action=CancelResize API
AWS Redshift #Action=CreateAuthenticationProfile API