Amazon Web Services - API Amazon Redshift

Amazon Web Services / Amazon Redshift

Amazon Redshift

Amazon Redshift

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 first-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.

License: Apache 2.0 License

Resources

GET

/#Action=AcceptReservedNodeExchange

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

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `AcceptReservedNodeExchange`
`TargetReservedNodeOfferingId`	string	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
`ReservedNodeId`	string	A string representing the node identifier of the DC1 Reserved Node to be exchanged.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`AcceptReservedNodeExchangeOutputMessage`	object

Properties


                        ExchangedReservedNode

ReservedNode


                        ReservedNode

object

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

Properties


                        ReservedNodeOfferingType

ReservedNodeOfferingType

ReservedNodeOfferingType string
Allowed values:
- Regular
- Upgradable


                        RecurringCharges

RecurringChargeList

The recurring charges for the reserved node.

RecurringChargeList array [RecurringCharge]


                        OfferingType

String

The anticipated utilization of the reserved node, as defined in the reserved node offering.

String string


                        State

String

The state of the reserved compute node.

Possible Values:

pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
active-This reserved node is owned by the caller and is available for use.
payment-failed-Payment failed for the purchase attempt.
retired-The reserved node is no longer available.
exchanging-The owner is exchanging the reserved node for another reserved node.

String string


                        NodeCount

Integer

The number of reserved compute nodes.

Integer integer


                        CurrencyCode

String

The currency code for the reserved cluster.

String string


                        UsagePrice

Double

The hourly rate Amazon Redshift charges you for this reserved node.

Double double


                        FixedPrice

Double

The fixed cost Amazon Redshift charges you for this reserved node.

Double double


                        Duration

Integer

The duration of the node reservation in seconds.

Integer integer


                        StartTime

TStamp

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

TStamp dateTime


                        NodeType

String

The node type of the reserved node.

String string


                        ReservedNodeOfferingId

String

The identifier for the reserved node offering.

String string


                        ReservedNodeId

String

The unique identifier for the reservation.

String string

480ReservedNodeNotFoundFault

Body

Name	Data Type	Description
`ReservedNodeNotFoundFault`

481InvalidReservedNodeStateFault

Body

Name	Data Type	Description
`InvalidReservedNodeStateFault`

482ReservedNodeAlreadyMigratedFault

Body

Name	Data Type	Description
`ReservedNodeAlreadyMigratedFault`

483ReservedNodeOfferingNotFoundFault

Body

Name	Data Type	Description
`ReservedNodeOfferingNotFoundFault`

484UnsupportedOperationFault

Body

Name	Data Type	Description
`UnsupportedOperationFault`

485DependentServiceUnavailableFault

Body

Name	Data Type	Description
`DependentServiceUnavailableFault`

486ReservedNodeAlreadyExistsFault

Body

Name	Data Type	Description
`ReservedNodeAlreadyExistsFault`

POST

/#Action=AcceptReservedNodeExchange

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

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `AcceptReservedNodeExchange`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`TargetReservedNodeOfferingId`	string	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
`ReservedNodeId`	string	A string representing the node identifier of the DC1 Reserved Node to be exchanged.

Responses

200Success

Body

Name	Data Type	Description
`AcceptReservedNodeExchangeOutputMessage`	object

Properties


                        ExchangedReservedNode

ReservedNode


                        ReservedNode

object

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

Properties


                        ReservedNodeOfferingType

ReservedNodeOfferingType

ReservedNodeOfferingType string
Allowed values:
- Regular
- Upgradable


                        RecurringCharges

RecurringChargeList

The recurring charges for the reserved node.

RecurringChargeList array [RecurringCharge]


                        OfferingType

String

The anticipated utilization of the reserved node, as defined in the reserved node offering.

String string


                        State

String

The state of the reserved compute node.

Possible Values:

pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
active-This reserved node is owned by the caller and is available for use.
payment-failed-Payment failed for the purchase attempt.
retired-The reserved node is no longer available.
exchanging-The owner is exchanging the reserved node for another reserved node.

String string


                        NodeCount

Integer

The number of reserved compute nodes.

Integer integer


                        CurrencyCode

String

The currency code for the reserved cluster.

String string


                        UsagePrice

Double

The hourly rate Amazon Redshift charges you for this reserved node.

Double double


                        FixedPrice

Double

The fixed cost Amazon Redshift charges you for this reserved node.

Double double


                        Duration

Integer

The duration of the node reservation in seconds.

Integer integer


                        StartTime

TStamp

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

TStamp dateTime


                        NodeType

String

The node type of the reserved node.

String string


                        ReservedNodeOfferingId

String

The identifier for the reserved node offering.

String string


                        ReservedNodeId

String

The unique identifier for the reservation.

String string

480ReservedNodeNotFoundFault

Body

Name	Data Type	Description
`ReservedNodeNotFoundFault`

481InvalidReservedNodeStateFault

Body

Name	Data Type	Description
`InvalidReservedNodeStateFault`

482ReservedNodeAlreadyMigratedFault

Body

Name	Data Type	Description
`ReservedNodeAlreadyMigratedFault`

483ReservedNodeOfferingNotFoundFault

Body

Name	Data Type	Description
`ReservedNodeOfferingNotFoundFault`

484UnsupportedOperationFault

Body

Name	Data Type	Description
`UnsupportedOperationFault`

485DependentServiceUnavailableFault

Body

Name	Data Type	Description
`DependentServiceUnavailableFault`

486ReservedNodeAlreadyExistsFault

Body

Name	Data Type	Description
`ReservedNodeAlreadyExistsFault`

GET

/#Action=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

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `AuthorizeClusterSecurityGroupIngress`
`EC2SecurityGroupOwnerId`	string	The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: `111122223333`
`EC2SecurityGroupName`	string	The EC2 security group to be added the Amazon Redshift security group.
`CIDRIP`	string	The IP range to be added the Amazon Redshift security group.
`ClusterSecurityGroupName`	string	The name of the security group to which the ingress rule is added.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`AuthorizeClusterSecurityGroupIngressResult`	object

Properties

ClusterSecurityGroup ClusterSecurityGroup


                        ClusterSecurityGroup

object

Describes a security group.

Properties


                        Tags

TagList

The list of tags for the cluster security group.

TagList array [Tag]


                        IPRanges

IPRangeList

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

IPRangeList array [IPRange]


                        EC2SecurityGroups

EC2SecurityGroupList

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

EC2SecurityGroupList array [EC2SecurityGroup]


                        Description

String

A description of the security group.

String string


                        ClusterSecurityGroupName

String

The name of the cluster security group to which the operation was applied.

String string

480ClusterSecurityGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterSecurityGroupNotFoundFault`

481InvalidClusterSecurityGroupStateFault

Body

Name	Data Type	Description
`InvalidClusterSecurityGroupStateFault`

482AuthorizationAlreadyExistsFault

Body

Name	Data Type	Description
`AuthorizationAlreadyExistsFault`

483AuthorizationQuotaExceededFault

Body

Name	Data Type	Description
`AuthorizationQuotaExceededFault`

POST

/#Action=AuthorizeClusterSecurityGroupIngress

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.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `AuthorizeClusterSecurityGroupIngress`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`EC2SecurityGroupOwnerId`	string	The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: `111122223333`
`EC2SecurityGroupName`	string	The EC2 security group to be added the Amazon Redshift security group.
`CIDRIP`	string	The IP range to be added the Amazon Redshift security group.
`ClusterSecurityGroupName`	string	The name of the security group to which the ingress rule is added.

Responses

200Success

Body

Name	Data Type	Description
`AuthorizeClusterSecurityGroupIngressResult`	object

Properties

ClusterSecurityGroup ClusterSecurityGroup


                        ClusterSecurityGroup

object

Describes a security group.

Properties


                        Tags

TagList

The list of tags for the cluster security group.

TagList array [Tag]


                        IPRanges

IPRangeList

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

IPRangeList array [IPRange]


                        EC2SecurityGroups

EC2SecurityGroupList

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

EC2SecurityGroupList array [EC2SecurityGroup]


                        Description

String

A description of the security group.

String string


                        ClusterSecurityGroupName

String

The name of the cluster security group to which the operation was applied.

String string

480ClusterSecurityGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterSecurityGroupNotFoundFault`

