Amazon Redshift

(1)

Amazon Redshift

API Reference

API Version 2012-12-01

(2)

Amazon Redshift: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

Overview

This is an interface reference for Amazon Redshift. It contains documentation for one of the

programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.

Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse:

provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.

If you are a ﬁrst-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.

If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.

This document was last published on March 6, 2022.

(20)

Actions

The following actions are supported:

• AcceptReservedNodeExchange (p. 5)

• AddPartner (p. 8)

• AssociateDataShareConsumer (p. 10)

• AuthorizeClusterSecurityGroupIngress (p. 13)

• AuthorizeDataShare (p. 16)

• AuthorizeEndpointAccess (p. 19)

• AuthorizeSnapshotAccess (p. 22)

• BatchDeleteClusterSnapshots (p. 24)

• BatchModifyClusterSnapshots (p. 26)

• CancelResize (p. 29)

• CopyClusterSnapshot (p. 33)

• CreateAuthenticationProﬁle (p. 37)

• CreateCluster (p. 39)

• CreateClusterParameterGroup (p. 51)

• CreateClusterSecurityGroup (p. 54)

• CreateClusterSnapshot (p. 57)

• CreateClusterSubnetGroup (p. 61)

• CreateEndpointAccess (p. 65)

• CreateEventSubscription (p. 69)

• CreateHsmClientCertiﬁcate (p. 74)

• CreateHsmConﬁguration (p. 77)

• CreateScheduledAction (p. 80)

• CreateSnapshotCopyGrant (p. 84)

• CreateSnapshotSchedule (p. 87)

• CreateTags (p. 91)

• CreateUsageLimit (p. 93)

• DeauthorizeDataShare (p. 97)

• DeleteAuthenticationProﬁle (p. 100)

• DeleteCluster (p. 102)

• DeleteClusterParameterGroup (p. 106)

• DeleteClusterSecurityGroup (p. 108)

• DeleteClusterSnapshot (p. 110)

• DeleteClusterSubnetGroup (p. 113)

• DeleteEndpointAccess (p. 115)

• DeleteEventSubscription (p. 118)

• DeleteHsmClientCertiﬁcate (p. 120)

• DeleteHsmConﬁguration (p. 122)

• DeletePartner (p. 124)

• DeleteScheduledAction (p. 126)

• DeleteSnapshotCopyGrant (p. 128)

(21)

• DeleteSnapshotSchedule (p. 130)

• DeleteTags (p. 132)

• DeleteUsageLimit (p. 134)

• DescribeAccountAttributes (p. 135)

• DescribeAuthenticationProﬁles (p. 137)

• DescribeClusterDbRevisions (p. 139)

• DescribeClusterParameterGroups (p. 142)

• DescribeClusterParameters (p. 146)

• DescribeClusters (p. 151)

• DescribeClusterSecurityGroups (p. 155)

• DescribeClusterSnapshots (p. 159)

• DescribeClusterSubnetGroups (p. 164)

• DescribeClusterTracks (p. 168)

• DescribeClusterVersions (p. 171)

• DescribeDataShares (p. 174)

• DescribeDataSharesForConsumer (p. 177)

• DescribeDataSharesForProducer (p. 179)

• DescribeDefaultClusterParameters (p. 181)

• DescribeEndpointAccess (p. 185)

• DescribeEndpointAuthorization (p. 188)

• DescribeEventCategories (p. 190)

• DescribeEvents (p. 192)

• DescribeEventSubscriptions (p. 197)

• DescribeHsmClientCertiﬁcates (p. 201)

• DescribeHsmConﬁgurations (p. 205)

• DescribeLoggingStatus (p. 208)

• DescribeNodeConﬁgurationOptions (p. 211)

• DescribeOrderableClusterOptions (p. 215)

• DescribePartners (p. 219)

• DescribeReservedNodeExchangeStatus (p. 221)

• DescribeReservedNodeOﬀerings (p. 223)

• DescribeReservedNodes (p. 227)

• DescribeResize (p. 230)

• DescribeScheduledActions (p. 234)

