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=RestoreFromClusterSnapshot API

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

AWS Redshift #Action=RestoreFromClusterSnapshot 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=RestoreFromClusterSnapshot. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 83 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 83 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=RestoreFromClusterSnapshot 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=RestoreFromClusterSnapshot 2
GET
/#Action=RestoreFromClusterSnapshot
Amazon Redshift - G E T Restore from Cluster Snapshot
GET_RestoreFromClusterSnapshot 42 params → 200480481482483484485486
POST
/#Action=RestoreFromClusterSnapshot
Amazon Redshift - P O S T Restore from Cluster Snapshot
POST_RestoreFromClusterSnapshot 9 params body → 200480481482483484485486

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are Cluster (52 properties), RestoreFromClusterSnapshotMessage (33 properties), PendingModifiedValues (11 properties), ReservedNodeExchangeStatus (9 properties). Each schema is shown below with its type and property counts.

RestoreFromClusterSnapshotMessage
object
33 properties 1 required
NetworkInterface
object
Describes a network interface.
4 properties
HsmClientCertificateNotFoundFault
PendingActionsList
array
ClusterParameterStatus
object
Describes the status of a parameter group.
3 properties
Double
number
DeferredMaintenanceWindowsList
array
SnapshotScheduleNotFoundFault
ReservedNodeOfferingNotFoundFault
RestoreStatus
object
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
6 properties
ClusterParameterGroupNotFoundFault
InvalidClusterSnapshotStateFault
VpcEndpoint
object
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
3 properties
ReservedNodeAlreadyMigratedFault
ClusterNode
object
The identifier of a node in a cluster.
3 properties
RestoreFromClusterSnapshotResult
object
1 property
AccessToSnapshotDeniedFault
PendingModifiedValues
object
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.
11 properties
ElasticIpStatus
object
Describes the status of the elastic IP (EIP) address.
2 properties
VpcSecurityGroupMembershipList
array
UnsupportedOperationFault
Long
integer
InvalidReservedNodeStateFault
LimitExceededFault
ClusterSnapshotNotFoundFault
BooleanOptional
boolean
InvalidElasticIpFault
Integer
integer
ClusterSecurityGroupMembershipList
array
InsufficientClusterCapacityFault
String
string
ClusterSecurityGroupMembership
object
Describes a cluster security group.
2 properties
HsmConfigurationNotFoundFault
AquaStatus
string
Endpoint
object
Describes a connection endpoint.
3 properties
VpcSecurityGroupIdList
array
NumberOfNodesQuotaExceededFault
DependentServiceUnavailableFault
ClusterIamRole
object
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
2 properties
ClusterSnapshotCopyStatus
object
Returns the destination region and retention period that are configured for cross-region snapshot copy.
4 properties
ClusterNodesList
array
DependentServiceRequestThrottlingFault
ClusterQuotaExceededFault
VpcSecurityGroupMembership
object
Describes the members of a VPC security group.
2 properties
ReservedNodeNotFoundFault
ClusterParameterStatusList
array
ScheduleState
string
Tag
object
A tag consisting of a name/value pair for a resource.
2 properties
ReservedNodeExchangeStatusType
string
InvalidTagFault
NumberOfNodesPerClusterLimitExceededFault
AquaConfiguration
object
The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
2 properties
TagList
array
AquaConfigurationStatus
string
DoubleOptional
number
ResizeInfo
object
Describes a resize operation.
2 properties
ClusterAlreadyExistsFault
ReservedNodeAlreadyExistsFault
Cluster
object
Describes a cluster.
52 properties
InvalidVPCNetworkStateFault
ClusterIamRoleList
array
IntegerOptional
integer
DataTransferProgress
object
Describes the status of a cluster while it is in the process of resizing with an incremental resize.
6 properties
TStamp
string
VpcEndpointsList
array
UnauthorizedOperation
HsmStatus
object
Describes the status of changes to HSM settings.
3 properties
InvalidRestoreFault
ReservedNodeExchangeStatus
object
Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other detail…
9 properties
InvalidClusterSubnetGroupStateFault
ClusterSecurityGroupNameList
array
ClusterParameterGroupStatusList
array
ClusterSubnetGroupNotFoundFault
ClusterSecurityGroupNotFoundFault
NetworkInterfaceList
array
InvalidSubnet
IamRoleArnList
array
InvalidClusterTrackFault
Boolean
boolean
TagLimitExceededFault
LongOptional
integer
DeferredMaintenanceWindow
object
Describes a deferred maintenance window
3 properties
ClusterParameterGroupStatus
object
Describes the status of a parameter group.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-action-restorefromclustersnapshot-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=CopyClusterSnapshot API