481InvalidClusterSecurityGroupStateFault

Body

Name	Data Type	Description
`InvalidClusterSecurityGroupStateFault`

482AuthorizationAlreadyExistsFault

Body

Name	Data Type	Description
`AuthorizationAlreadyExistsFault`

483AuthorizationQuotaExceededFault

Body

Name	Data Type	Description
`AuthorizationQuotaExceededFault`

GET

/#Action=AuthorizeSnapshotAccess

Authorizes the specified AWS customer account to restore the specified snapshot.

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

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `AuthorizeSnapshotAccess`
`AccountWithRestoreAccess`	string	The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support.
`SnapshotClusterIdentifier`	string	The 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.
`SnapshotIdentifier`	string	The identifier of the snapshot the account is authorized to restore.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`AuthorizeSnapshotAccessResult`	object

Properties

Snapshot Snapshot


                        Snapshot

object

Describes a snapshot.

Properties


                        SnapshotRetentionStartTime

TStamp

A timestamp representing the start of the retention period for the snapshot.

TStamp dateTime


                        ManualSnapshotRemainingDays

IntegerOptional

The number of days until a manual snapshot will pass its retention period.

IntegerOptional integer


                        ManualSnapshotRetentionPeriod

IntegerOptional

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.

IntegerOptional integer


                        MaintenanceTrackName

String

The name of the maintenance track for the snapshot.

String string


                        EnhancedVpcRouting

Boolean

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

Boolean boolean


                        RestorableNodeTypes

RestorableNodeTypeList

The list of node types that this cluster snapshot is able to restore into.

RestorableNodeTypeList array [String]


                        Tags

TagList

The list of tags for the cluster snapshot.

TagList array [Tag]


                        SourceRegion

String

The source region from which the snapshot was copied.

String string


                        ElapsedTimeInSeconds

Long

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Long integer


                        EstimatedSecondsToCompletion

Long

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Long integer


                        CurrentBackupRateInMegaBytesPerSecond

Double

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Double double


                        BackupProgressInMegaBytes

Double

The number of megabytes that have been transferred to the snapshot backup.

Double double


                        ActualIncrementalBackupSizeInMegaBytes

Double

The size of the incremental backup.

Double double


                        TotalBackupSizeInMegaBytes

Double

The size of the complete set of backup data that would be used to restore the cluster.

Double double


                        OwnerAccount

String

For manual snapshots, the AWS customer 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.

String string


                        AccountsWithRestoreAccess

AccountsWithRestoreAccessList

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

AccountsWithRestoreAccessList array [AccountWithRestoreAccess]


                        EncryptedWithHSM

Boolean

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.

Boolean boolean


                        KmsKeyId

String

The AWS 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.

String string


                        Encrypted

Boolean

If true, the data in the snapshot is encrypted at rest.

Boolean boolean


                        VpcId

String

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

String string


                        DBName

String

The name of the database that was created when the cluster was created.

String string


                        NumberOfNodes

Integer

The number of nodes in the cluster.

Integer integer


                        NodeType

String

The node type of the nodes in the cluster.

String string


                        SnapshotType

String

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

String string


                        ClusterVersion

String

The version ID of the Amazon Redshift engine that is running on the cluster.

String string


                        MasterUsername

String

The master user name for the cluster.

String string


                        ClusterCreateTime

TStamp

The time (UTC) when the cluster was originally created.

TStamp dateTime


                        AvailabilityZone

String

The Availability Zone in which the cluster was created.

String string


                        Port

Integer

The port that the cluster is listening on.

Integer integer


                        Status

String

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".

String string


                        SnapshotCreateTime

TStamp

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.

TStamp dateTime


                        ClusterIdentifier

String

The identifier of the cluster for which the snapshot was taken.

String string


                        SnapshotIdentifier

String

The snapshot identifier that is provided in the request.

String string

480ClusterSnapshotNotFoundFault

Body

Name	Data Type	Description
`ClusterSnapshotNotFoundFault`

481AuthorizationAlreadyExistsFault

Body

Name	Data Type	Description
`AuthorizationAlreadyExistsFault`

482AuthorizationQuotaExceededFault

Body

Name	Data Type	Description
`AuthorizationQuotaExceededFault`

483DependentServiceRequestThrottlingFault

Body

Name	Data Type	Description
`DependentServiceRequestThrottlingFault`

484InvalidClusterSnapshotStateFault

Body

Name	Data Type	Description
`InvalidClusterSnapshotStateFault`

485LimitExceededFault

Body

Name	Data Type	Description
`LimitExceededFault`

POST

/#Action=AuthorizeSnapshotAccess

Authorizes the specified AWS customer account to restore the specified snapshot.

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

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `AuthorizeSnapshotAccess`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`AccountWithRestoreAccess`	string	The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support.
`SnapshotClusterIdentifier`	string	The 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.
`SnapshotIdentifier`	string	The identifier of the snapshot the account is authorized to restore.

Responses

200Success

Body

Name	Data Type	Description
`AuthorizeSnapshotAccessResult`	object

Properties

Snapshot Snapshot


                        Snapshot

object

Describes a snapshot.

Properties


                        SnapshotRetentionStartTime

TStamp

A timestamp representing the start of the retention period for the snapshot.

TStamp dateTime


                        ManualSnapshotRemainingDays

IntegerOptional

The number of days until a manual snapshot will pass its retention period.

IntegerOptional integer


                        ManualSnapshotRetentionPeriod

IntegerOptional

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.

IntegerOptional integer


                        MaintenanceTrackName

String

The name of the maintenance track for the snapshot.

String string


                        EnhancedVpcRouting

Boolean

If this option is true, enhanced VPC routing is enabled.

Default: false

Boolean boolean


                        RestorableNodeTypes

RestorableNodeTypeList

The list of node types that this cluster snapshot is able to restore into.

RestorableNodeTypeList array [String]


                        Tags

TagList

The list of tags for the cluster snapshot.

TagList array [Tag]


                        SourceRegion

String

The source region from which the snapshot was copied.

String string


                        ElapsedTimeInSeconds

Long

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Long integer


                        EstimatedSecondsToCompletion

Long

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Long integer


                        CurrentBackupRateInMegaBytesPerSecond

Double

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Double double


                        BackupProgressInMegaBytes

Double

The number of megabytes that have been transferred to the snapshot backup.

Double double


                        ActualIncrementalBackupSizeInMegaBytes

Double

The size of the incremental backup.

Double double


                        TotalBackupSizeInMegaBytes

Double

The size of the complete set of backup data that would be used to restore the cluster.

Double double


                        OwnerAccount

String

String string


                        AccountsWithRestoreAccess

AccountsWithRestoreAccessList

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

AccountsWithRestoreAccessList array [AccountWithRestoreAccess]


                        EncryptedWithHSM

Boolean

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.

Boolean boolean


                        KmsKeyId

String

The AWS 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.

String string


                        Encrypted

Boolean

If true, the data in the snapshot is encrypted at rest.

Boolean boolean


                        VpcId

String

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

String string


                        DBName

String

The name of the database that was created when the cluster was created.

String string


                        NumberOfNodes

Integer

The number of nodes in the cluster.

Integer integer


                        NodeType

String

The node type of the nodes in the cluster.

String string


                        SnapshotType

String

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

String string


                        ClusterVersion

String

The version ID of the Amazon Redshift engine that is running on the cluster.

String string


                        MasterUsername

String

The master user name for the cluster.

String string


                        ClusterCreateTime

TStamp

The time (UTC) when the cluster was originally created.

TStamp dateTime


                        AvailabilityZone