• DescribeSnapshotCopyGrants (p. 238)

• DescribeSnapshotSchedules (p. 241)

• DescribeStorage (p. 244)

• DescribeTableRestoreStatus (p. 246)

• DescribeTags (p. 249)

• DescribeUsageLimits (p. 253)

• DisableLogging (p. 256)

• DisableSnapshotCopy (p. 258)

• DisassociateDataShareConsumer (p. 261)

• EnableLogging (p. 264)

• EnableSnapshotCopy (p. 267)

• GetClusterCredentials (p. 272)

(22)

• GetReservedNodeExchangeConﬁgurationOptions (p. 276)

• GetReservedNodeExchangeOﬀerings (p. 279)

• ModifyAquaConﬁguration (p. 282)

• ModifyAuthenticationProﬁle (p. 284)

• ModifyCluster (p. 286)

• ModifyClusterDbRevision (p. 296)

• ModifyClusterIamRoles (p. 298)

• ModifyClusterMaintenance (p. 302)

• ModifyClusterParameterGroup (p. 306)

• ModifyClusterSnapshot (p. 309)

• ModifyClusterSnapshotSchedule (p. 312)

• ModifyClusterSubnetGroup (p. 314)

• ModifyEndpointAccess (p. 317)

• ModifyEventSubscription (p. 320)

• ModifyScheduledAction (p. 324)

• ModifySnapshotCopyRetentionPeriod (p. 329)

• ModifySnapshotSchedule (p. 333)

• ModifyUsageLimit (p. 336)

• PauseCluster (p. 339)

• PurchaseReservedNodeOﬀering (p. 341)

• RebootCluster (p. 344)

• RejectDataShare (p. 347)

• ResetClusterParameterGroup (p. 350)

• ResizeCluster (p. 353)

• RestoreFromClusterSnapshot (p. 359)

• RestoreTableFromClusterSnapshot (p. 370)

• ResumeCluster (p. 374)

• RevokeClusterSecurityGroupIngress (p. 376)

• RevokeEndpointAccess (p. 379)

• RevokeSnapshotAccess (p. 382)

• RotateEncryptionKey (p. 384)

• UpdatePartnerStatus (p. 387)

(23)

AcceptReservedNodeExchange

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the conﬁguration (term, payment type, or number of nodes) and no additional costs.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 510).

ReservedNodeId

A string representing the node identiﬁer of the DC1 Reserved Node to be exchanged.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

TargetReservedNodeOﬀeringId

The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings (p. 279)

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

ExchangedReservedNode

Type: ReservedNode (p. 466) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 512).

DependentServiceUnavailableFault

Your request cannot be completed because a dependent internal service is temporarily unavailable.

Wait 30 to 60 seconds and try again.

HTTP Status Code: 400 InvalidReservedNodeState

Indicates that the Reserved Node being exchanged is not in an active state.

HTTP Status Code: 400

(24)

Examples

ReservedNodeAlreadyExists

User already has a reservation with the given identiﬁer.

HTTP Status Code: 404 ReservedNodeAlreadyMigrated

Indicates that the reserved node has already been exchanged.

HTTP Status Code: 400 ReservedNodeNotFound

The speciﬁed reserved compute node not found.

HTTP Status Code: 404 ReservedNodeOﬀeringNotFound

Speciﬁed oﬀering does not exist.

HTTP Status Code: 404 UnsupportedOperation

The requested operation isn't supported.

Examples

Example

This example illustrates one usage of AcceptReservedNodeExchange.

Sample Request

https://redshift.us-east-2.amazonaws.com/

?Action=AcceptReservedNodeExchange

&ReservedNodeId=12345678-12ab-12a1-1a2a-12ab-12a12aEXAMPLE

&TargetReservedNodeOfferingId=12345678-12ab-12a1-1a2a-12ab-12a12bEXAMPLE

&SignatureMethod=HmacSHA256&SignatureVersion=4

&Version=2012-12-01

&X-Amz-Algorithm=AWS4-HMAC-SHA256

&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request