String

The Availability Zone in which the cluster was created.

String string


                        Port

Integer

The port that the cluster is listening on.

Integer integer


                        Status

String

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".

String string


                        SnapshotCreateTime

TStamp

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.

TStamp dateTime


                        ClusterIdentifier

String

The identifier of the cluster for which the snapshot was taken.

String string


                        SnapshotIdentifier

String

The snapshot identifier that is provided in the request.

String string

480ClusterSnapshotNotFoundFault

Body

Name	Data Type	Description
`ClusterSnapshotNotFoundFault`

481AuthorizationAlreadyExistsFault

Body

Name	Data Type	Description
`AuthorizationAlreadyExistsFault`

482AuthorizationQuotaExceededFault

Body

Name	Data Type	Description
`AuthorizationQuotaExceededFault`

483DependentServiceRequestThrottlingFault

Body

Name	Data Type	Description
`DependentServiceRequestThrottlingFault`

484InvalidClusterSnapshotStateFault

Body

Name	Data Type	Description
`InvalidClusterSnapshotStateFault`

485LimitExceededFault

Body

Name	Data Type	Description
`LimitExceededFault`

GET

/#Action=BatchDeleteClusterSnapshots

Deletes a set of cluster snapshots.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `BatchDeleteClusterSnapshots`
`Identifiers`	array	A list of identifiers for the snapshots that you want to delete.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`BatchDeleteClusterSnapshotsResult`	object

Properties


                        Errors

BatchSnapshotOperationErrorList

A list of any errors returned.

BatchSnapshotOperationErrorList array [SnapshotErrorMessage]


                        SnapshotErrorMessage

object

Describes the errors returned by a snapshot.

Properties

`FailureReason`	String	The text message describing the error.
`FailureCode`	String	The failure code for the error.
`SnapshotClusterIdentifier`	String	A unique identifier for the cluster.
`SnapshotIdentifier`	String	A unique identifier for the snapshot returning the error.


                        Resources

SnapshotIdentifierList

A list of the snapshot identifiers that were deleted.

SnapshotIdentifierList array [String]

String string

480BatchDeleteRequestSizeExceededFault

Body

Name	Data Type	Description
`BatchDeleteRequestSizeExceededFault`

POST

/#Action=BatchDeleteClusterSnapshots

Deletes a set of cluster snapshots.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `BatchDeleteClusterSnapshots`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`Identifiers`	array	A list of identifiers for the snapshots that you want to delete.

Responses

200Success

Body

Name	Data Type	Description
`BatchDeleteClusterSnapshotsResult`	object

Properties


                        Errors

BatchSnapshotOperationErrorList

A list of any errors returned.

BatchSnapshotOperationErrorList array [SnapshotErrorMessage]


                        SnapshotErrorMessage

object

Describes the errors returned by a snapshot.

Properties

`FailureReason`	String	The text message describing the error.
`FailureCode`	String	The failure code for the error.
`SnapshotClusterIdentifier`	String	A unique identifier for the cluster.
`SnapshotIdentifier`	String	A unique identifier for the snapshot returning the error.


                        Resources

SnapshotIdentifierList

A list of the snapshot identifiers that were deleted.

SnapshotIdentifierList array [String]

String string

480BatchDeleteRequestSizeExceededFault

Body

Name	Data Type	Description
`BatchDeleteRequestSizeExceededFault`

GET

/#Action=BatchModifyClusterSnapshots

Modifies the settings for a set of cluster snapshots.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `BatchModifyClusterSnapshots`
`Force`	boolean	A boolean value indicating whether to override an exception if the retention period has passed.
`ManualSnapshotRetentionPeriod`	integer	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.
`SnapshotIdentifierList`	array	A list of snapshot identifiers you want to modify.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`BatchModifyClusterSnapshotsOutputMessage`	object

Properties


                        Errors

BatchSnapshotOperationErrors

A list of any errors returned.

BatchSnapshotOperationErrors array [SnapshotErrorMessage]


                        SnapshotErrorMessage

object

Describes the errors returned by a snapshot.

Properties

`FailureReason`	String	The text message describing the error.
`FailureCode`	String	The failure code for the error.
`SnapshotClusterIdentifier`	String	A unique identifier for the cluster.
`SnapshotIdentifier`	String	A unique identifier for the snapshot returning the error.


                        Resources

SnapshotIdentifierList

A list of the snapshots that were modified.

SnapshotIdentifierList array [String]

String string

480InvalidRetentionPeriodFault

Body

Name	Data Type	Description
`InvalidRetentionPeriodFault`

481BatchModifyClusterSnapshotsLimitExceededFault

Body

Name	Data Type	Description
`BatchModifyClusterSnapshotsLimitExceededFault`

POST

/#Action=BatchModifyClusterSnapshots

Modifies the settings for a set of cluster snapshots.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `BatchModifyClusterSnapshots`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`Force`	boolean	A boolean value indicating whether to override an exception if the retention period has passed.
`ManualSnapshotRetentionPeriod`	integer	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.
`SnapshotIdentifierList`	array	A list of snapshot identifiers you want to modify.

Responses

200Success

Body

Name	Data Type	Description
`BatchModifyClusterSnapshotsOutputMessage`	object

Properties


                        Errors

BatchSnapshotOperationErrors

A list of any errors returned.

BatchSnapshotOperationErrors array [SnapshotErrorMessage]


                        SnapshotErrorMessage

object

Describes the errors returned by a snapshot.

Properties

`FailureReason`	String	The text message describing the error.
`FailureCode`	String	The failure code for the error.
`SnapshotClusterIdentifier`	String	A unique identifier for the cluster.
`SnapshotIdentifier`	String	A unique identifier for the snapshot returning the error.


                        Resources

SnapshotIdentifierList

A list of the snapshots that were modified.

SnapshotIdentifierList array [String]

String string

480InvalidRetentionPeriodFault

Body

Name	Data Type	Description
`InvalidRetentionPeriodFault`

481BatchModifyClusterSnapshotsLimitExceededFault

Body

Name	Data Type	Description
`BatchModifyClusterSnapshotsLimitExceededFault`

GET

/#Action=CancelResize

Cancels a resize operation for a cluster.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CancelResize`
`ClusterIdentifier`	string	The unique identifier for the cluster that you want to cancel a resize operation for.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`ResizeProgressMessage`	object	Describes the result of a cluster resize operation.

Properties


                        DataTransferProgressPercent

DoubleOptional

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

DoubleOptional double


                        TargetEncryptionType

String

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None. In the China region possible values are: Legacy and None.

String string


                        Message

String

An optional string to provide additional details about the resize action.

String string


                        ResizeType

String

An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

String string


                        EstimatedTimeToCompletionInSeconds

LongOptional

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.

LongOptional integer


                        ElapsedTimeInSeconds

LongOptional

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.

LongOptional integer


                        ProgressInMegaBytes

LongOptional

While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

LongOptional integer


                        TotalResizeDataInMegaBytes

LongOptional

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

LongOptional integer


                        AvgResizeRateInMegaBytesPerSecond

DoubleOptional

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.

DoubleOptional double


                        ImportTablesNotStarted

ImportTablesNotStarted

The names of tables that have not been yet imported.

Valid Values: List of table names

ImportTablesNotStarted array [String]

String string


                        ImportTablesInProgress

ImportTablesInProgress

The names of tables that are being currently imported.

Valid Values: List of table names.

ImportTablesInProgress array [String]

String string


                        ImportTablesCompleted

ImportTablesCompleted

The names of tables that have been completely imported .

Valid Values: List of table names.

ImportTablesCompleted array [String]

String string


                        Status

String

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

String string


                        TargetClusterType

String

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

String string


                        TargetNumberOfNodes

IntegerOptional

The number of nodes that the cluster will have after the resize operation is complete.

IntegerOptional integer


                        TargetNodeType

String

The node type that the cluster will have after the resize operation is complete.

String string

480ClusterNotFoundFault

Body

Name	Data Type	Description
`ClusterNotFoundFault`

481ResizeNotFoundFault

Body

Name	Data Type	Description
`ResizeNotFoundFault`

482InvalidClusterStateFault

Body

Name	Data Type	Description
`InvalidClusterStateFault`

483UnsupportedOperationFault

Body

Name	Data Type	Description
`UnsupportedOperationFault`

POST

/#Action=CancelResize

Cancels a resize operation for a cluster.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CancelResize`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`ClusterIdentifier`	string	The unique identifier for the cluster that you want to cancel a resize operation for.

Responses

200Success

Body

Name	Data Type	Description
`ResizeProgressMessage`	object	Describes the result of a cluster resize operation.

Properties


                        DataTransferProgressPercent

DoubleOptional

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

DoubleOptional double


                        TargetEncryptionType

String

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None. In the China region possible values are: Legacy and None.

String string


                        Message

String

An optional string to provide additional details about the resize action.

String string


                        ResizeType

String

An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

String string


                        EstimatedTimeToCompletionInSeconds

LongOptional

LongOptional integer


                        ElapsedTimeInSeconds

LongOptional

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.

LongOptional integer


                        ProgressInMegaBytes

LongOptional

LongOptional integer


                        TotalResizeDataInMegaBytes

LongOptional

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

LongOptional integer


                        AvgResizeRateInMegaBytesPerSecond

DoubleOptional

DoubleOptional double


                        ImportTablesNotStarted

ImportTablesNotStarted

The names of tables that have not been yet imported.

Valid Values: List of table names

ImportTablesNotStarted array [String]

String string


                        ImportTablesInProgress

ImportTablesInProgress

The names of tables that are being currently imported.

Valid Values: List of table names.

ImportTablesInProgress array [String]

String string


                        ImportTablesCompleted

ImportTablesCompleted

The names of tables that have been completely imported .

Valid Values: List of table names.

ImportTablesCompleted array [String]

String string


                        Status

String

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

String string


                        TargetClusterType

String

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

String string


                        TargetNumberOfNodes

IntegerOptional

The number of nodes that the cluster will have after the resize operation is complete.

IntegerOptional integer


                        TargetNodeType

String

The node type that the cluster will have after the resize operation is complete.

String string

480ClusterNotFoundFault

Body

Name	Data Type	Description
`ClusterNotFoundFault`

481ResizeNotFoundFault

Body

Name	Data Type	Description
`ResizeNotFoundFault`

482InvalidClusterStateFault

Body

Name	Data Type	Description
`InvalidClusterStateFault`

483UnsupportedOperationFault

Body

Name	Data Type	Description
`UnsupportedOperationFault`

GET

/#Action=CopyClusterSnapshot

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

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

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CopyClusterSnapshot`
`ManualSnapshotRetentionPeriod`	integer	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.
`TargetSnapshotIdentifier`	string	The identifier given to the new manual snapshot. 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. Must be unique for the AWS account that is making the request.
`SourceSnapshotClusterIdentifier`	string	The identifier of the cluster the source 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 identifier for a valid cluster.
`SourceSnapshotIdentifier`	string	The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is `available`.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`CopyClusterSnapshotResult`	object

Properties

Snapshot Snapshot


                        Snapshot

object

Describes a snapshot.

Properties


                        SnapshotRetentionStartTime

TStamp

A timestamp representing the start of the retention period for the snapshot.

TStamp dateTime


                        ManualSnapshotRemainingDays

IntegerOptional

The number of days until a manual snapshot will pass its retention period.

IntegerOptional integer


                        ManualSnapshotRetentionPeriod

IntegerOptional

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.

IntegerOptional integer


                        MaintenanceTrackName

String

The name of the maintenance track for the snapshot.

String string


                        EnhancedVpcRouting

Boolean

If this option is true, enhanced VPC routing is enabled.

Default: false

Boolean boolean


                        RestorableNodeTypes

RestorableNodeTypeList

The list of node types that this cluster snapshot is able to restore into.

RestorableNodeTypeList array [String]


                        Tags

TagList

The list of tags for the cluster snapshot.

TagList array [Tag]


                        SourceRegion

String

The source region from which the snapshot was copied.

String string


                        ElapsedTimeInSeconds

Long

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Long integer


                        EstimatedSecondsToCompletion

Long

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Long integer


                        CurrentBackupRateInMegaBytesPerSecond

Double

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Double double


                        BackupProgressInMegaBytes

Double

The number of megabytes that have been transferred to the snapshot backup.

Double double


                        ActualIncrementalBackupSizeInMegaBytes

Double

The size of the incremental backup.

Double double


                        TotalBackupSizeInMegaBytes

Double

The size of the complete set of backup data that would be used to restore the cluster.

Double double


                        OwnerAccount

String

String string


                        AccountsWithRestoreAccess

AccountsWithRestoreAccessList

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

AccountsWithRestoreAccessList array [AccountWithRestoreAccess]


                        EncryptedWithHSM

Boolean

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.

Boolean boolean


                        KmsKeyId

String

The AWS 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.

String string


                        Encrypted

Boolean

If true, the data in the snapshot is encrypted at rest.

Boolean boolean


                        VpcId

String

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

String string


                        DBName

String

The name of the database that was created when the cluster was created.

String string


                        NumberOfNodes

Integer

The number of nodes in the cluster.

Integer integer


                        NodeType

String

The node type of the nodes in the cluster.

String string


                        SnapshotType

String

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

String string


                        ClusterVersion

String

The version ID of the Amazon Redshift engine that is running on the cluster.

String string


                        MasterUsername

String

The master user name for the cluster.

String string


                        ClusterCreateTime

TStamp

The time (UTC) when the cluster was originally created.

TStamp dateTime


                        AvailabilityZone

String

The Availability Zone in which the cluster was created.

String string


                        Port

Integer

The port that the cluster is listening on.

Integer integer


                        Status

String

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".

String string


                        SnapshotCreateTime

TStamp

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.

TStamp dateTime


                        ClusterIdentifier

String

The identifier of the cluster for which the snapshot was taken.

String string


                        SnapshotIdentifier

String

The snapshot identifier that is provided in the request.

String string

480ClusterSnapshotAlreadyExistsFault

Body

Name	Data Type	Description
`ClusterSnapshotAlreadyExistsFault`

481ClusterSnapshotNotFoundFault

Body

Name	Data Type	Description
`ClusterSnapshotNotFoundFault`

482InvalidClusterSnapshotStateFault

Body

Name	Data Type	Description
`InvalidClusterSnapshotStateFault`

483ClusterSnapshotQuotaExceededFault

Body

Name	Data Type	Description
`ClusterSnapshotQuotaExceededFault`

484InvalidRetentionPeriodFault

Body

Name	Data Type	Description
`InvalidRetentionPeriodFault`

POST

/#Action=CopyClusterSnapshot

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it 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.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CopyClusterSnapshot`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`ManualSnapshotRetentionPeriod`	integer	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.
`TargetSnapshotIdentifier`	string	The identifier given to the new manual snapshot. 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. Must be unique for the AWS account that is making the request.
`SourceSnapshotClusterIdentifier`	string	The identifier of the cluster the source 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 identifier for a valid cluster.
`SourceSnapshotIdentifier`	string	The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is `available`.

Responses

200Success

Body

Name	Data Type	Description
`CopyClusterSnapshotResult`	object

Properties

Snapshot Snapshot


                        Snapshot

object

Describes a snapshot.

Properties


                        SnapshotRetentionStartTime

TStamp

A timestamp representing the start of the retention period for the snapshot.

TStamp dateTime


                        ManualSnapshotRemainingDays

IntegerOptional

The number of days until a manual snapshot will pass its retention period.

IntegerOptional integer


                        ManualSnapshotRetentionPeriod

IntegerOptional

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.

IntegerOptional integer


                        MaintenanceTrackName