&X-Amz-Date=20190825T160000Z

&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date

&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<ReservedNodeId>12345678-12ab-12a1-1a2a-12ab-12a12aEXAMPLE</ReservedNodeId>

<OfferingType>All Upfront</OfferingType>

<ReservedNodeOfferingType>Regular</ReservedNodeOfferingType>

(25)

See Also

<RecurringChargeFrequency>Hourly</RecurringChargeFrequency>

</RecurringCharge>

</RecurringCharges>

<NodeType>dc2.large</NodeType>

<ReservedNodeOfferingId>12345678-12ab-12a1-1a2a-12ab-12a12bEXAMPLE</

ReservedNodeOfferingId>

<State>exchanging</State>

</ExchangedReservedNode>

</AcceptReservedNodeExchangeResult>

</ResponseMetadata>

</AcceptReservedNodeExchangeResponse>

AddPartner

Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the speciﬁed database. To complete the integration, you also set up the integration on the partner website.

Request Parameters

AccountId

The AWS account ID that owns the cluster.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]+$

Required: Yes ClusterIdentiﬁer

The cluster identiﬁer of the cluster that receives data from the partner.

Type: String

Pattern: ^[a-zA-Z0-9\-]+$

Required: Yes DatabaseName

The name of the database that receives data from the partner.

Type: String