String

The name of the maintenance track for the snapshot.

String string


                        EnhancedVpcRouting

Boolean

If this option is true, enhanced VPC routing is enabled.

Default: false

Boolean boolean


                        RestorableNodeTypes

RestorableNodeTypeList

The list of node types that this cluster snapshot is able to restore into.

RestorableNodeTypeList array [String]


                        Tags

TagList

The list of tags for the cluster snapshot.

TagList array [Tag]


                        SourceRegion

String

The source region from which the snapshot was copied.

String string


                        ElapsedTimeInSeconds

Long

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Long integer


                        EstimatedSecondsToCompletion

Long

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Long integer


                        CurrentBackupRateInMegaBytesPerSecond

Double

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Double double


                        BackupProgressInMegaBytes

Double

The number of megabytes that have been transferred to the snapshot backup.

Double double


                        ActualIncrementalBackupSizeInMegaBytes

Double

The size of the incremental backup.

Double double


                        TotalBackupSizeInMegaBytes

Double

The size of the complete set of backup data that would be used to restore the cluster.

Double double


                        OwnerAccount

String

String string


                        AccountsWithRestoreAccess

AccountsWithRestoreAccessList

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

AccountsWithRestoreAccessList array [AccountWithRestoreAccess]


                        EncryptedWithHSM

Boolean

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.

Boolean boolean


                        KmsKeyId

String

The AWS 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.

String string


                        Encrypted

Boolean

If true, the data in the snapshot is encrypted at rest.

Boolean boolean


                        VpcId

String

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

String string


                        DBName

String

The name of the database that was created when the cluster was created.

String string


                        NumberOfNodes

Integer

The number of nodes in the cluster.

Integer integer


                        NodeType

String

The node type of the nodes in the cluster.

String string


                        SnapshotType

String

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

String string


                        ClusterVersion

String

The version ID of the Amazon Redshift engine that is running on the cluster.

String string


                        MasterUsername

String

The master user name for the cluster.

String string


                        ClusterCreateTime

TStamp

The time (UTC) when the cluster was originally created.

TStamp dateTime


                        AvailabilityZone

String

The Availability Zone in which the cluster was created.

String string


                        Port

Integer

The port that the cluster is listening on.

Integer integer


                        Status

String

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".

String string


                        SnapshotCreateTime

TStamp

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.

TStamp dateTime


                        ClusterIdentifier

String

The identifier of the cluster for which the snapshot was taken.

String string


                        SnapshotIdentifier

String

The snapshot identifier that is provided in the request.

String string

480ClusterSnapshotAlreadyExistsFault

Body

Name	Data Type	Description
`ClusterSnapshotAlreadyExistsFault`

481ClusterSnapshotNotFoundFault

Body

Name	Data Type	Description
`ClusterSnapshotNotFoundFault`

482InvalidClusterSnapshotStateFault

Body

Name	Data Type	Description
`InvalidClusterSnapshotStateFault`

483ClusterSnapshotQuotaExceededFault

Body

Name	Data Type	Description
`ClusterSnapshotQuotaExceededFault`

484InvalidRetentionPeriodFault

Body

Name	Data Type	Description
`InvalidRetentionPeriodFault`

GET

/#Action=CreateCluster

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CreateCluster`
`SnapshotScheduleIdentifier`	string	A unique identifier for the snapshot schedule.
`MaintenanceTrackName`	string	An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the `current` track.
`IamRoles`	array	A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time.
`AdditionalInfo`	string	Reserved.
`EnhancedVpcRouting`	boolean	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
`KmsKeyId`	string	The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
`Tags`	array	A list of tag instances.
`ElasticIp`	string	The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
`HsmConfigurationIdentifier`	string	Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
`HsmClientCertificateIdentifier`	string	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
`Encrypted`	boolean	If `true`, the data in the cluster is encrypted at rest. Default: false
`PubliclyAccessible`	boolean	If `true`, the cluster can be accessed from a public network.
`NumberOfNodes`	integer	The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as `multi-node`. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: `1` Constraints: Value must be at least 1 and no more than 100.
`AllowVersionUpgrade`	boolean	If `true`, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: `true`
`ClusterVersion`	string	The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: `1.0`
`Port`	integer	The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: `5439` Valid Values: `1150-65535`
`ManualSnapshotRetentionPeriod`	integer	The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
`AutomatedSnapshotRetentionPeriod`	integer	The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: `1` Constraints: Must be a value from 0 to 35.
`ClusterParameterGroupName`	string	The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
`PreferredMaintenanceWindow`	string	The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: `ddd:hh24:mi-ddd:hh24:mi` Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun Constraints: Minimum 30-minute window.
`AvailabilityZone`	string	The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: `us-east-2d` Constraint: The specified Availability Zone must be in the same region as the current endpoint.
`ClusterSubnetGroupName`	string	The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
`VpcSecurityGroupIds`	array	A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.
`ClusterSecurityGroups`	array	A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
`MasterUserPassword`	string	The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
`MasterUsername`	string	The user name associated with the master user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters. The user name can't be `PUBLIC`. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
`NodeType`	string	The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: `ds2.xlarge` \| `ds2.8xlarge` \| `dc1.large` \| `dc1.8xlarge` \| `dc2.large` \| `dc2.8xlarge` \| `ra3.16xlarge`
`ClusterType`	string	The type of the cluster. When cluster type is specified as `single-node`, the NumberOfNodes parameter is not required. `multi-node`, the NumberOfNodes parameter is required. Valid Values: `multi-node` \| `single-node` Default: `multi-node`
`ClusterIdentifier`	string	A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: `myexamplecluster`
`DBName`	string	The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: `dev` Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`CreateClusterResult`	object

Properties

Cluster Cluster


                        Cluster

object

Describes a cluster.

Properties


                        ResizeInfo

ResizeInfo

Returns the following:

AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize


                        ResizeInfo

object

Describes a resize operation.

Properties

`AllowCancelResize`	Boolean	A boolean value indicating if the resize operation can be cancelled.
`ResizeType`	String	Returns the value `ClassicResize`.


                        NextMaintenanceWindowStartTime

TStamp

The date and time in UTC when system maintenance can begin.

TStamp dateTime


                        ExpectedNextSnapshotScheduleTimeStatus

String

The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.

String string


                        ExpectedNextSnapshotScheduleTime

TStamp

The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

TStamp dateTime


                        SnapshotScheduleState

ScheduleState

The current state of the cluster snapshot schedule.

ScheduleState string
Allowed values:
- MODIFYING
- ACTIVE
- FAILED


                        SnapshotScheduleIdentifier

String

A unique identifier for the cluster snapshot schedule.

String string


                        DeferredMaintenanceWindows

DeferredMaintenanceWindowsList

Describes a group of DeferredMaintenanceWindow objects.

DeferredMaintenanceWindowsList array [DeferredMaintenanceWindow]


                        ElasticResizeNumberOfNodeOptions

String

The number of nodes that you can resize the cluster to with the elastic resize method.

String string


                        MaintenanceTrackName

String

The name of the maintenance track for the cluster.

String string


                        PendingActions

PendingActionsList

Cluster operations that are waiting to be started.

PendingActionsList array [String]


                        IamRoles

ClusterIamRoleList

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

ClusterIamRoleList array [ClusterIamRole]


                        EnhancedVpcRouting

Boolean

If this option is true, enhanced VPC routing is enabled.

Default: false

Boolean boolean


                        KmsKeyId

String

The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

String string


                        Tags

TagList

The list of tags for the cluster.

TagList array [Tag]


                        ClusterRevisionNumber

String

The specific revision number of the database in the cluster.

String string


                        ElasticIpStatus

ElasticIpStatus

The status of the elastic IP (EIP) address.


                        ElasticIpStatus

object

Describes the status of the elastic IP (EIP) address.

Properties

`Status`	String	The status of the elastic IP (EIP) address.
`ElasticIp`	String	The elastic IP (EIP) address for the cluster.


                        ClusterNodes

ClusterNodesList

The nodes in the cluster.

ClusterNodesList array [ClusterNode]


                        ClusterPublicKey

String

The public key for the cluster.

String string


                        ClusterSnapshotCopyStatus

ClusterSnapshotCopyStatus

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.


                        ClusterSnapshotCopyStatus

object

Returns the destination region and retention period that are configured for cross-region snapshot copy.

Properties

`SnapshotCopyGrantName`	String	The name of the snapshot copy grant.
`ManualSnapshotRetentionPeriod`	Integer	The number of days that automated snapshots are retained in the destination region after they are copied from a source region. 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.
`RetentionPeriod`	Long	The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
`DestinationRegion`	String	The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.


                        HsmStatus

HsmStatus

A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

Values: active, applying


                        HsmStatus

object

Describes the status of changes to HSM settings.

Properties

`Status`	String	Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying
`HsmConfigurationIdentifier`	String	Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
`HsmClientCertificateIdentifier`	String	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.


                        DataTransferProgress

DataTransferProgress


                        DataTransferProgress

object

Describes the status of a cluster while it is in the process of resizing with an incremental resize.

Properties

`ElapsedTimeInSeconds`	LongOptional	Describes the number of seconds that have elapsed during the data transfer.
`EstimatedTimeToCompletionInSeconds`	LongOptional	Describes the estimated number of seconds remaining to complete the transfer.
`DataTransferredInMegaBytes`	Long	Describes the total amount of data that has been transfered in MB's.
`TotalDataInMegaBytes`	Long	Describes the total amount of data to be transfered in megabytes.
`CurrentRateInMegaBytesPerSecond`	DoubleOptional	Describes the data transfer rate in MB's per second.
`Status`	String	Describes the status of the cluster. While the transfer is in progress the status is `transferringdata`.


                        RestoreStatus

RestoreStatus

A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.


                        RestoreStatus

object

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

Properties

`EstimatedTimeToCompletionInSeconds`	Long	The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
`ElapsedTimeInSeconds`	Long	The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.
`ProgressInMegaBytes`	Long	The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
`SnapshotSizeInMegaBytes`	Long	The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
`CurrentRestoreRateInMegaBytesPerSecond`	Double	The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.
`Status`	String	The status of the restore action. Returns starting, restoring, completed, or failed.


                        Encrypted

Boolean

A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

Boolean boolean


                        PubliclyAccessible

Boolean

A boolean value that, if true, indicates that the cluster can be accessed from a public network.

Boolean boolean


                        NumberOfNodes

Integer

The number of compute nodes in the cluster.

Integer integer


                        AllowVersionUpgrade

Boolean

A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

Boolean boolean


                        ClusterVersion

String

The version ID of the Amazon Redshift engine that is running on the cluster.

String string


                        PendingModifiedValues

PendingModifiedValues

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.


                        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.

Properties

`EncryptionType`	String	The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
`MaintenanceTrackName`	String	The name of the maintenance track that the cluster will change to during the next maintenance window.
`EnhancedVpcRouting`	BooleanOptional	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
`PubliclyAccessible`	BooleanOptional	The pending or in-progress change of the ability to connect to the cluster from the public network.
`ClusterIdentifier`	String	The pending or in-progress change of the new identifier for the cluster.
`AutomatedSnapshotRetentionPeriod`	IntegerOptional	The pending or in-progress change of the automated snapshot retention period.
`ClusterVersion`	String	The pending or in-progress change of the service version.
`ClusterType`	String	The pending or in-progress change of the cluster type.
`NumberOfNodes`	IntegerOptional	The pending or in-progress change of the number of nodes in the cluster.
`NodeType`	String	The pending or in-progress change of the cluster's node type.
`MasterUserPassword`	String	The pending or in-progress change of the master user password for the cluster.


                        PreferredMaintenanceWindow

String

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

String string


                        AvailabilityZone

String

The name of the Availability Zone in which the cluster is located.

String string


                        VpcId

String

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

String string


                        ClusterSubnetGroupName

String

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

String string


                        ClusterParameterGroups

ClusterParameterGroupStatusList

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

ClusterParameterGroupStatusList array [ClusterParameterGroupStatus]


                        VpcSecurityGroups

VpcSecurityGroupMembershipList

A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

VpcSecurityGroupMembershipList array [VpcSecurityGroupMembership]


                        ClusterSecurityGroups

ClusterSecurityGroupMembershipList

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

ClusterSecurityGroupMembershipList array [ClusterSecurityGroupMembership]


                        ManualSnapshotRetentionPeriod

Integer

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

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

Integer integer


                        AutomatedSnapshotRetentionPeriod

Integer

The number of days that automatic cluster snapshots are retained.

Integer integer


                        ClusterCreateTime

TStamp

The date and time that the cluster was created.

TStamp dateTime


                        Endpoint

Endpoint

The connection endpoint.


                        Endpoint

object

Describes a connection endpoint.

Properties

`Port`	Integer	The port that the database engine is listening on.
`Address`	String	The DNS address of the Cluster.


                        DBName

String

The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

String string


                        MasterUsername

String

The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

String string


                        ModifyStatus

String

The status of a modify operation, if any, initiated for the cluster.

String string


                        ClusterAvailabilityStatus

String

The availability status of the cluster for queries. Possible values are the following:

Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.

String string


                        ClusterStatus

String

The current state of the cluster. Possible values are the following:

available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm

String string


                        NodeType

String

The node type for the nodes in the cluster.

String string


                        ClusterIdentifier

String

The unique identifier of the cluster.

String string

480ClusterAlreadyExistsFault

Body

Name	Data Type	Description
`ClusterAlreadyExistsFault`

481InsufficientClusterCapacityFault

Body

Name	Data Type	Description
`InsufficientClusterCapacityFault`

482ClusterParameterGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterParameterGroupNotFoundFault`

483ClusterSecurityGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterSecurityGroupNotFoundFault`

484ClusterQuotaExceededFault

Body

Name	Data Type	Description
`ClusterQuotaExceededFault`

485NumberOfNodesQuotaExceededFault

Body

Name	Data Type	Description
`NumberOfNodesQuotaExceededFault`

486NumberOfNodesPerClusterLimitExceededFault

Body

Name	Data Type	Description
`NumberOfNodesPerClusterLimitExceededFault`

487ClusterSubnetGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterSubnetGroupNotFoundFault`

488InvalidVPCNetworkStateFault

Body

Name	Data Type	Description
`InvalidVPCNetworkStateFault`

489InvalidClusterSubnetGroupStateFault

Body

Name	Data Type	Description
`InvalidClusterSubnetGroupStateFault`

490InvalidSubnet

Body

Name	Data Type	Description
`InvalidSubnet`

491UnauthorizedOperation

Body

Name	Data Type	Description
`UnauthorizedOperation`

492HsmClientCertificateNotFoundFault

Body

Name	Data Type	Description
`HsmClientCertificateNotFoundFault`

493HsmConfigurationNotFoundFault

Body

Name	Data Type	Description
`HsmConfigurationNotFoundFault`

494InvalidElasticIpFault

Body

Name	Data Type	Description
`InvalidElasticIpFault`

495TagLimitExceededFault

Body

Name	Data Type	Description
`TagLimitExceededFault`

496InvalidTagFault

Body

Name	Data Type	Description
`InvalidTagFault`

497LimitExceededFault

Body

Name	Data Type	Description
`LimitExceededFault`

498DependentServiceRequestThrottlingFault

Body

Name	Data Type	Description
`DependentServiceRequestThrottlingFault`

499InvalidClusterTrackFault

Body

Name	Data Type	Description
`InvalidClusterTrackFault`

500SnapshotScheduleNotFoundFault

Body

Name	Data Type	Description
`SnapshotScheduleNotFoundFault`

501InvalidRetentionPeriodFault

Body

Name	Data Type	Description
`InvalidRetentionPeriodFault`