Pattern: ^[\p{L}_][\p{L}\p{N}@$#_]+$

Required: Yes PartnerName

The name of the partner that is authorized to send data.

Type: String

Pattern: ^[a-zA-Z0-9\-_]+$

Required: Yes

Response Elements

The following elements are returned by the service.

(27)

Errors

DatabaseName

The name of the database that receives data from the partner.

Type: String

Pattern: ^[\p{L}_][\p{L}\p{N}@$#_]+$

PartnerName

The name of the partner that is authorized to send data.

Type: String

Pattern: ^[a-zA-Z0-9\-_]+$

Errors

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404 PartnerNotFound

The name of the partner was not found.

HTTP Status Code: 404 UnauthorizedPartnerIntegration

The partner integration is not authorized.

AssociateDataShareConsumer

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the speciﬁed namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

Request Parameters

DataShareArn

The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

Type: String

Required: Yes AssociateEntireAccount

A value that speciﬁes whether the datashare is associated with the entire account.

Type: Boolean Required: No ConsumerArn

The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.

Type: String

Required: No ConsumerRegion

From a datashare consumer account, associates a datashare with all existing and future namespaces in the speciﬁed AWS Region.

Type: String

Required: No

Response Elements

AllowPubliclyAccessibleConsumers

A value that speciﬁes whether the datashare can be shared to a publicly accessible cluster.

Type: Boolean

(29)

Errors

DataShareArn

An Amazon Resource Name (ARN) that references the datashare that is owned by a speciﬁc namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:

{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

Type: String

DataShareAssociations.member.N

A value that speciﬁes when the datashare has an association between a producer and data consumers.

Type: Array of DataShareAssociation (p. 425) objects ManagedBy

The identiﬁer of a datashare to show its managing entity.

Type: String

ProducerArn

The Amazon Resource Name (ARN) of the producer.

Type: String

Errors

InvalidDataShareFault

There is an error with the datashare.

HTTP Status Code: 400 InvalidNamespaceFault

The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.

Examples

Example

This example illustrates one usage of AssociateDataShareConsumer.

Sample Request

AssociateDataShareConsumer&AssociateEntireAccount=true&DataShareArn=arn%3Aaws%3Aredshift

%3Aus-east-1%3A827630067164%3Adatashare%3Aa1c54ed4-8323-4d14-b5dd-927cb596dc0e

%2Ftestshare&Version=2012-12-01

(30)

See Also

Sample Response

<ProducerNamespaceArn>arn:aws:redshift:us-

east-1:827630067164:namespace:a1c54ed4-8323-4d14-b5dd-927cb596dc0e</ProducerNamespaceArn>

<AllowPubliclyAccessibleConsumers>false</AllowPubliclyAccessibleConsumers>

<DataShareArn>arn:aws:redshift:us-east-1:827630067164:datashare:a1c54ed4-8323-4d14- b5dd-927cb596dc0e/testshare</DataShareArn>

<Status>ACTIVE</Status>

</member>

</DataShareAssociations>

</AssociateDataShareConsumerResult>

</ResponseMetadata>

</AssociateDataShareConsumerResponse>

AuthorizeClusterSecurityGroupIngress

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and

EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.

If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

Request Parameters

ClusterSecurityGroupName

The name of the security group to which the ingress rule is added.

Type: String

Required: Yes CIDRIP

The IP range to be added the Amazon Redshift security group.

Type: String

Required: No EC2SecurityGroupName

The EC2 security group to be added the Amazon Redshift security group.

Type: String

Required: No

EC2SecurityGroupOwnerId

The AWS account number of the owner of the security group speciﬁed by the

EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Example: 111122223333

(32)

Response Elements

Type: String

Required: No

Response Elements

ClusterSecurityGroup

Describes a security group.

Type: ClusterSecurityGroup (p. 415) object

Errors

AuthorizationAlreadyExists

The speciﬁed CIDR block or EC2 security group is already authorized for the speciﬁed cluster security group.

HTTP Status Code: 400 AuthorizationQuotaExceeded

The authorization quota for the cluster security group has been reached.

HTTP Status Code: 400 ClusterSecurityGroupNotFound

The cluster security group name does not refer to an existing cluster security group.

HTTP Status Code: 404 InvalidClusterSecurityGroupState

The state of the cluster security group is not available.

Examples

Example

This example illustrates one usage of AuthorizeClusterSecurityGroupIngress.

Sample Request

?Action=AuthorizeClusterSecurityGroupIngress &CIDRIP=10.24.34.0/24

&ClusterSecurityGroupName=example-security-group

(33)

See Also

&SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01

&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20150817/us-east-2/redshift/aws4_request &X-Amz-Date=20150825T160000Z

&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<AuthorizeClusterSecurityGroupIngressResponse xmlns="http://redshift.amazonaws.com/

doc/2012-12-01/">

<Tags/>

<Status>authorized</Status>

</IPRange>

</IPRanges>

<Description>Example security group</Description>

<ClusterSecurityGroupName>example-security-group</ClusterSecurityGroupName>

</ClusterSecurityGroup>

</AuthorizeClusterSecurityGroupIngressResult>

</ResponseMetadata>

</AuthorizeClusterSecurityGroupIngressResponse>

AuthorizeDataShare

From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access privileges.

Request Parameters

ConsumerIdentiﬁer

The identiﬁer of the data consumer that is authorized to access the datashare. This identiﬁer is an AWS account ID or a keyword, such as ADX.

Type: String

Required: Yes DataShareArn

The Amazon Resource Name (ARN) of the datashare that producers are to authorize sharing for.

Type: String

Required: Yes

Response Elements

AllowPubliclyAccessibleConsumers

A value that speciﬁes whether the datashare can be shared to a publicly accessible cluster.

Type: Boolean DataShareArn

An Amazon Resource Name (ARN) that references the datashare that is owned by a speciﬁc namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:

{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

Type: String

DataShareAssociations.member.N

A value that speciﬁes when the datashare has an association between a producer and data consumers.

Type: Array of DataShareAssociation (p. 425) objects

(35)

Errors

ManagedBy

The identiﬁer of a datashare to show its managing entity.

Type: String

ProducerArn

The Amazon Resource Name (ARN) of the producer.

Type: String

Errors

InvalidDataShareFault

There is an error with the datashare.

Examples

Example

This example illustrates one usage of AuthorizeDataShare.

Sample Request

?Action=AuthorizeDataShare &ConsumerIdentifier=275247490162

&DataShareArn=arn%3Aaws%3Aredshift%3Aus-east-1%3A827630067164%3Adatashare

%3Aaf06285e-8a45-4ee9-b598-648c218c8ff1%2Ftestshare2 &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01

Sample Response

<AllowPubliclyAccessibleConsumers>false</AllowPubliclyAccessibleConsumers>

<ProducerNamespaceArn>arn:aws:redshift:us-

east-1:827630067164:namespace:af06285e-8a45-4ee9-b598-648c218c8ff1</ProducerNamespaceArn>

<DataShareArn>arn:aws:redshift:us-

east-1:827630067164:datashare:af06285e-8a45-4ee9-b598-648c218c8ff1/testshare2</

DataShareArn>

(36)

See Also

<Status>PENDING_ACCEPTANCE</Status>

</member>

</DataShareAssociations>

</AuthorizeDataShareResult>

</ResponseMetadata>

</AuthorizeDataShareResponse>

AuthorizeEndpointAccess

Grants access to a cluster.

Request Parameters

Account

The AWS account ID to grant access to.

Type: String

Required: Yes ClusterIdentiﬁer

The cluster identiﬁer of the cluster to grant access to.

Type: String

Required: No VpcIds.VpcIdentiﬁer.N

The virtual private cloud (VPC) identiﬁers to grant access to.

Type: Array of strings

Required: No

Response Elements

AllowedAllVPCs

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

Type: Boolean

AllowedVPCs.VpcIdentiﬁer.N

The VPCs allowed access to the cluster.

AuthorizeTime

The time (UTC) when the authorization was created.

(38)

Errors

Type: Timestamp ClusterIdentiﬁer

The cluster identiﬁer.

Type: String

ClusterStatus

The status of the cluster.

Type: String

EndpointCount

The number of Redshift-managed VPC endpoints created for the authorization.

Type: Integer Grantee

The AWS account ID of the grantee of the cluster.

Type: String

Grantor

The AWS account ID of the cluster owner.

Type: String

Status

The status of the authorization action.

Type: String

Valid Values: Authorized | Revoking

Errors

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

EndpointAuthorizationAlreadyExists

The authorization already exists for this endpoint.

EndpointAuthorizationsPerClusterLimitExceeded

The number of endpoint authorizations per cluster has exceeded its limit.

(39)

See Also

HTTP Status Code: 400 InvalidAuthorizationState

The status of the authorization is not valid.

HTTP Status Code: 400 InvalidClusterState

The speciﬁed cluster is not in the available state.

HTTP Status Code: 400 UnsupportedOperation

The requested operation isn't supported.

AuthorizeSnapshotAccess

Authorizes the speciﬁed AWS account to restore the speciﬁed snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Request Parameters

AccountWithRestoreAccess

The identiﬁer of the AWS account authorized to restore the speciﬁed snapshot.

To share a snapshot with AWS Support, specify amazon-redshift-support.

Type: String

Required: Yes SnapshotIdentiﬁer

The identiﬁer of the snapshot the account is authorized to restore.

Type: String

Required: Yes

SnapshotClusterIdentiﬁer

The identiﬁer 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 speciﬁes anything other than * for the cluster name.

Type: String

Required: No

Response Elements

Snapshot

Describes a snapshot.

Type: Snapshot (p. 485) object

Errors

(41)

See Also

AuthorizationAlreadyExists

The speciﬁed CIDR block or EC2 security group is already authorized for the speciﬁed cluster security group.

HTTP Status Code: 400 AuthorizationQuotaExceeded

The authorization quota for the cluster security group has been reached.

HTTP Status Code: 400 ClusterSnapshotNotFound

The snapshot identiﬁer does not refer to an existing cluster snapshot.

DependentServiceRequestThrottlingFault

The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.

HTTP Status Code: 400 InvalidClusterSnapshotState

The speciﬁed cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.

HTTP Status Code: 400 LimitExceededFault

The encryption key has exceeded its grant limit in AWS KMS.

BatchDeleteClusterSnapshots

Deletes a set of cluster snapshots.

Request Parameters

Identiﬁers.DeleteClusterSnapshotMessage.N

A list of identiﬁers for the snapshots that you want to delete.

Type: Array of DeleteClusterSnapshotMessage (p. 431) objects Required: Yes

Response Elements

Errors.SnapshotErrorMessage.N A list of any errors returned.

Type: Array of SnapshotErrorMessage (p. 492) objects Resources.String.N

A list of the snapshot identiﬁers that were deleted.

Errors

BatchDeleteRequestSizeExceeded

The maximum number for a batch delete of snapshots has been reached. The limit is 100.

Examples

Example

This example illustrates one usage of BatchDeleteClusterSnapshots.

Sample Request

(43)

See Also

?Action=BatchDeleteClusterSnapshots

&Identifiers.DeleteClusterSnapshotMessage.1.SnapshotIdentifier=mysnapshotid1 &Identifiers.DeleteClusterSnapshotMessage.2.SnapshotIdentifier=mysnapshotid2 &SignatureMethod=HmacSHA256&SignatureVersion=4

&Version=2012-12-01

Sample Response

<String>mysnapshotid1</String>

</Resources>

</BatchDeleteClusterSnapshotsResult>

</ResponseMetadata>

</BatchDeleteClusterSnapshotsResponse>

BatchModifyClusterSnapshots

Modiﬁes the settings for a set of cluster snapshots.

Request Parameters

SnapshotIdentiﬁerList.String.N

A list of snapshot identiﬁers you want to modify.

Required: Yes Force

A boolean value indicating whether to override an exception if the retention period has passed.

Type: Boolean Required: No

ManualSnapshotRetentionPeriod

The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indeﬁnitely.

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.

Type: Integer Required: No

Response Elements

Errors.SnapshotErrorMessage.N A list of any errors returned.

Type: Array of SnapshotErrorMessage (p. 492) objects Resources.String.N

A list of the snapshots that were modiﬁed.

(45)

Errors

BatchModifyClusterSnapshotsLimitExceededFault

The maximum number for snapshot identiﬁers has been reached. The limit is 100.

HTTP Status Code: 400 InvalidRetentionPeriodFault

The retention period speciﬁed is either in the past or is not a valid value.

The value must be either -1 or an integer between 1 and 3,653.

Examples

Example

This example illustrates one usage of BatchModifyClusterSnapshots.

Sample Request

?Action=BatchModifyClusterSnapshots

&SnapshotIdentifierList.String.1=mysnapshotid1

&SnapshotIdentifierList.String.2=mysnapshotid2

&ManualSnapshotRetentionPeriod=30

&SignatureMethod=HmacSHA256&SignatureVersion=4

&Version=2012-12-01

&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request

&X-Amz-Date=20190825T160000Z

&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date

&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

</Resources>

</BatchModifyClusterSnapshotsResult>

</ResponseMetadata>

</BatchModifyClusterSnapshotsResponse>

CancelResize

Cancels a resize operation for a cluster.

Request Parameters

ClusterIdentiﬁer

The unique identiﬁer for the cluster that you want to cancel a resize operation for.

Type: String

Required: Yes

Response Elements

AvgResizeRateInMegaBytesPerSecond

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.

Type: Double

DataTransferProgressPercent

The percent of data transferred from source cluster to target cluster.

Type: Double ElapsedTimeInSeconds

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.

Type: Long

EstimatedTimeToCompletionInSeconds

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.

Type: Long

ImportTablesCompleted.member.N

The names of tables that have been completely imported . Valid Values: List of table names.

Amazon Redshift

Amazon Redshift

API Reference

API Version 2012-12-01

Amazon Redshift: API Reference

Table of Contents

Welcome

Actions

AcceptReservedNodeExchange

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

AddPartner

Request Parameters

Response Elements

Errors

See Also

AssociateDataShareConsumer

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

AuthorizeClusterSecurityGroupIngress

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

AuthorizeDataShare

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

AuthorizeEndpointAccess

Request Parameters

Response Elements

Errors

See Also

AuthorizeSnapshotAccess

Request Parameters

Response Elements

Errors

See Also

BatchDeleteClusterSnapshots

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchModifyClusterSnapshots

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

CancelResize

Request Parameters

Response Elements