POST

/#Action=CreateCluster

Creates a new cluster with the specified parameters.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CreateCluster`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`SnapshotScheduleIdentifier`	string	A unique identifier for the snapshot schedule.
`MaintenanceTrackName`	string	An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the `current` track.
`IamRoles`	array	A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time.
`AdditionalInfo`	string	Reserved.
`EnhancedVpcRouting`	boolean	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
`KmsKeyId`	string	The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
`Tags`	array	A list of tag instances.
`ElasticIp`	string	The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
`HsmConfigurationIdentifier`	string	Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
`HsmClientCertificateIdentifier`	string	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
`Encrypted`	boolean	If `true`, the data in the cluster is encrypted at rest. Default: false
`PubliclyAccessible`	boolean	If `true`, the cluster can be accessed from a public network.
`NumberOfNodes`	integer	The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as `multi-node`. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: `1` Constraints: Value must be at least 1 and no more than 100.
`AllowVersionUpgrade`	boolean	If `true`, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: `true`
`ClusterVersion`	string	The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: `1.0`
`Port`	integer	The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: `5439` Valid Values: `1150-65535`
`ManualSnapshotRetentionPeriod`	integer	The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
`AutomatedSnapshotRetentionPeriod`	integer	The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: `1` Constraints: Must be a value from 0 to 35.
`ClusterParameterGroupName`	string	The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
`PreferredMaintenanceWindow`	string	The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: `ddd:hh24:mi-ddd:hh24:mi` Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun Constraints: Minimum 30-minute window.
`AvailabilityZone`	string	The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: `us-east-2d` Constraint: The specified Availability Zone must be in the same region as the current endpoint.
`ClusterSubnetGroupName`	string	The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
`VpcSecurityGroupIds`	array	A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.
`ClusterSecurityGroups`	array	A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
`MasterUserPassword`	string	The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
`MasterUsername`	string	The user name associated with the master user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters. The user name can't be `PUBLIC`. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
`NodeType`	string	The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: `ds2.xlarge` \| `ds2.8xlarge` \| `dc1.large` \| `dc1.8xlarge` \| `dc2.large` \| `dc2.8xlarge` \| `ra3.16xlarge`
`ClusterType`	string	The type of the cluster. When cluster type is specified as `single-node`, the NumberOfNodes parameter is not required. `multi-node`, the NumberOfNodes parameter is required. Valid Values: `multi-node` \| `single-node` Default: `multi-node`
`ClusterIdentifier`	string	A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: `myexamplecluster`
`DBName`	string	The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: `dev` Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Responses

200Success

Body

Name	Data Type	Description
`CreateClusterResult`	object

Properties

Cluster Cluster


                        Cluster

object

Describes a cluster.

Properties


                        ResizeInfo

ResizeInfo

Returns the following:

AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize


                        ResizeInfo

object

Describes a resize operation.

Properties

`AllowCancelResize`	Boolean	A boolean value indicating if the resize operation can be cancelled.
`ResizeType`	String	Returns the value `ClassicResize`.


                        NextMaintenanceWindowStartTime

TStamp

The date and time in UTC when system maintenance can begin.

TStamp dateTime


                        ExpectedNextSnapshotScheduleTimeStatus

String

The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.

String string


                        ExpectedNextSnapshotScheduleTime

TStamp

The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

TStamp dateTime


                        SnapshotScheduleState

ScheduleState

The current state of the cluster snapshot schedule.

ScheduleState string
Allowed values:
- MODIFYING
- ACTIVE
- FAILED


                        SnapshotScheduleIdentifier

String

A unique identifier for the cluster snapshot schedule.

String string


                        DeferredMaintenanceWindows

DeferredMaintenanceWindowsList

Describes a group of DeferredMaintenanceWindow objects.

DeferredMaintenanceWindowsList array [DeferredMaintenanceWindow]


                        ElasticResizeNumberOfNodeOptions

String

The number of nodes that you can resize the cluster to with the elastic resize method.

String string


                        MaintenanceTrackName

String

The name of the maintenance track for the cluster.

String string


                        PendingActions

PendingActionsList

Cluster operations that are waiting to be started.

PendingActionsList array [String]


                        IamRoles

ClusterIamRoleList

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

ClusterIamRoleList array [ClusterIamRole]


                        EnhancedVpcRouting

Boolean

If this option is true, enhanced VPC routing is enabled.

Default: false

Boolean boolean


                        KmsKeyId

String

The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

String string


                        Tags

TagList

The list of tags for the cluster.

TagList array [Tag]


                        ClusterRevisionNumber

String

The specific revision number of the database in the cluster.

String string


                        ElasticIpStatus

ElasticIpStatus

The status of the elastic IP (EIP) address.


                        ElasticIpStatus

object

Describes the status of the elastic IP (EIP) address.

Properties

`Status`	String	The status of the elastic IP (EIP) address.
`ElasticIp`	String	The elastic IP (EIP) address for the cluster.


                        ClusterNodes

ClusterNodesList

The nodes in the cluster.

ClusterNodesList array [ClusterNode]


                        ClusterPublicKey

String

The public key for the cluster.

String string


                        ClusterSnapshotCopyStatus

ClusterSnapshotCopyStatus

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.


                        ClusterSnapshotCopyStatus

object

Returns the destination region and retention period that are configured for cross-region snapshot copy.

Properties

`SnapshotCopyGrantName`	String	The name of the snapshot copy grant.
`ManualSnapshotRetentionPeriod`	Integer	The number of days that automated snapshots are retained in the destination region after they are copied from a source region. 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.
`RetentionPeriod`	Long	The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
`DestinationRegion`	String	The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.


                        HsmStatus

HsmStatus

A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

Values: active, applying


                        HsmStatus

object

Describes the status of changes to HSM settings.

Properties

`Status`	String	Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying
`HsmConfigurationIdentifier`	String	Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
`HsmClientCertificateIdentifier`	String	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.


                        DataTransferProgress

DataTransferProgress


                        DataTransferProgress

object

Describes the status of a cluster while it is in the process of resizing with an incremental resize.

Properties

`ElapsedTimeInSeconds`	LongOptional	Describes the number of seconds that have elapsed during the data transfer.
`EstimatedTimeToCompletionInSeconds`	LongOptional	Describes the estimated number of seconds remaining to complete the transfer.
`DataTransferredInMegaBytes`	Long	Describes the total amount of data that has been transfered in MB's.
`TotalDataInMegaBytes`	Long	Describes the total amount of data to be transfered in megabytes.
`CurrentRateInMegaBytesPerSecond`	DoubleOptional	Describes the data transfer rate in MB's per second.
`Status`	String	Describes the status of the cluster. While the transfer is in progress the status is `transferringdata`.


                        RestoreStatus

RestoreStatus

A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.


                        RestoreStatus

object

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

Properties

`EstimatedTimeToCompletionInSeconds`	Long	The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
`ElapsedTimeInSeconds`	Long	The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.
`ProgressInMegaBytes`	Long	The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
`SnapshotSizeInMegaBytes`	Long	The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
`CurrentRestoreRateInMegaBytesPerSecond`	Double	The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.
`Status`	String	The status of the restore action. Returns starting, restoring, completed, or failed.


                        Encrypted

Boolean

A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

Boolean boolean


                        PubliclyAccessible

Boolean

A boolean value that, if true, indicates that the cluster can be accessed from a public network.

Boolean boolean


                        NumberOfNodes

Integer

The number of compute nodes in the cluster.

Integer integer


                        AllowVersionUpgrade

Boolean

A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

Boolean boolean


                        ClusterVersion

String

The version ID of the Amazon Redshift engine that is running on the cluster.

String string


                        PendingModifiedValues

PendingModifiedValues

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.


                        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.

Properties

`EncryptionType`	String	The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
`MaintenanceTrackName`	String	The name of the maintenance track that the cluster will change to during the next maintenance window.
`EnhancedVpcRouting`	BooleanOptional	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
`PubliclyAccessible`	BooleanOptional	The pending or in-progress change of the ability to connect to the cluster from the public network.
`ClusterIdentifier`	String	The pending or in-progress change of the new identifier for the cluster.
`AutomatedSnapshotRetentionPeriod`	IntegerOptional	The pending or in-progress change of the automated snapshot retention period.
`ClusterVersion`	String	The pending or in-progress change of the service version.
`ClusterType`	String	The pending or in-progress change of the cluster type.
`NumberOfNodes`	IntegerOptional	The pending or in-progress change of the number of nodes in the cluster.
`NodeType`	String	The pending or in-progress change of the cluster's node type.
`MasterUserPassword`	String	The pending or in-progress change of the master user password for the cluster.


                        PreferredMaintenanceWindow

String

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

String string


                        AvailabilityZone

String

The name of the Availability Zone in which the cluster is located.

String string


                        VpcId

String

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

String string


                        ClusterSubnetGroupName

String

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

String string


                        ClusterParameterGroups

ClusterParameterGroupStatusList

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

ClusterParameterGroupStatusList array [ClusterParameterGroupStatus]


                        VpcSecurityGroups

VpcSecurityGroupMembershipList

A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

VpcSecurityGroupMembershipList array [VpcSecurityGroupMembership]


                        ClusterSecurityGroups

ClusterSecurityGroupMembershipList

ClusterSecurityGroupMembershipList array [ClusterSecurityGroupMembership]


                        ManualSnapshotRetentionPeriod

Integer

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

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

Integer integer


                        AutomatedSnapshotRetentionPeriod

Integer

The number of days that automatic cluster snapshots are retained.

Integer integer


                        ClusterCreateTime

TStamp

The date and time that the cluster was created.

TStamp dateTime


                        Endpoint

Endpoint

The connection endpoint.


                        Endpoint

object

Describes a connection endpoint.

Properties

`Port`	Integer	The port that the database engine is listening on.
`Address`	String	The DNS address of the Cluster.


                        DBName

String

String string


                        MasterUsername

String

The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

String string


                        ModifyStatus

String

The status of a modify operation, if any, initiated for the cluster.

String string


                        ClusterAvailabilityStatus

String

The availability status of the cluster for queries. Possible values are the following:

Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.

String string


                        ClusterStatus

String

The current state of the cluster. Possible values are the following:

available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm

String string


                        NodeType

String

The node type for the nodes in the cluster.

String string


                        ClusterIdentifier

String

The unique identifier of the cluster.

String string

480ClusterAlreadyExistsFault

Body

Name	Data Type	Description
`ClusterAlreadyExistsFault`

481InsufficientClusterCapacityFault

Body

Name	Data Type	Description
`InsufficientClusterCapacityFault`

482ClusterParameterGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterParameterGroupNotFoundFault`

483ClusterSecurityGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterSecurityGroupNotFoundFault`

484ClusterQuotaExceededFault

Body

Name	Data Type	Description
`ClusterQuotaExceededFault`

485NumberOfNodesQuotaExceededFault

Body

Name	Data Type	Description
`NumberOfNodesQuotaExceededFault`

486NumberOfNodesPerClusterLimitExceededFault

Body

Name	Data Type	Description
`NumberOfNodesPerClusterLimitExceededFault`

487ClusterSubnetGroupNotFoundFault

Body

Name	Data Type	Description
`ClusterSubnetGroupNotFoundFault`

488InvalidVPCNetworkStateFault

Body

Name	Data Type	Description
`InvalidVPCNetworkStateFault`

489InvalidClusterSubnetGroupStateFault

Body

Name	Data Type	Description
`InvalidClusterSubnetGroupStateFault`

490InvalidSubnet

Body

Name	Data Type	Description
`InvalidSubnet`

491UnauthorizedOperation

Body

Name	Data Type	Description
`UnauthorizedOperation`

492HsmClientCertificateNotFoundFault

Body

Name	Data Type	Description
`HsmClientCertificateNotFoundFault`

493HsmConfigurationNotFoundFault

Body

Name	Data Type	Description
`HsmConfigurationNotFoundFault`

494InvalidElasticIpFault

Body

Name	Data Type	Description
`InvalidElasticIpFault`

495TagLimitExceededFault

Body

Name	Data Type	Description
`TagLimitExceededFault`

496InvalidTagFault

Body

Name	Data Type	Description
`InvalidTagFault`

497LimitExceededFault

Body

Name	Data Type	Description
`LimitExceededFault`

498DependentServiceRequestThrottlingFault

Body

Name	Data Type	Description
`DependentServiceRequestThrottlingFault`

499InvalidClusterTrackFault

Body

Name	Data Type	Description
`InvalidClusterTrackFault`

500SnapshotScheduleNotFoundFault

Body

Name	Data Type	Description
`SnapshotScheduleNotFoundFault`

501InvalidRetentionPeriodFault

Body

Name	Data Type	Description
`InvalidRetentionPeriodFault`

GET

/#Action=CreateClusterParameterGroup

Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CreateClusterParameterGroup`
`Tags`	array	A list of tag instances.
`Description`	string	A description of the parameter group.
`ParameterGroupFamily`	string	The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
`ParameterGroupName`	string	The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. This value is stored as a lower-case string.

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Responses

200Success

Body

Name	Data Type	Description
`CreateClusterParameterGroupResult`	object

Properties

ClusterParameterGroup ClusterParameterGroup


                        ClusterParameterGroup

object

Describes a parameter group.

Properties


                        Tags

TagList

The list of tags for the cluster parameter group.

TagList array [Tag]


                        Description

String

The description of the parameter group.

String string


                        ParameterGroupFamily

String

The name of the cluster parameter group family that this cluster parameter group is compatible with.

String string


                        ParameterGroupName

String

The name of the cluster parameter group.

String string

480ClusterParameterGroupQuotaExceededFault

Body

Name	Data Type	Description
`ClusterParameterGroupQuotaExceededFault`

481ClusterParameterGroupAlreadyExistsFault

Body

Name	Data Type	Description
`ClusterParameterGroupAlreadyExistsFault`

482TagLimitExceededFault

Body

Name	Data Type	Description
`TagLimitExceededFault`

483InvalidTagFault

Body

Name	Data Type	Description
`InvalidTagFault`

POST

/#Action=CreateClusterParameterGroup

Creates an Amazon Redshift parameter group.

Request

Query

Name	Data Type	Description
`Version`	string Allowed values: - `2012-12-01`
`Action`	string Allowed values: - `CreateClusterParameterGroup`

Header

Name	Data Type	Description
`X-Amz-SignedHeaders`	string
`X-Amz-Signature`	string
`X-Amz-Security-Token`	string
`X-Amz-Credential`	string
`X-Amz-Algorithm`	string
`X-Amz-Date`	string
`X-Amz-Content-Sha256`	string

Form Data

Name	Data Type	Description
`Tags`	array	A list of tag instances.
`Description`	string	A description of the parameter group.
`ParameterGroupFamily`	string	The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
`ParameterGroupName`	string	The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. This value is stored as a lower-case string.

Responses

200Success

Body

Name	Data Type	Description
`CreateClusterParameterGroupResult`	object

Properties

ClusterParameterGroup ClusterParameterGroup


                        ClusterParameterGroup

object

Describes a parameter group.

Properties


                        Tags

TagList

The list of tags for the cluster parameter group.

TagList array [Tag]


                        Description

String

The description of the parameter group.

String string


                        ParameterGroupFamily

String

The name of the cluster parameter group family that this cluster parameter group is compatible with.

String string


                        ParameterGroupName

String

The name of the cluster parameter group.

String string

480ClusterParameterGroupQuotaExceededFault

Body

Name	Data Type	Description
`ClusterParameterGroupQuotaExceededFault`

481ClusterParameterGroupAlreadyExistsFault

Body

Name	Data Type	Description