SDK for PHP 3.x

Client: Aws\Redshift\RedshiftClient
Service ID: redshift
Version: 2012-12-01

This page describes the parameters and results for the operations of the Amazon Redshift (2012-12-01), and shows how to use the Aws\Redshift\RedshiftClient object to call the described operations. This documentation is specific to the 2012-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptReservedNodeExchange ( array $params = [] )
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.
AddPartner ( array $params = [] )
Adds a partner integration to a cluster.
AssociateDataShareConsumer ( array $params = [] )
From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).
AuthorizeClusterSecurityGroupIngress ( array $params = [] )
Adds an inbound (ingress) rule to an Amazon Redshift security group.
AuthorizeDataShare ( array $params = [] )
From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities.
AuthorizeEndpointAccess ( array $params = [] )
Grants access to a cluster.
AuthorizeSnapshotAccess ( array $params = [] )
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
BatchDeleteClusterSnapshots ( array $params = [] )
Deletes a set of cluster snapshots.
BatchModifyClusterSnapshots ( array $params = [] )
Modifies the settings for a set of cluster snapshots.
CancelResize ( array $params = [] )
Cancels a resize operation for a cluster.
CopyClusterSnapshot ( array $params = [] )
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
CreateAuthenticationProfile ( array $params = [] )
Creates an authentication profile with the specified parameters.
CreateCluster ( array $params = [] )
Creates a new cluster with the specified parameters.
CreateClusterParameterGroup ( array $params = [] )
Creates an Amazon Redshift parameter group.
CreateClusterSecurityGroup ( array $params = [] )
Creates a new Amazon Redshift security group.
CreateClusterSnapshot ( array $params = [] )
Creates a manual snapshot of the specified cluster.
CreateClusterSubnetGroup ( array $params = [] )
Creates a new Amazon Redshift subnet group.
CreateCustomDomainAssociation ( array $params = [] )
Used to create a custom domain name for a cluster.
CreateEndpointAccess ( array $params = [] )
Creates a Redshift-managed VPC endpoint.
CreateEventSubscription ( array $params = [] )
Creates an Amazon Redshift event notification subscription.
CreateHsmClientCertificate ( array $params = [] )
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
CreateHsmConfiguration ( array $params = [] )
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM).
CreateRedshiftIdcApplication ( array $params = [] )
Creates an Amazon Redshift application for use with IAM Identity Center.
CreateScheduledAction ( array $params = [] )
Creates a scheduled action.
CreateSnapshotCopyGrant ( array $params = [] )
Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.
CreateSnapshotSchedule ( array $params = [] )
Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
CreateTags ( array $params = [] )
Adds tags to a cluster.
CreateUsageLimit ( array $params = [] )
Creates a usage limit for a specified Amazon Redshift feature on a cluster.
DeauthorizeDataShare ( array $params = [] )
From a datashare producer account, removes authorization from the specified datashare.
DeleteAuthenticationProfile ( array $params = [] )
Deletes an authentication profile.
DeleteCluster ( array $params = [] )
Deletes a previously provisioned cluster without its final snapshot being created.
DeleteClusterParameterGroup ( array $params = [] )
Deletes a specified Amazon Redshift parameter group.
DeleteClusterSecurityGroup ( array $params = [] )
Deletes an Amazon Redshift security group.
DeleteClusterSnapshot ( array $params = [] )
Deletes the specified manual snapshot.
DeleteClusterSubnetGroup ( array $params = [] )
Deletes the specified cluster subnet group.
DeleteCustomDomainAssociation ( array $params = [] )
Contains information about deleting a custom domain association for a cluster.
DeleteEndpointAccess ( array $params = [] )
Deletes a Redshift-managed VPC endpoint.
DeleteEventSubscription ( array $params = [] )
Deletes an Amazon Redshift event notification subscription.
DeleteHsmClientCertificate ( array $params = [] )
Deletes the specified HSM client certificate.
DeleteHsmConfiguration ( array $params = [] )
Deletes the specified Amazon Redshift HSM configuration.
DeletePartner ( array $params = [] )
Deletes a partner integration from a cluster.
DeleteRedshiftIdcApplication ( array $params = [] )
Deletes an Amazon Redshift IAM Identity Center application.
DeleteResourcePolicy ( array $params = [] )
Deletes the resource policy for a specified resource.
DeleteScheduledAction ( array $params = [] )
Deletes a scheduled action.
DeleteSnapshotCopyGrant ( array $params = [] )
Deletes the specified snapshot copy grant.
DeleteSnapshotSchedule ( array $params = [] )
Deletes a snapshot schedule.
DeleteTags ( array $params = [] )
Deletes tags from a resource.
DeleteUsageLimit ( array $params = [] )
Deletes a usage limit from a cluster.
DescribeAccountAttributes ( array $params = [] )
Returns a list of attributes attached to an account
DescribeAuthenticationProfiles ( array $params = [] )
Describes an authentication profile.
DescribeClusterDbRevisions ( array $params = [] )
Returns an array of ClusterDbRevision objects.
DescribeClusterParameterGroups ( array $params = [] )
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.
DescribeClusterParameters ( array $params = [] )
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
DescribeClusterSecurityGroups ( array $params = [] )
Returns information about Amazon Redshift security groups.
DescribeClusterSnapshots ( array $params = [] )
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
DescribeClusterSubnetGroups ( array $params = [] )
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
DescribeClusterTracks ( array $params = [] )
Returns a list of all the available maintenance tracks.
DescribeClusterVersions ( array $params = [] )
Returns descriptions of the available Amazon Redshift cluster versions.
DescribeClusters ( array $params = [] )
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.
DescribeCustomDomainAssociations ( array $params = [] )
Contains information about custom domain associations for a cluster.
DescribeDataShares ( array $params = [] )
Shows the status of any inbound or outbound datashares available in the specified account.
DescribeDataSharesForConsumer ( array $params = [] )
Returns a list of datashares where the account identifier being called is a consumer account identifier.
DescribeDataSharesForProducer ( array $params = [] )
Returns a list of datashares when the account identifier being called is a producer account identifier.
DescribeDefaultClusterParameters ( array $params = [] )
Returns a list of parameter settings for the specified parameter group family.
DescribeEndpointAccess ( array $params = [] )
Describes a Redshift-managed VPC endpoint.
DescribeEndpointAuthorization ( array $params = [] )
Describes an endpoint authorization.
DescribeEventCategories ( array $params = [] )
Displays a list of event categories for all event source types, or for a specified source type.
DescribeEventSubscriptions ( array $params = [] )
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
DescribeEvents ( array $params = [] )
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
DescribeHsmClientCertificates ( array $params = [] )
Returns information about the specified HSM client certificate.
DescribeHsmConfigurations ( array $params = [] )
Returns information about the specified Amazon Redshift HSM configuration.
DescribeInboundIntegrations ( array $params = [] )
Returns a list of inbound integrations.
DescribeLoggingStatus ( array $params = [] )
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
DescribeNodeConfigurationOptions ( array $params = [] )
Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
DescribeOrderableClusterOptions ( array $params = [] )
Returns a list of orderable cluster options.
DescribePartners ( array $params = [] )
Returns information about the partner integrations defined for a cluster.
DescribeRedshiftIdcApplications ( array $params = [] )
Lists the Amazon Redshift IAM Identity Center applications.
DescribeReservedNodeExchangeStatus ( array $params = [] )
Returns exchange status details and associated metadata for a reserved-node exchange.
DescribeReservedNodeOfferings ( array $params = [] )
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
DescribeReservedNodes ( array $params = [] )
Returns the descriptions of the reserved nodes.
DescribeResize ( array $params = [] )
Returns information about the last resize operation for the specified cluster.
DescribeScheduledActions ( array $params = [] )
Describes properties of scheduled actions.
DescribeSnapshotCopyGrants ( array $params = [] )
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.
DescribeSnapshotSchedules ( array $params = [] )
Returns a list of snapshot schedules.
DescribeStorage ( array $params = [] )
Returns account level backups storage size and provisional storage.
DescribeTableRestoreStatus ( array $params = [] )
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.
DescribeTags ( array $params = [] )
Returns a list of tags.
DescribeUsageLimits ( array $params = [] )
Shows usage limits on a cluster.
DisableLogging ( array $params = [] )
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
DisableSnapshotCopy ( array $params = [] )
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
DisassociateDataShareConsumer ( array $params = [] )
From a datashare consumer account, remove association for the specified datashare.
EnableLogging ( array $params = [] )
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
EnableSnapshotCopy ( array $params = [] )
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
FailoverPrimaryCompute ( array $params = [] )
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
GetClusterCredentials ( array $params = [] )
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database.
GetClusterCredentialsWithIAM ( array $params = [] )
Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.
GetReservedNodeExchangeConfigurationOptions ( array $params = [] )
Gets the configuration options for the reserved-node exchange.
GetReservedNodeExchangeOfferings ( array $params = [] )
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
GetResourcePolicy ( array $params = [] )
Get the resource policy for a specified resource.
ListRecommendations ( array $params = [] )
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
ModifyAquaConfiguration ( array $params = [] )
This operation is retired.
ModifyAuthenticationProfile ( array $params = [] )
Modifies an authentication profile.
ModifyCluster ( array $params = [] )
Modifies the settings for a cluster.
ModifyClusterDbRevision ( array $params = [] )
Modifies the database revision of a cluster.
ModifyClusterIamRoles ( array $params = [] )
Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
ModifyClusterMaintenance ( array $params = [] )
Modifies the maintenance settings of a cluster.
ModifyClusterParameterGroup ( array $params = [] )
Modifies the parameters of a parameter group.
ModifyClusterSnapshot ( array $params = [] )
Modifies the settings for a snapshot.
ModifyClusterSnapshotSchedule ( array $params = [] )
Modifies a snapshot schedule for a cluster.
ModifyClusterSubnetGroup ( array $params = [] )
Modifies a cluster subnet group to include the specified list of VPC subnets.
ModifyCustomDomainAssociation ( array $params = [] )
Contains information for changing a custom domain association.
ModifyEndpointAccess ( array $params = [] )
Modifies a Redshift-managed VPC endpoint.
ModifyEventSubscription ( array $params = [] )
Modifies an existing Amazon Redshift event notification subscription.
ModifyRedshiftIdcApplication ( array $params = [] )
Changes an existing Amazon Redshift IAM Identity Center application.
ModifyScheduledAction ( array $params = [] )
Modifies a scheduled action.
ModifySnapshotCopyRetentionPeriod ( array $params = [] )
Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
ModifySnapshotSchedule ( array $params = [] )
Modifies a snapshot schedule.
ModifyUsageLimit ( array $params = [] )
Modifies a usage limit in a cluster.
PauseCluster ( array $params = [] )
Pauses a cluster.
PurchaseReservedNodeOffering ( array $params = [] )
Allows you to purchase reserved nodes.
PutResourcePolicy ( array $params = [] )
Updates the resource policy for a specified resource.
RebootCluster ( array $params = [] )
Reboots a cluster.
RejectDataShare ( array $params = [] )
From a datashare consumer account, rejects the specified datashare.
ResetClusterParameterGroup ( array $params = [] )
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default".
ResizeCluster ( array $params = [] )
Changes the size of the cluster.
RestoreFromClusterSnapshot ( array $params = [] )
Creates a new cluster from a snapshot.
RestoreTableFromClusterSnapshot ( array $params = [] )
Creates a new table from a table in an Amazon Redshift cluster snapshot.
ResumeCluster ( array $params = [] )
Resumes a paused cluster.
RevokeClusterSecurityGroupIngress ( array $params = [] )
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.
RevokeEndpointAccess ( array $params = [] )
Revokes access to a cluster.
RevokeSnapshotAccess ( array $params = [] )
Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.
RotateEncryptionKey ( array $params = [] )
Rotates the encryption keys for a cluster.
UpdatePartnerStatus ( array $params = [] )
Updates the status of a partner integration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeClusterDbRevisions
DescribeClusterParameterGroups
DescribeClusterParameters
DescribeClusterSecurityGroups
DescribeClusterSnapshots
DescribeClusterSubnetGroups
DescribeClusterTracks
DescribeClusterVersions
DescribeClusters
DescribeCustomDomainAssociations
DescribeDataShares
DescribeDataSharesForConsumer
DescribeDataSharesForProducer
DescribeDefaultClusterParameters
DescribeEndpointAccess
DescribeEndpointAuthorization
DescribeEventSubscriptions
DescribeEvents
DescribeHsmClientCertificates
DescribeHsmConfigurations
DescribeInboundIntegrations
DescribeNodeConfigurationOptions
DescribeOrderableClusterOptions
DescribeRedshiftIdcApplications
DescribeReservedNodeExchangeStatus
DescribeReservedNodeOfferings
DescribeReservedNodes
DescribeScheduledActions
DescribeSnapshotCopyGrants
DescribeSnapshotSchedules
DescribeTableRestoreStatus
DescribeTags
DescribeUsageLimits
GetReservedNodeExchangeConfigurationOptions
GetReservedNodeExchangeOfferings
ListRecommendations

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
ClusterAvailable DescribeClusters 60 30
ClusterDeleted DescribeClusters 60 30
ClusterRestored DescribeClusters 60 30
SnapshotAvailable DescribeClusterSnapshots 15 20

Operations

AcceptReservedNodeExchange

$result = $client->acceptReservedNodeExchange([/* ... */]);
$promise = $client->acceptReservedNodeExchangeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->acceptReservedNodeExchange([
    'ReservedNodeId' => '<string>', // REQUIRED
    'TargetReservedNodeOfferingId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ReservedNodeId
Required: Yes
Type: string

A string representing the node identifier of the DC1 Reserved Node to be exchanged.

TargetReservedNodeOfferingId
Required: Yes
Type: 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

Result Syntax

[
    'ExchangedReservedNode' => [
        'CurrencyCode' => '<string>',
        'Duration' => <integer>,
        'FixedPrice' => <float>,
        'NodeCount' => <integer>,
        'NodeType' => '<string>',
        'OfferingType' => '<string>',
        'RecurringCharges' => [
            [
                'RecurringChargeAmount' => <float>,
                'RecurringChargeFrequency' => '<string>',
            ],
            // ...
        ],
        'ReservedNodeId' => '<string>',
        'ReservedNodeOfferingId' => '<string>',
        'ReservedNodeOfferingType' => 'Regular|Upgradable',
        'StartTime' => <DateTime>,
        'State' => '<string>',
        'UsagePrice' => <float>,
    ],
]

Result Details

Members
ExchangedReservedNode
Type: ReservedNode structure

Errors

ReservedNodeNotFoundFault:

The specified reserved compute node not found.

InvalidReservedNodeStateFault:

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

ReservedNodeAlreadyMigratedFault:

Indicates that the reserved node has already been exchanged.

ReservedNodeOfferingNotFoundFault:

Specified offering does not exist.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

ReservedNodeAlreadyExistsFault:

User already has a reservation with the given identifier.

AddPartner

$result = $client->addPartner([/* ... */]);
$promise = $client->addPartnerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->addPartner([
    'AccountId' => '<string>', // REQUIRED
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DatabaseName' => '<string>', // REQUIRED
    'PartnerName' => '<string>', // REQUIRED
]);

Parameter Details

Members
AccountId
Required: Yes
Type: string

The Amazon Web Services account ID that owns the cluster.

ClusterIdentifier
Required: Yes
Type: string

The cluster identifier of the cluster that receives data from the partner.

DatabaseName
Required: Yes
Type: string

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

PartnerName
Required: Yes
Type: string

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

Result Syntax

[
    'DatabaseName' => '<string>',
    'PartnerName' => '<string>',
]

Result Details

Members
DatabaseName
Type: string

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

PartnerName
Type: string

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

Errors

PartnerNotFoundFault:

The name of the partner was not found.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnauthorizedPartnerIntegrationFault:

The partner integration is not authorized.

UnsupportedOperationFault:

The requested operation isn't supported.

AssociateDataShareConsumer

$result = $client->associateDataShareConsumer([/* ... */]);
$promise = $client->associateDataShareConsumerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateDataShareConsumer([
    'AllowWrites' => true || false,
    'AssociateEntireAccount' => true || false,
    'ConsumerArn' => '<string>',
    'ConsumerRegion' => '<string>',
    'DataShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AllowWrites
Type: boolean

If set to true, allows write operations for a datashare.

AssociateEntireAccount
Type: boolean

A value that specifies whether the datashare is associated with the entire account.

ConsumerArn
Type: string

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

ConsumerRegion
Type: string

From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

DataShareArn
Required: Yes
Type: string

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

Result Syntax

[
    'AllowPubliclyAccessibleConsumers' => true || false,
    'DataShareArn' => '<string>',
    'DataShareAssociations' => [
        [
            'ConsumerAcceptedWrites' => true || false,
            'ConsumerIdentifier' => '<string>',
            'ConsumerRegion' => '<string>',
            'CreatedDate' => <DateTime>,
            'ProducerAllowedWrites' => true || false,
            'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
            'StatusChangeDate' => <DateTime>,
        ],
        // ...
    ],
    'ManagedBy' => '<string>',
    'ProducerArn' => '<string>',
]

Result Details

Members
AllowPubliclyAccessibleConsumers
Type: boolean

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DataShareArn
Type: string

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

DataShareAssociations
Type: Array of DataShareAssociation structures

A value that specifies when the datashare has an association between producer and data consumers.

ManagedBy
Type: string

The identifier of a datashare to show its managing entity.

ProducerArn
Type: string

The Amazon Resource Name (ARN) of the producer namespace.

Errors

InvalidDataShareFault:

There is an error with the datashare.

InvalidNamespaceFault:

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

AuthorizeClusterSecurityGroupIngress

$result = $client->authorizeClusterSecurityGroupIngress([/* ... */]);
$promise = $client->authorizeClusterSecurityGroupIngressAsync([/* ... */]);

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 Amazon Web Services 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.

Parameter Syntax

$result = $client->authorizeClusterSecurityGroupIngress([
    'CIDRIP' => '<string>',
    'ClusterSecurityGroupName' => '<string>', // REQUIRED
    'EC2SecurityGroupName' => '<string>',
    'EC2SecurityGroupOwnerId' => '<string>',
]);

Parameter Details

Members
CIDRIP
Type: string

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

ClusterSecurityGroupName
Required: Yes
Type: string

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

EC2SecurityGroupName
Type: string

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

EC2SecurityGroupOwnerId
Type: string

The Amazon Web Services account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access Key ID is not an acceptable value.

Example: 111122223333

Result Syntax

[
    'ClusterSecurityGroup' => [
        'ClusterSecurityGroupName' => '<string>',
        'Description' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'IPRanges' => [
            [
                'CIDRIP' => '<string>',
                'Status' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ClusterSecurityGroup
Type: ClusterSecurityGroup structure

Describes a security group.

Errors

ClusterSecurityGroupNotFoundFault:

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

InvalidClusterSecurityGroupStateFault:

The state of the cluster security group is not available.

AuthorizationAlreadyExistsFault:

The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.

AuthorizationQuotaExceededFault:

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

AuthorizeDataShare

$result = $client->authorizeDataShare([/* ... */]);
$promise = $client->authorizeDataShareAsync([/* ... */]);

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

Parameter Syntax

$result = $client->authorizeDataShare([
    'AllowWrites' => true || false,
    'ConsumerIdentifier' => '<string>', // REQUIRED
    'DataShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
AllowWrites
Type: boolean

If set to true, allows write operations for a datashare.

ConsumerIdentifier
Required: Yes
Type: string

The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

DataShareArn
Required: Yes
Type: string

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

Result Syntax

[
    'AllowPubliclyAccessibleConsumers' => true || false,
    'DataShareArn' => '<string>',
    'DataShareAssociations' => [
        [
            'ConsumerAcceptedWrites' => true || false,
            'ConsumerIdentifier' => '<string>',
            'ConsumerRegion' => '<string>',
            'CreatedDate' => <DateTime>,
            'ProducerAllowedWrites' => true || false,
            'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
            'StatusChangeDate' => <DateTime>,
        ],
        // ...
    ],
    'ManagedBy' => '<string>',
    'ProducerArn' => '<string>',
]

Result Details

Members
AllowPubliclyAccessibleConsumers
Type: boolean

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DataShareArn
Type: string

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

DataShareAssociations
Type: Array of DataShareAssociation structures

A value that specifies when the datashare has an association between producer and data consumers.

ManagedBy
Type: string

The identifier of a datashare to show its managing entity.

ProducerArn
Type: string

The Amazon Resource Name (ARN) of the producer namespace.

Errors

InvalidDataShareFault:

There is an error with the datashare.

AuthorizeEndpointAccess

$result = $client->authorizeEndpointAccess([/* ... */]);
$promise = $client->authorizeEndpointAccessAsync([/* ... */]);

Grants access to a cluster.

Parameter Syntax

$result = $client->authorizeEndpointAccess([
    'Account' => '<string>', // REQUIRED
    'ClusterIdentifier' => '<string>',
    'VpcIds' => ['<string>', ...],
]);

Parameter Details

Members
Account
Required: Yes
Type: string

The Amazon Web Services account ID to grant access to.

ClusterIdentifier
Type: string

The cluster identifier of the cluster to grant access to.

VpcIds
Type: Array of strings

The virtual private cloud (VPC) identifiers to grant access to.

Result Syntax

[
    'AllowedAllVPCs' => true || false,
    'AllowedVPCs' => ['<string>', ...],
    'AuthorizeTime' => <DateTime>,
    'ClusterIdentifier' => '<string>',
    'ClusterStatus' => '<string>',
    'EndpointCount' => <integer>,
    'Grantee' => '<string>',
    'Grantor' => '<string>',
    'Status' => 'Authorized|Revoking',
]

Result Details

Members
AllowedAllVPCs
Type: boolean

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

AllowedVPCs
Type: Array of strings

The VPCs allowed access to the cluster.

AuthorizeTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the authorization was created.

ClusterIdentifier
Type: string

The cluster identifier.

ClusterStatus
Type: string

The status of the cluster.

EndpointCount
Type: int

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

Grantee
Type: string

The Amazon Web Services account ID of the grantee of the cluster.

Grantor
Type: string

The Amazon Web Services account ID of the cluster owner.

Status
Type: string

The status of the authorization action.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

EndpointAuthorizationsPerClusterLimitExceededFault:

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

UnsupportedOperationFault:

The requested operation isn't supported.

EndpointAuthorizationAlreadyExistsFault:

The authorization already exists for this endpoint.

InvalidAuthorizationStateFault:

The status of the authorization is not valid.

InvalidClusterStateFault:

The specified cluster is not in the available state.

AuthorizeSnapshotAccess

$result = $client->authorizeSnapshotAccess([/* ... */]);
$promise = $client->authorizeSnapshotAccessAsync([/* ... */]);

Authorizes the specified Amazon Web Services 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.

Parameter Syntax

$result = $client->authorizeSnapshotAccess([
    'AccountWithRestoreAccess' => '<string>', // REQUIRED
    'SnapshotArn' => '<string>',
    'SnapshotClusterIdentifier' => '<string>',
    'SnapshotIdentifier' => '<string>',
]);

Parameter Details

Members
AccountWithRestoreAccess
Required: Yes
Type: string

The identifier of the Amazon Web Services account authorized to restore the specified snapshot.

To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.

SnapshotArn
Type: string

The Amazon Resource Name (ARN) of the snapshot to authorize access to.

SnapshotClusterIdentifier
Type: string

The identifier of the cluster the snapshot was created from.

  • If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all (*) snapshots - This parameter is required. Otherwise, permissions aren't available to check if the snapshot exists.

  • If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to validate snapshot authorization.

SnapshotIdentifier
Type: string

The identifier of the snapshot the account is authorized to restore.

Result Syntax

[
    'Snapshot' => [
        'AccountsWithRestoreAccess' => [
            [
                'AccountAlias' => '<string>',
                'AccountId' => '<string>',
            ],
            // ...
        ],
        'ActualIncrementalBackupSizeInMegaBytes' => <float>,
        'AvailabilityZone' => '<string>',
        'BackupProgressInMegaBytes' => <float>,
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterVersion' => '<string>',
        'CurrentBackupRateInMegaBytesPerSecond' => <float>,
        'DBName' => '<string>',
        'ElapsedTimeInSeconds' => <integer>,
        'Encrypted' => true || false,
        'EncryptedWithHSM' => true || false,
        'EngineFullVersion' => '<string>',
        'EnhancedVpcRouting' => true || false,
        'EstimatedSecondsToCompletion' => <integer>,
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRemainingDays' => <integer>,
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'OwnerAccount' => '<string>',
        'Port' => <integer>,
        'RestorableNodeTypes' => ['<string>', ...],
        'SnapshotArn' => '<string>',
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotIdentifier' => '<string>',
        'SnapshotRetentionStartTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalBackupSizeInMegaBytes' => <float>,
        'VpcId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

Describes a snapshot.

Errors

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

AuthorizationAlreadyExistsFault:

The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.

AuthorizationQuotaExceededFault:

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

DependentServiceRequestThrottlingFault:

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

InvalidClusterSnapshotStateFault:

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

LimitExceededFault:

The encryption key has exceeded its grant limit in Amazon Web Services KMS.

UnsupportedOperationFault:

The requested operation isn't supported.

BatchDeleteClusterSnapshots

$result = $client->batchDeleteClusterSnapshots([/* ... */]);
$promise = $client->batchDeleteClusterSnapshotsAsync([/* ... */]);

Deletes a set of cluster snapshots.

Parameter Syntax

$result = $client->batchDeleteClusterSnapshots([
    'Identifiers' => [ // REQUIRED
        [
            'SnapshotClusterIdentifier' => '<string>',
            'SnapshotIdentifier' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Identifiers
Required: Yes
Type: Array of DeleteClusterSnapshotMessage structures

A list of identifiers for the snapshots that you want to delete.

Result Syntax

[
    'Errors' => [
        [
            'FailureCode' => '<string>',
            'FailureReason' => '<string>',
            'SnapshotClusterIdentifier' => '<string>',
            'SnapshotIdentifier' => '<string>',
        ],
        // ...
    ],
    'Resources' => ['<string>', ...],
]

Result Details

Members
Errors
Type: Array of SnapshotErrorMessage structures

A list of any errors returned.

Resources
Type: Array of strings

A list of the snapshot identifiers that were deleted.

Errors

BatchDeleteRequestSizeExceededFault:

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

BatchModifyClusterSnapshots

$result = $client->batchModifyClusterSnapshots([/* ... */]);
$promise = $client->batchModifyClusterSnapshotsAsync([/* ... */]);

Modifies the settings for a set of cluster snapshots.

Parameter Syntax

$result = $client->batchModifyClusterSnapshots([
    'Force' => true || false,
    'ManualSnapshotRetentionPeriod' => <integer>,
    'SnapshotIdentifierList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
Force
Type: boolean

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

ManualSnapshotRetentionPeriod
Type: int

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
Required: Yes
Type: Array of strings

A list of snapshot identifiers you want to modify.

Result Syntax

[
    'Errors' => [
        [
            'FailureCode' => '<string>',
            'FailureReason' => '<string>',
            'SnapshotClusterIdentifier' => '<string>',
            'SnapshotIdentifier' => '<string>',
        ],
        // ...
    ],
    'Resources' => ['<string>', ...],
]

Result Details

Members
Errors
Type: Array of SnapshotErrorMessage structures

A list of any errors returned.

Resources
Type: Array of strings

A list of the snapshots that were modified.

Errors

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

BatchModifyClusterSnapshotsLimitExceededFault:

The maximum number for snapshot identifiers has been reached. The limit is 100.

CancelResize

$result = $client->cancelResize([/* ... */]);
$promise = $client->cancelResizeAsync([/* ... */]);

Cancels a resize operation for a cluster.

Parameter Syntax

$result = $client->cancelResize([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier for the cluster that you want to cancel a resize operation for.

Result Syntax

[
    'AvgResizeRateInMegaBytesPerSecond' => <float>,
    'DataTransferProgressPercent' => <float>,
    'ElapsedTimeInSeconds' => <integer>,
    'EstimatedTimeToCompletionInSeconds' => <integer>,
    'ImportTablesCompleted' => ['<string>', ...],
    'ImportTablesInProgress' => ['<string>', ...],
    'ImportTablesNotStarted' => ['<string>', ...],
    'Message' => '<string>',
    'ProgressInMegaBytes' => <integer>,
    'ResizeType' => '<string>',
    'Status' => '<string>',
    'TargetClusterType' => '<string>',
    'TargetEncryptionType' => '<string>',
    'TargetNodeType' => '<string>',
    'TargetNumberOfNodes' => <integer>,
    'TotalResizeDataInMegaBytes' => <integer>,
]

Result Details

Members
AvgResizeRateInMegaBytesPerSecond
Type: double

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.

DataTransferProgressPercent
Type: double

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

ElapsedTimeInSeconds
Type: long (int|float)

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.

EstimatedTimeToCompletionInSeconds
Type: long (int|float)

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.

ImportTablesCompleted
Type: Array of strings

The names of tables that have been completely imported .

Valid Values: List of table names.

ImportTablesInProgress
Type: Array of strings

The names of tables that are being currently imported.

Valid Values: List of table names.

ImportTablesNotStarted
Type: Array of strings

The names of tables that have not been yet imported.

Valid Values: List of table names

Message
Type: string

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

ProgressInMegaBytes
Type: long (int|float)

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

ResizeType
Type: string

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

Status
Type: string

The status of the resize operation.

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

TargetClusterType
Type: string

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

TargetEncryptionType
Type: string

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

Possible values are KMS and None.

TargetNodeType
Type: string

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

TargetNumberOfNodes
Type: int

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

TotalResizeDataInMegaBytes
Type: long (int|float)

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

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ResizeNotFoundFault:

A resize operation for the specified cluster is not found.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnsupportedOperationFault:

The requested operation isn't supported.

CopyClusterSnapshot

$result = $client->copyClusterSnapshot([/* ... */]);
$promise = $client->copyClusterSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->copyClusterSnapshot([
    'ManualSnapshotRetentionPeriod' => <integer>,
    'SourceSnapshotClusterIdentifier' => '<string>',
    'SourceSnapshotIdentifier' => '<string>', // REQUIRED
    'TargetSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ManualSnapshotRetentionPeriod
Type: int

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.

SourceSnapshotClusterIdentifier
Type: 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
Required: Yes
Type: string

The identifier for the source snapshot.

Constraints:

  • Must be the identifier for a valid automated snapshot whose state is available.

TargetSnapshotIdentifier
Required: Yes
Type: 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 Amazon Web Services account that is making the request.

Result Syntax

[
    'Snapshot' => [
        'AccountsWithRestoreAccess' => [
            [
                'AccountAlias' => '<string>',
                'AccountId' => '<string>',
            ],
            // ...
        ],
        'ActualIncrementalBackupSizeInMegaBytes' => <float>,
        'AvailabilityZone' => '<string>',
        'BackupProgressInMegaBytes' => <float>,
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterVersion' => '<string>',
        'CurrentBackupRateInMegaBytesPerSecond' => <float>,
        'DBName' => '<string>',
        'ElapsedTimeInSeconds' => <integer>,
        'Encrypted' => true || false,
        'EncryptedWithHSM' => true || false,
        'EngineFullVersion' => '<string>',
        'EnhancedVpcRouting' => true || false,
        'EstimatedSecondsToCompletion' => <integer>,
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRemainingDays' => <integer>,
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'OwnerAccount' => '<string>',
        'Port' => <integer>,
        'RestorableNodeTypes' => ['<string>', ...],
        'SnapshotArn' => '<string>',
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotIdentifier' => '<string>',
        'SnapshotRetentionStartTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalBackupSizeInMegaBytes' => <float>,
        'VpcId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

Describes a snapshot.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ClusterSnapshotAlreadyExistsFault:

The value specified as a snapshot identifier is already used by an existing snapshot.

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

InvalidClusterSnapshotStateFault:

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

ClusterSnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of cluster snapshots.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

CreateAuthenticationProfile

$result = $client->createAuthenticationProfile([/* ... */]);
$promise = $client->createAuthenticationProfileAsync([/* ... */]);

Creates an authentication profile with the specified parameters.

Parameter Syntax

$result = $client->createAuthenticationProfile([
    'AuthenticationProfileContent' => '<string>', // REQUIRED
    'AuthenticationProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
AuthenticationProfileContent
Required: Yes
Type: string

The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

AuthenticationProfileName
Required: Yes
Type: string

The name of the authentication profile to be created.

Result Syntax

[
    'AuthenticationProfileContent' => '<string>',
    'AuthenticationProfileName' => '<string>',
]

Result Details

Members
AuthenticationProfileContent
Type: string

The content of the authentication profile in JSON format.

AuthenticationProfileName
Type: string

The name of the authentication profile that was created.

Errors

AuthenticationProfileAlreadyExistsFault:

The authentication profile already exists.

AuthenticationProfileQuotaExceededFault:

The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.

InvalidAuthenticationProfileRequestFault:

The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createCluster([
    'AdditionalInfo' => '<string>',
    'AllowVersionUpgrade' => true || false,
    'AquaConfigurationStatus' => 'enabled|disabled|auto',
    'AutomatedSnapshotRetentionPeriod' => <integer>,
    'AvailabilityZone' => '<string>',
    'AvailabilityZoneRelocation' => true || false,
    'ClusterIdentifier' => '<string>', // REQUIRED
    'ClusterParameterGroupName' => '<string>',
    'ClusterSecurityGroups' => ['<string>', ...],
    'ClusterSubnetGroupName' => '<string>',
    'ClusterType' => '<string>',
    'ClusterVersion' => '<string>',
    'DBName' => '<string>',
    'DefaultIamRoleArn' => '<string>',
    'ElasticIp' => '<string>',
    'Encrypted' => true || false,
    'EnhancedVpcRouting' => true || false,
    'HsmClientCertificateIdentifier' => '<string>',
    'HsmConfigurationIdentifier' => '<string>',
    'IamRoles' => ['<string>', ...],
    'IpAddressType' => '<string>',
    'KmsKeyId' => '<string>',
    'LoadSampleData' => '<string>',
    'MaintenanceTrackName' => '<string>',
    'ManageMasterPassword' => true || false,
    'ManualSnapshotRetentionPeriod' => <integer>,
    'MasterPasswordSecretKmsKeyId' => '<string>',
    'MasterUserPassword' => '<string>',
    'MasterUsername' => '<string>', // REQUIRED
    'MultiAZ' => true || false,
    'NodeType' => '<string>', // REQUIRED
    'NumberOfNodes' => <integer>,
    'Port' => <integer>,
    'PreferredMaintenanceWindow' => '<string>',
    'PubliclyAccessible' => true || false,
    'RedshiftIdcApplicationArn' => '<string>',
    'SnapshotScheduleIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
AdditionalInfo
Type: string

Reserved.

AllowVersionUpgrade
Type: 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

AquaConfigurationStatus
Type: string

This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

AutomatedSnapshotRetentionPeriod
Type: int

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.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: 1

Constraints: Must be a value from 0 to 35.

AvailabilityZone
Type: 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.

AvailabilityZoneRelocation
Type: boolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

ClusterIdentifier
Required: Yes
Type: 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 Amazon Web Services account.

Example: myexamplecluster

ClusterParameterGroupName
Type: 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.

ClusterSecurityGroups
Type: Array of strings

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

ClusterSubnetGroupName
Type: 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).

ClusterType
Type: 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

ClusterVersion
Type: 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

DBName
Type: 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.

DefaultIamRoleArn
Type: string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

ElasticIp
Type: 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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

Encrypted
Type: boolean

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

Default: false

EnhancedVpcRouting
Type: 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

HsmClientCertificateIdentifier
Type: string

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

HsmConfigurationIdentifier
Type: 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.

IamRoles
Type: Array of strings

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

IpAddressType
Type: string

The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

KmsKeyId
Type: string

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

LoadSampleData
Type: string

A flag that specifies whether to load sample data once the cluster is created.

MaintenanceTrackName
Type: 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.

ManageMasterPassword
Type: boolean

If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

ManualSnapshotRetentionPeriod
Type: int

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.

MasterPasswordSecretKmsKeyId
Type: string

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

MasterUserPassword
Type: string

The password associated with the admin user account for the cluster that is being created.

You can't use MasterUserPassword if ManageMasterPassword is true.

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-126) except ' (single quote), " (double quote), \, /, or @.

MasterUsername
Required: Yes
Type: string

The user name associated with the admin user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC.

  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • The first character must be a letter.

  • Must not contain a colon (:) or a slash (/).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

MultiAZ
Type: boolean

If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

NodeType
Required: Yes
Type: 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: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

NumberOfNodes
Type: int

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.

Port
Type: int

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:

  • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)

  • For clusters with dc2 nodes - Select a port within the range 1150-65535.

PreferredMaintenanceWindow
Type: 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.

PubliclyAccessible
Type: boolean

If true, the cluster can be accessed from a public network.

RedshiftIdcApplicationArn
Type: string

The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

SnapshotScheduleIdentifier
Type: string

A unique identifier for the snapshot schedule.

Tags
Type: Array of Tag structures

A list of tag instances.

VpcSecurityGroupIds
Type: Array of strings

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.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterAlreadyExistsFault:

The account already has a cluster with the given identifier.

InsufficientClusterCapacityFault:

The number of nodes specified exceeds the allotted capacity of the cluster.

ClusterParameterGroupNotFoundFault:

The parameter group name does not refer to an existing parameter group.

ClusterSecurityGroupNotFoundFault:

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

ClusterQuotaExceededFault:

The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

NumberOfNodesQuotaExceededFault:

The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

NumberOfNodesPerClusterLimitExceededFault:

The operation would exceed the number of nodes allowed for a cluster.

ClusterSubnetGroupNotFoundFault:

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

InvalidVPCNetworkStateFault:

The cluster subnet group does not cover all Availability Zones.

InvalidClusterSubnetGroupStateFault:

The cluster subnet group cannot be deleted because it is in use.

InvalidSubnet:

The requested subnet is not valid, or not all of the subnets are in the same VPC.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

HsmClientCertificateNotFoundFault:

There is no Amazon Redshift HSM client certificate with the specified identifier.

HsmConfigurationNotFoundFault:

There is no Amazon Redshift HSM configuration with the specified identifier.

InvalidElasticIpFault:

The Elastic IP (EIP) is invalid or cannot be found.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

LimitExceededFault:

The encryption key has exceeded its grant limit in Amazon Web Services KMS.

DependentServiceRequestThrottlingFault:

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

InvalidClusterTrackFault:

The provided cluster track name is not valid.

SnapshotScheduleNotFoundFault:

We could not find the specified snapshot schedule.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

Ipv6CidrBlockNotFoundFault:

There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.

UnsupportedOperationFault:

The requested operation isn't supported.

RedshiftIdcApplicationNotExistsFault:

The application you attempted to find doesn't exist.

CreateClusterParameterGroup

$result = $client->createClusterParameterGroup([/* ... */]);
$promise = $client->createClusterParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createClusterParameterGroup([
    'Description' => '<string>', // REQUIRED
    'ParameterGroupFamily' => '<string>', // REQUIRED
    'ParameterGroupName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
Required: Yes
Type: string

A description of the parameter group.

ParameterGroupFamily
Required: Yes
Type: 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 Amazon Web Services 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
Required: Yes
Type: 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 Amazon Web Services account.

This value is stored as a lower-case string.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'ClusterParameterGroup' => [
        'Description' => '<string>',
        'ParameterGroupFamily' => '<string>',
        'ParameterGroupName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ClusterParameterGroup
Type: ClusterParameterGroup structure

Describes a parameter group.

Errors

ClusterParameterGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

ClusterParameterGroupAlreadyExistsFault:

A cluster parameter group with the same name already exists.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

CreateClusterSecurityGroup

$result = $client->createClusterSecurityGroup([/* ... */]);
$promise = $client->createClusterSecurityGroupAsync([/* ... */]);

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->createClusterSecurityGroup([
    'ClusterSecurityGroupName' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ClusterSecurityGroupName
Required: Yes
Type: string

The name for the security group. Amazon Redshift stores the value as a lowercase string.

Constraints:

  • Must contain no more than 255 alphanumeric characters or hyphens.

  • Must not be "Default".

  • Must be unique for all security groups that are created by your Amazon Web Services account.

Example: examplesecuritygroup

Description
Required: Yes
Type: string

A description for the security group.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'ClusterSecurityGroup' => [
        'ClusterSecurityGroupName' => '<string>',
        'Description' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'IPRanges' => [
            [
                'CIDRIP' => '<string>',
                'Status' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ClusterSecurityGroup
Type: ClusterSecurityGroup structure

Describes a security group.

Errors

ClusterSecurityGroupAlreadyExistsFault:

A cluster security group with the same name already exists.

ClusterSecurityGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

CreateClusterSnapshot

$result = $client->createClusterSnapshot([/* ... */]);
$promise = $client->createClusterSnapshotAsync([/* ... */]);

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

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

Parameter Syntax

$result = $client->createClusterSnapshot([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'ManualSnapshotRetentionPeriod' => <integer>,
    'SnapshotIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The cluster identifier for which you want a snapshot.

ManualSnapshotRetentionPeriod
Type: int

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.

SnapshotIdentifier
Required: Yes
Type: string

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'Snapshot' => [
        'AccountsWithRestoreAccess' => [
            [
                'AccountAlias' => '<string>',
                'AccountId' => '<string>',
            ],
            // ...
        ],
        'ActualIncrementalBackupSizeInMegaBytes' => <float>,
        'AvailabilityZone' => '<string>',
        'BackupProgressInMegaBytes' => <float>,
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterVersion' => '<string>',
        'CurrentBackupRateInMegaBytesPerSecond' => <float>,
        'DBName' => '<string>',
        'ElapsedTimeInSeconds' => <integer>,
        'Encrypted' => true || false,
        'EncryptedWithHSM' => true || false,
        'EngineFullVersion' => '<string>',
        'EnhancedVpcRouting' => true || false,
        'EstimatedSecondsToCompletion' => <integer>,
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRemainingDays' => <integer>,
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'OwnerAccount' => '<string>',
        'Port' => <integer>,
        'RestorableNodeTypes' => ['<string>', ...],
        'SnapshotArn' => '<string>',
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotIdentifier' => '<string>',
        'SnapshotRetentionStartTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalBackupSizeInMegaBytes' => <float>,
        'VpcId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

Describes a snapshot.

Errors

ClusterSnapshotAlreadyExistsFault:

The value specified as a snapshot identifier is already used by an existing snapshot.

InvalidClusterStateFault:

The specified cluster is not in the available state.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ClusterSnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of cluster snapshots.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

CreateClusterSubnetGroup

$result = $client->createClusterSubnetGroup([/* ... */]);
$promise = $client->createClusterSubnetGroupAsync([/* ... */]);

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->createClusterSubnetGroup([
    'ClusterSubnetGroupName' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ClusterSubnetGroupName
Required: Yes
Type: string

The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

Constraints:

  • Must contain no more than 255 alphanumeric characters or hyphens.

  • Must not be "Default".

  • Must be unique for all subnet groups that are created by your Amazon Web Services account.

Example: examplesubnetgroup

Description
Required: Yes
Type: string

A description for the subnet group.

SubnetIds
Required: Yes
Type: Array of strings

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'ClusterSubnetGroup' => [
        'ClusterSubnetGroupName' => '<string>',
        'Description' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                    'SupportedPlatforms' => [
                        [
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'SupportedClusterIpAddressTypes' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members
ClusterSubnetGroup
Type: ClusterSubnetGroup structure

Describes a subnet group.

Errors

ClusterSubnetGroupAlreadyExistsFault:

A ClusterSubnetGroupName is already used by an existing cluster subnet group.

ClusterSubnetGroupQuotaExceededFault:

The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

ClusterSubnetQuotaExceededFault:

The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

InvalidSubnet:

The requested subnet is not valid, or not all of the subnets are in the same VPC.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

DependentServiceRequestThrottlingFault:

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

CreateCustomDomainAssociation

$result = $client->createCustomDomainAssociation([/* ... */]);
$promise = $client->createCustomDomainAssociationAsync([/* ... */]);

Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->createCustomDomainAssociation([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'CustomDomainCertificateArn' => '<string>', // REQUIRED
    'CustomDomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The cluster identifier that the custom domain is associated with.

CustomDomainCertificateArn
Required: Yes
Type: string

The certificate Amazon Resource Name (ARN) for the custom domain name association.

CustomDomainName
Required: Yes
Type: string

The custom domain name for a custom domain association.

Result Syntax

[
    'ClusterIdentifier' => '<string>',
    'CustomDomainCertExpiryTime' => '<string>',
    'CustomDomainCertificateArn' => '<string>',
    'CustomDomainName' => '<string>',
]

Result Details

Members
ClusterIdentifier
Type: string

The identifier of the cluster that the custom domain is associated with.

CustomDomainCertExpiryTime
Type: string

The expiration time for the certificate for the custom domain.

CustomDomainCertificateArn
Type: string

The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.

CustomDomainName
Type: string

The custom domain name for the association result.

Errors

UnsupportedOperationFault:

The requested operation isn't supported.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

CustomCnameAssociationFault:

An error occurred when an attempt was made to change the custom domain association.

CreateEndpointAccess

$result = $client->createEndpointAccess([/* ... */]);
$promise = $client->createEndpointAccessAsync([/* ... */]);

Creates a Redshift-managed VPC endpoint.

Parameter Syntax

$result = $client->createEndpointAccess([
    'ClusterIdentifier' => '<string>',
    'EndpointName' => '<string>', // REQUIRED
    'ResourceOwner' => '<string>',
    'SubnetGroupName' => '<string>', // REQUIRED
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The cluster identifier of the cluster to access.

EndpointName
Required: Yes
Type: string

The Redshift-managed VPC endpoint name.

An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

ResourceOwner
Type: string

The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

SubnetGroupName
Required: Yes
Type: string

The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

VpcSecurityGroupIds
Type: Array of strings

The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Result Syntax

[
    'Address' => '<string>',
    'ClusterIdentifier' => '<string>',
    'EndpointCreateTime' => <DateTime>,
    'EndpointName' => '<string>',
    'EndpointStatus' => '<string>',
    'Port' => <integer>,
    'ResourceOwner' => '<string>',
    'SubnetGroupName' => '<string>',
    'VpcEndpoint' => [
        'NetworkInterfaces' => [
            [
                'AvailabilityZone' => '<string>',
                'Ipv6Address' => '<string>',
                'NetworkInterfaceId' => '<string>',
                'PrivateIpAddress' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointId' => '<string>',
        'VpcId' => '<string>',
    ],
    'VpcSecurityGroups' => [
        [
            'Status' => '<string>',
            'VpcSecurityGroupId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Address
Type: string

The DNS address of the endpoint.

ClusterIdentifier
Type: string

The cluster identifier of the cluster associated with the endpoint.

EndpointCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) that the endpoint was created.

EndpointName
Type: string

The name of the endpoint.

EndpointStatus
Type: string

The status of the endpoint.

Port
Type: int

The port number on which the cluster accepts incoming connections.

ResourceOwner
Type: string

The Amazon Web Services account ID of the owner of the cluster.

SubnetGroupName
Type: string

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

VpcEndpoint
Type: VpcEndpoint structure

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcSecurityGroups
Type: Array of VpcSecurityGroupMembership structures

The security groups associated with the endpoint.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

AccessToClusterDeniedFault:

You are not authorized to access the cluster.

EndpointsPerClusterLimitExceededFault:

The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.

EndpointsPerAuthorizationLimitExceededFault:

The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.

InvalidClusterSecurityGroupStateFault:

The state of the cluster security group is not available.

ClusterSubnetGroupNotFoundFault:

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

EndpointAlreadyExistsFault:

The account already has a Redshift-managed VPC endpoint with the given identifier.

UnsupportedOperationFault:

The requested operation isn't supported.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

CreateEventSubscription

$result = $client->createEventSubscription([/* ... */]);
$promise = $client->createEventSubscriptionAsync([/* ... */]);

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.

Parameter Syntax

$result = $client->createEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'Severity' => '<string>',
    'SnsTopicArn' => '<string>', // REQUIRED
    'SourceIds' => ['<string>', ...],
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Enabled
Type: boolean

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

EventCategories
Type: Array of strings

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

Severity
Type: string

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

SnsTopicArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

SourceIds
Type: Array of strings

A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

SourceType
Type: string

The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

SubscriptionName
Required: Yes
Type: string

The name of the event subscription to be created.

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.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'Severity' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => <DateTime>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
EventSubscription
Type: EventSubscription structure

Describes event subscriptions.

Errors

EventSubscriptionQuotaExceededFault:

The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

SubscriptionAlreadyExistFault:

There is already an existing event notification subscription with the specified name.

SNSInvalidTopicFault:

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

SNSNoAuthorizationFault:

You do not have permission to publish to the specified Amazon SNS topic.

SNSTopicArnNotFoundFault:

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

SubscriptionEventIdNotFoundFault:

An Amazon Redshift event with the specified event ID does not exist.

SubscriptionCategoryNotFoundFault:

The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.

SubscriptionSeverityNotFoundFault:

The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.

SourceNotFoundFault:

The specified Amazon Redshift event source could not be found.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

CreateHsmClientCertificate

$result = $client->createHsmClientCertificate([/* ... */]);
$promise = $client->createHsmClientCertificateAsync([/* ... */]);

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->createHsmClientCertificate([
    'HsmClientCertificateIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
HsmClientCertificateIdentifier
Required: Yes
Type: string

The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'HsmClientCertificate' => [
        'HsmClientCertificateIdentifier' => '<string>',
        'HsmClientCertificatePublicKey' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
HsmClientCertificate
Type: HsmClientCertificate structure

Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

Errors

HsmClientCertificateAlreadyExistsFault:

There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

HsmClientCertificateQuotaExceededFault:

The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

CreateHsmConfiguration

$result = $client->createHsmConfiguration([/* ... */]);
$promise = $client->createHsmConfigurationAsync([/* ... */]);

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->createHsmConfiguration([
    'Description' => '<string>', // REQUIRED
    'HsmConfigurationIdentifier' => '<string>', // REQUIRED
    'HsmIpAddress' => '<string>', // REQUIRED
    'HsmPartitionName' => '<string>', // REQUIRED
    'HsmPartitionPassword' => '<string>', // REQUIRED
    'HsmServerPublicCertificate' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
Required: Yes
Type: string

A text description of the HSM configuration to be created.

HsmConfigurationIdentifier
Required: Yes
Type: string

The identifier to be assigned to the new Amazon Redshift HSM configuration.

HsmIpAddress
Required: Yes
Type: string

The IP address that the Amazon Redshift cluster must use to access the HSM.

HsmPartitionName
Required: Yes
Type: string

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

HsmPartitionPassword
Required: Yes
Type: string

The password required to access the HSM partition.

HsmServerPublicCertificate
Required: Yes
Type: string

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'HsmConfiguration' => [
        'Description' => '<string>',
        'HsmConfigurationIdentifier' => '<string>',
        'HsmIpAddress' => '<string>',
        'HsmPartitionName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
HsmConfiguration
Type: HsmConfiguration structure

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

Errors

HsmConfigurationAlreadyExistsFault:

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

HsmConfigurationQuotaExceededFault:

The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

CreateRedshiftIdcApplication

$result = $client->createRedshiftIdcApplication([/* ... */]);
$promise = $client->createRedshiftIdcApplicationAsync([/* ... */]);

Creates an Amazon Redshift application for use with IAM Identity Center.

Parameter Syntax

$result = $client->createRedshiftIdcApplication([
    'AuthorizedTokenIssuerList' => [
        [
            'AuthorizedAudiencesList' => ['<string>', ...],
            'TrustedTokenIssuerArn' => '<string>',
        ],
        // ...
    ],
    'IamRoleArn' => '<string>', // REQUIRED
    'IdcDisplayName' => '<string>', // REQUIRED
    'IdcInstanceArn' => '<string>', // REQUIRED
    'IdentityNamespace' => '<string>',
    'RedshiftIdcApplicationName' => '<string>', // REQUIRED
    'ServiceIntegrations' => [
        [
            'LakeFormation' => [
                [
                    'LakeFormationQuery' => [
                        'Authorization' => 'Enabled|Disabled', // REQUIRED
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
AuthorizedTokenIssuerList
Type: Array of AuthorizedTokenIssuer structures

The token issuer list for the Amazon Redshift IAM Identity Center application instance.

IamRoleArn
Required: Yes
Type: string

The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API.

IdcDisplayName
Required: Yes
Type: string

The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console.

IdcInstanceArn
Required: Yes
Type: string

The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.

IdentityNamespace
Type: string

The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token.

RedshiftIdcApplicationName
Required: Yes
Type: string

The name of the Redshift application in IAM Identity Center.

ServiceIntegrations
Type: Array of ServiceIntegrationsUnion structures

A collection of service integrations for the Redshift IAM Identity Center application.

Result Syntax

[
    'RedshiftIdcApplication' => [
        'AuthorizedTokenIssuerList' => [
            [
                'AuthorizedAudiencesList' => ['<string>', ...],
                'TrustedTokenIssuerArn' => '<string>',
            ],
            // ...
        ],
        'IamRoleArn' => '<string>',
        'IdcDisplayName' => '<string>',
        'IdcInstanceArn' => '<string>',
        'IdcManagedApplicationArn' => '<string>',
        'IdcOnboardStatus' => '<string>',
        'IdentityNamespace' => '<string>',
        'RedshiftIdcApplicationArn' => '<string>',
        'RedshiftIdcApplicationName' => '<string>',
        'ServiceIntegrations' => [
            [
                'LakeFormation' => [
                    [
                        'LakeFormationQuery' => [
                            'Authorization' => 'Enabled|Disabled',
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
RedshiftIdcApplication
Type: RedshiftIdcApplication structure

Contains properties for the Redshift IDC application.

Errors

RedshiftIdcApplicationAlreadyExistsFault:

The application you attempted to add already exists.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceAccessDeniedFault:

A dependent service denied access for the integration.

RedshiftIdcApplicationQuotaExceededFault:

The maximum number of Redshift IAM Identity Center applications was exceeded.

CreateScheduledAction

$result = $client->createScheduledAction([/* ... */]);
$promise = $client->createScheduledActionAsync([/* ... */]);

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

Parameter Syntax

$result = $client->createScheduledAction([
    'Enable' => true || false,
    'EndTime' => <integer || string || DateTime>,
    'IamRole' => '<string>', // REQUIRED
    'Schedule' => '<string>', // REQUIRED
    'ScheduledActionDescription' => '<string>',
    'ScheduledActionName' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>,
    'TargetAction' => [ // REQUIRED
        'PauseCluster' => [
            'ClusterIdentifier' => '<string>', // REQUIRED
        ],
        'ResizeCluster' => [
            'Classic' => true || false,
            'ClusterIdentifier' => '<string>', // REQUIRED
            'ClusterType' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'ReservedNodeId' => '<string>',
            'TargetReservedNodeOfferingId' => '<string>',
        ],
        'ResumeCluster' => [
            'ClusterIdentifier' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
Enable
Type: boolean

If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

IamRole
Required: Yes
Type: string

The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Schedule
Required: Yes
Type: string

The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

ScheduledActionDescription
Type: string

The description of the scheduled action.

ScheduledActionName
Required: Yes
Type: string

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

TargetAction
Required: Yes
Type: ScheduledActionType structure

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

Result Syntax

[
    'EndTime' => <DateTime>,
    'IamRole' => '<string>',
    'NextInvocations' => [<DateTime>, ...],
    'Schedule' => '<string>',
    'ScheduledActionDescription' => '<string>',
    'ScheduledActionName' => '<string>',
    'StartTime' => <DateTime>,
    'State' => 'ACTIVE|DISABLED',
    'TargetAction' => [
        'PauseCluster' => [
            'ClusterIdentifier' => '<string>',
        ],
        'ResizeCluster' => [
            'Classic' => true || false,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'ReservedNodeId' => '<string>',
            'TargetReservedNodeOfferingId' => '<string>',
        ],
        'ResumeCluster' => [
            'ClusterIdentifier' => '<string>',
        ],
    ],
]

Result Details

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

IamRole
Type: string

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

NextInvocations
Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s

List of times when the scheduled action will run.

Schedule
Type: string

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

ScheduledActionDescription
Type: string

The description of the scheduled action.

ScheduledActionName
Type: string

The name of the scheduled action.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

State
Type: string

The state of the scheduled action. For example, DISABLED.

TargetAction
Type: ScheduledActionType structure

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ScheduledActionAlreadyExistsFault:

The scheduled action already exists.

ScheduledActionQuotaExceededFault:

The quota for scheduled actions exceeded.

ScheduledActionTypeUnsupportedFault:

The action type specified for a scheduled action is not supported.

InvalidScheduleFault:

The schedule you submitted isn't valid.

InvalidScheduledActionFault:

The scheduled action is not valid.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

UnsupportedOperationFault:

The requested operation isn't supported.

CreateSnapshotCopyGrant

$result = $client->createSnapshotCopyGrant([/* ... */]);
$promise = $client->createSnapshotCopyGrantAsync([/* ... */]);

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->createSnapshotCopyGrant([
    'KmsKeyId' => '<string>',
    'SnapshotCopyGrantName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
KmsKeyId
Type: string

The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

SnapshotCopyGrantName
Required: Yes
Type: string

The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

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 Amazon Web Services account.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'SnapshotCopyGrant' => [
        'KmsKeyId' => '<string>',
        'SnapshotCopyGrantName' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
SnapshotCopyGrant
Type: SnapshotCopyGrant structure

The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Errors

SnapshotCopyGrantAlreadyExistsFault:

The snapshot copy grant can't be created because a grant with the same name already exists.

SnapshotCopyGrantQuotaExceededFault:

The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.

LimitExceededFault:

The encryption key has exceeded its grant limit in Amazon Web Services KMS.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

InvalidTagFault:

The tag is invalid.

DependentServiceRequestThrottlingFault:

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

CreateSnapshotSchedule

$result = $client->createSnapshotSchedule([/* ... */]);
$promise = $client->createSnapshotScheduleAsync([/* ... */]);

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

Parameter Syntax

$result = $client->createSnapshotSchedule([
    'DryRun' => true || false,
    'NextInvocations' => <integer>,
    'ScheduleDefinitions' => ['<string>', ...],
    'ScheduleDescription' => '<string>',
    'ScheduleIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
DryRun
Type: boolean

NextInvocations
Type: int

ScheduleDefinitions
Type: Array of strings

The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".

ScheduleDescription
Type: string

The description of the snapshot schedule.

ScheduleIdentifier
Type: string

A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

Tags
Type: Array of Tag structures

An optional set of tags you can use to search for the schedule.

Result Syntax

[
    'AssociatedClusterCount' => <integer>,
    'AssociatedClusters' => [
        [
            'ClusterIdentifier' => '<string>',
            'ScheduleAssociationState' => 'MODIFYING|ACTIVE|FAILED',
        ],
        // ...
    ],
    'NextInvocations' => [<DateTime>, ...],
    'ScheduleDefinitions' => ['<string>', ...],
    'ScheduleDescription' => '<string>',
    'ScheduleIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
AssociatedClusterCount
Type: int

The number of clusters associated with the schedule.

AssociatedClusters
Type: Array of ClusterAssociatedToSchedule structures

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

NextInvocations
Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s

ScheduleDefinitions
Type: Array of strings

A list of ScheduleDefinitions.

ScheduleDescription
Type: string

The description of the schedule.

ScheduleIdentifier
Type: string

A unique identifier for the schedule.

Tags
Type: Array of Tag structures

An optional set of tags describing the schedule.

Errors

SnapshotScheduleAlreadyExistsFault:

The specified snapshot schedule already exists.

InvalidScheduleFault:

The schedule you submitted isn't valid.

SnapshotScheduleQuotaExceededFault:

You have exceeded the quota of snapshot schedules.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

ScheduleDefinitionTypeUnsupportedFault:

The definition you submitted is not supported.

InvalidTagFault:

The tag is invalid.

CreateTags

$result = $client->createTags([/* ... */]);
$promise = $client->createTagsAsync([/* ... */]);

Adds tags to a cluster.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.

If you specify a key that already exists for the resource, the value for that key will be updated with the new value.

Parameter Syntax

$result = $client->createTags([
    'ResourceName' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceName
Required: Yes
Type: string

The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

Tags
Required: Yes
Type: Array of Tag structures

One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TagLimitExceededFault:

You have exceeded the number of tags allowed.

ResourceNotFoundFault:

The resource could not be found.

InvalidTagFault:

The tag is invalid.

InvalidClusterStateFault:

The specified cluster is not in the available state.

CreateUsageLimit

$result = $client->createUsageLimit([/* ... */]);
$promise = $client->createUsageLimitAsync([/* ... */]);

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Parameter Syntax

$result = $client->createUsageLimit([
    'Amount' => <integer>, // REQUIRED
    'BreachAction' => 'log|emit-metric|disable',
    'ClusterIdentifier' => '<string>', // REQUIRED
    'FeatureType' => 'spectrum|concurrency-scaling|cross-region-datasharing', // REQUIRED
    'LimitType' => 'time|data-scanned', // REQUIRED
    'Period' => 'daily|weekly|monthly',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Amount
Required: Yes
Type: long (int|float)

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.

BreachAction
Type: string

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster that you want to limit usage.

FeatureType
Required: Yes
Type: string

The Amazon Redshift feature that you want to limit.

LimitType
Required: Yes
Type: string

The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.

Period
Type: string

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Tags
Type: Array of Tag structures

A list of tag instances.

Result Syntax

[
    'Amount' => <integer>,
    'BreachAction' => 'log|emit-metric|disable',
    'ClusterIdentifier' => '<string>',
    'FeatureType' => 'spectrum|concurrency-scaling|cross-region-datasharing',
    'LimitType' => 'time|data-scanned',
    'Period' => 'daily|weekly|monthly',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UsageLimitId' => '<string>',
]

Result Details

Members
Amount
Type: long (int|float)

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

BreachAction
Type: string

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

ClusterIdentifier
Type: string

The identifier of the cluster with a usage limit.

FeatureType
Type: string

The Amazon Redshift feature to which the limit applies.

LimitType
Type: string

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Period
Type: string

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Tags
Type: Array of Tag structures

A list of tag instances.

UsageLimitId
Type: string

The identifier of the usage limit.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

LimitExceededFault:

The encryption key has exceeded its grant limit in Amazon Web Services KMS.

UsageLimitAlreadyExistsFault:

The usage limit already exists.

InvalidUsageLimitFault:

The usage limit is not valid.

TagLimitExceededFault:

You have exceeded the number of tags allowed.

UnsupportedOperationFault:

The requested operation isn't supported.

DeauthorizeDataShare

$result = $client->deauthorizeDataShare([/* ... */]);
$promise = $client->deauthorizeDataShareAsync([/* ... */]);

From a datashare producer account, removes authorization from the specified datashare.

Parameter Syntax

$result = $client->deauthorizeDataShare([
    'ConsumerIdentifier' => '<string>', // REQUIRED
    'DataShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConsumerIdentifier
Required: Yes
Type: string

The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

DataShareArn
Required: Yes
Type: string

The namespace Amazon Resource Name (ARN) of the datashare to remove authorization from.

Result Syntax

[
    'AllowPubliclyAccessibleConsumers' => true || false,
    'DataShareArn' => '<string>',
    'DataShareAssociations' => [
        [
            'ConsumerAcceptedWrites' => true || false,
            'ConsumerIdentifier' => '<string>',
            'ConsumerRegion' => '<string>',
            'CreatedDate' => <DateTime>,
            'ProducerAllowedWrites' => true || false,
            'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
            'StatusChangeDate' => <DateTime>,
        ],
        // ...
    ],
    'ManagedBy' => '<string>',
    'ProducerArn' => '<string>',
]

Result Details

Members
AllowPubliclyAccessibleConsumers
Type: boolean

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DataShareArn
Type: string

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

DataShareAssociations
Type: Array of DataShareAssociation structures

A value that specifies when the datashare has an association between producer and data consumers.

ManagedBy
Type: string

The identifier of a datashare to show its managing entity.

ProducerArn
Type: string

The Amazon Resource Name (ARN) of the producer namespace.

Errors

InvalidDataShareFault:

There is an error with the datashare.

DeleteAuthenticationProfile

$result = $client->deleteAuthenticationProfile([/* ... */]);
$promise = $client->deleteAuthenticationProfileAsync([/* ... */]);

Deletes an authentication profile.

Parameter Syntax

$result = $client->deleteAuthenticationProfile([
    'AuthenticationProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
AuthenticationProfileName
Required: Yes
Type: string

The name of the authentication profile to delete.

Result Syntax

[
    'AuthenticationProfileName' => '<string>',
]

Result Details

Members
AuthenticationProfileName
Type: string

The name of the authentication profile that was deleted.

Errors

AuthenticationProfileNotFoundFault:

The authentication profile can't be found.

InvalidAuthenticationProfileRequestFault:

The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->deleteCluster([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'FinalClusterSnapshotIdentifier' => '<string>',
    'FinalClusterSnapshotRetentionPeriod' => <integer>,
    'SkipFinalClusterSnapshot' => true || false,
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

FinalClusterSnapshotIdentifier
Type: string

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

FinalClusterSnapshotRetentionPeriod
Type: int

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.

SkipFinalClusterSnapshot
Type: boolean

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

ClusterSnapshotAlreadyExistsFault:

The value specified as a snapshot identifier is already used by an existing snapshot.

ClusterSnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of cluster snapshots.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

DeleteClusterParameterGroup

$result = $client->deleteClusterParameterGroup([/* ... */]);
$promise = $client->deleteClusterParameterGroupAsync([/* ... */]);

Deletes a specified Amazon Redshift parameter group.

You cannot delete a parameter group if it is associated with a cluster.

Parameter Syntax

$result = $client->deleteClusterParameterGroup([
    'ParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ParameterGroupName
Required: Yes
Type: string

The name of the parameter group to be deleted.

Constraints:

  • Must be the name of an existing cluster parameter group.

  • Cannot delete a default cluster parameter group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidClusterParameterGroupStateFault:

The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

ClusterParameterGroupNotFoundFault:

The parameter group name does not refer to an existing parameter group.

DeleteClusterSecurityGroup

$result = $client->deleteClusterSecurityGroup([/* ... */]);
$promise = $client->deleteClusterSecurityGroupAsync([/* ... */]);

Deletes an Amazon Redshift security group.

You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->deleteClusterSecurityGroup([
    'ClusterSecurityGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterSecurityGroupName
Required: Yes
Type: string

The name of the cluster security group to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidClusterSecurityGroupStateFault:

The state of the cluster security group is not available.

ClusterSecurityGroupNotFoundFault:

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

DeleteClusterSnapshot

$result = $client->deleteClusterSnapshot([/* ... */]);
$promise = $client->deleteClusterSnapshotAsync([/* ... */]);

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

Parameter Syntax

$result = $client->deleteClusterSnapshot([
    'SnapshotClusterIdentifier' => '<string>',
    'SnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
SnapshotClusterIdentifier
Type: string

The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Constraints: Must be the name of valid cluster.

SnapshotIdentifier
Required: Yes
Type: string

The unique identifier of the manual snapshot to be deleted.

Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.

Result Syntax

[
    'Snapshot' => [
        'AccountsWithRestoreAccess' => [
            [
                'AccountAlias' => '<string>',
                'AccountId' => '<string>',
            ],
            // ...
        ],
        'ActualIncrementalBackupSizeInMegaBytes' => <float>,
        'AvailabilityZone' => '<string>',
        'BackupProgressInMegaBytes' => <float>,
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterVersion' => '<string>',
        'CurrentBackupRateInMegaBytesPerSecond' => <float>,
        'DBName' => '<string>',
        'ElapsedTimeInSeconds' => <integer>,
        'Encrypted' => true || false,
        'EncryptedWithHSM' => true || false,
        'EngineFullVersion' => '<string>',
        'EnhancedVpcRouting' => true || false,
        'EstimatedSecondsToCompletion' => <integer>,
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRemainingDays' => <integer>,
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'OwnerAccount' => '<string>',
        'Port' => <integer>,
        'RestorableNodeTypes' => ['<string>', ...],
        'SnapshotArn' => '<string>',
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotIdentifier' => '<string>',
        'SnapshotRetentionStartTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalBackupSizeInMegaBytes' => <float>,
        'VpcId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

Describes a snapshot.

Errors

InvalidClusterSnapshotStateFault:

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

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

DeleteClusterSubnetGroup

$result = $client->deleteClusterSubnetGroup([/* ... */]);
$promise = $client->deleteClusterSubnetGroupAsync([/* ... */]);

Deletes the specified cluster subnet group.

Parameter Syntax

$result = $client->deleteClusterSubnetGroup([
    'ClusterSubnetGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterSubnetGroupName
Required: Yes
Type: string

The name of the cluster subnet group name to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidClusterSubnetGroupStateFault:

The cluster subnet group cannot be deleted because it is in use.

InvalidClusterSubnetStateFault:

The state of the subnet is invalid.

ClusterSubnetGroupNotFoundFault:

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

DeleteCustomDomainAssociation

$result = $client->deleteCustomDomainAssociation([/* ... */]);
$promise = $client->deleteCustomDomainAssociationAsync([/* ... */]);

Contains information about deleting a custom domain association for a cluster.

Parameter Syntax

$result = $client->deleteCustomDomainAssociation([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'CustomDomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster to delete a custom domain association for.

CustomDomainName
Required: Yes
Type: string

The custom domain name for the custom domain association.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnsupportedOperationFault:

The requested operation isn't supported.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

CustomCnameAssociationFault:

An error occurred when an attempt was made to change the custom domain association.

CustomDomainAssociationNotFoundFault:

An error occurred. The custom domain name couldn't be found.

DeleteEndpointAccess

$result = $client->deleteEndpointAccess([/* ... */]);
$promise = $client->deleteEndpointAccessAsync([/* ... */]);

Deletes a Redshift-managed VPC endpoint.

Parameter Syntax

$result = $client->deleteEndpointAccess([
    'EndpointName' => '<string>', // REQUIRED
]);

Parameter Details

Members
EndpointName
Required: Yes
Type: string

The Redshift-managed VPC endpoint to delete.

Result Syntax

[
    'Address' => '<string>',
    'ClusterIdentifier' => '<string>',
    'EndpointCreateTime' => <DateTime>,
    'EndpointName' => '<string>',
    'EndpointStatus' => '<string>',
    'Port' => <integer>,
    'ResourceOwner' => '<string>',
    'SubnetGroupName' => '<string>',
    'VpcEndpoint' => [
        'NetworkInterfaces' => [
            [
                'AvailabilityZone' => '<string>',
                'Ipv6Address' => '<string>',
                'NetworkInterfaceId' => '<string>',
                'PrivateIpAddress' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointId' => '<string>',
        'VpcId' => '<string>',
    ],
    'VpcSecurityGroups' => [
        [
            'Status' => '<string>',
            'VpcSecurityGroupId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Address
Type: string

The DNS address of the endpoint.

ClusterIdentifier
Type: string

The cluster identifier of the cluster associated with the endpoint.

EndpointCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) that the endpoint was created.

EndpointName
Type: string

The name of the endpoint.

EndpointStatus
Type: string

The status of the endpoint.

Port
Type: int

The port number on which the cluster accepts incoming connections.

ResourceOwner
Type: string

The Amazon Web Services account ID of the owner of the cluster.

SubnetGroupName
Type: string

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

VpcEndpoint
Type: VpcEndpoint structure

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcSecurityGroups
Type: Array of VpcSecurityGroupMembership structures

The security groups associated with the endpoint.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidEndpointStateFault:

The status of the endpoint is not valid.

InvalidClusterSecurityGroupStateFault:

The state of the cluster security group is not available.

EndpointNotFoundFault:

The endpoint name doesn't refer to an existing endpoint.

InvalidClusterStateFault:

The specified cluster is not in the available state.

DeleteEventSubscription

$result = $client->deleteEventSubscription([/* ... */]);
$promise = $client->deleteEventSubscriptionAsync([/* ... */]);

Deletes an Amazon Redshift event notification subscription.

Parameter Syntax

$result = $client->deleteEventSubscription([
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Members
SubscriptionName
Required: Yes
Type: string

The name of the Amazon Redshift event notification subscription to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

SubscriptionNotFoundFault:

An Amazon Redshift event notification subscription with the specified name does not exist.

InvalidSubscriptionStateFault:

The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.

DeleteHsmClientCertificate

$result = $client->deleteHsmClientCertificate([/* ... */]);
$promise = $client->deleteHsmClientCertificateAsync([/* ... */]);

Deletes the specified HSM client certificate.

Parameter Syntax

$result = $client->deleteHsmClientCertificate([
    'HsmClientCertificateIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
HsmClientCertificateIdentifier
Required: Yes
Type: string

The identifier of the HSM client certificate to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidHsmClientCertificateStateFault:

The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

HsmClientCertificateNotFoundFault:

There is no Amazon Redshift HSM client certificate with the specified identifier.

DeleteHsmConfiguration

$result = $client->deleteHsmConfiguration([/* ... */]);
$promise = $client->deleteHsmConfigurationAsync([/* ... */]);

Deletes the specified Amazon Redshift HSM configuration.

Parameter Syntax

$result = $client->deleteHsmConfiguration([
    'HsmConfigurationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
HsmConfigurationIdentifier
Required: Yes
Type: string

The identifier of the Amazon Redshift HSM configuration to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidHsmConfigurationStateFault:

The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

HsmConfigurationNotFoundFault:

There is no Amazon Redshift HSM configuration with the specified identifier.

DeletePartner

$result = $client->deletePartner([/* ... */]);
$promise = $client->deletePartnerAsync([/* ... */]);

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

Parameter Syntax

$result = $client->deletePartner([
    'AccountId' => '<string>', // REQUIRED
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DatabaseName' => '<string>', // REQUIRED
    'PartnerName' => '<string>', // REQUIRED
]);

Parameter Details

Members
AccountId
Required: Yes
Type: string

The Amazon Web Services account ID that owns the cluster.

ClusterIdentifier
Required: Yes
Type: string

The cluster identifier of the cluster that receives data from the partner.

DatabaseName
Required: Yes
Type: string

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

PartnerName
Required: Yes
Type: string

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

Result Syntax

[
    'DatabaseName' => '<string>',
    'PartnerName' => '<string>',
]

Result Details

Members
DatabaseName
Type: string

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

PartnerName
Type: string

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

Errors

PartnerNotFoundFault:

The name of the partner was not found.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnauthorizedPartnerIntegrationFault:

The partner integration is not authorized.

UnsupportedOperationFault:

The requested operation isn't supported.

DeleteRedshiftIdcApplication

$result = $client->deleteRedshiftIdcApplication([/* ... */]);
$promise = $client->deleteRedshiftIdcApplicationAsync([/* ... */]);

Deletes an Amazon Redshift IAM Identity Center application.

Parameter Syntax

$result = $client->deleteRedshiftIdcApplication([
    'RedshiftIdcApplicationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
RedshiftIdcApplicationArn
Required: Yes
Type: string

The ARN for a deleted Amazon Redshift IAM Identity Center application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RedshiftIdcApplicationNotExistsFault:

The application you attempted to find doesn't exist.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceAccessDeniedFault:

A dependent service denied access for the integration.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource policy for a specified resource.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource of which its resource policy is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundFault:

The resource could not be found.

UnsupportedOperationFault:

The requested operation isn't supported.

DeleteScheduledAction

$result = $client->deleteScheduledAction([/* ... */]);
$promise = $client->deleteScheduledActionAsync([/* ... */]);

Deletes a scheduled action.

Parameter Syntax

$result = $client->deleteScheduledAction([
    'ScheduledActionName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ScheduledActionName
Required: Yes
Type: string

The name of the scheduled action to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ScheduledActionNotFoundFault:

The scheduled action cannot be found.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

DeleteSnapshotCopyGrant

$result = $client->deleteSnapshotCopyGrant([/* ... */]);
$promise = $client->deleteSnapshotCopyGrantAsync([/* ... */]);

Deletes the specified snapshot copy grant.

Parameter Syntax

$result = $client->deleteSnapshotCopyGrant([
    'SnapshotCopyGrantName' => '<string>', // REQUIRED
]);

Parameter Details

Members
SnapshotCopyGrantName
Required: Yes
Type: string

The name of the snapshot copy grant to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidSnapshotCopyGrantStateFault:

The snapshot copy grant can't be deleted because it is used by one or more clusters.

SnapshotCopyGrantNotFoundFault:

The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.

DeleteSnapshotSchedule

$result = $client->deleteSnapshotSchedule([/* ... */]);
$promise = $client->deleteSnapshotScheduleAsync([/* ... */]);

Deletes a snapshot schedule.

Parameter Syntax

$result = $client->deleteSnapshotSchedule([
    'ScheduleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ScheduleIdentifier
Required: Yes
Type: string

A unique identifier of the snapshot schedule to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidClusterSnapshotScheduleStateFault:

The cluster snapshot schedule state is not valid.

SnapshotScheduleNotFoundFault:

We could not find the specified snapshot schedule.

DeleteTags

$result = $client->deleteTags([/* ... */]);
$promise = $client->deleteTagsAsync([/* ... */]);

Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

Parameter Syntax

$result = $client->deleteTags([
    'ResourceName' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceName
Required: Yes
Type: string

The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

TagKeys
Required: Yes
Type: Array of strings

The tag key that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidTagFault:

The tag is invalid.

DeleteUsageLimit

$result = $client->deleteUsageLimit([/* ... */]);
$promise = $client->deleteUsageLimitAsync([/* ... */]);

Deletes a usage limit from a cluster.

Parameter Syntax

$result = $client->deleteUsageLimit([
    'UsageLimitId' => '<string>', // REQUIRED
]);

Parameter Details

Members
UsageLimitId
Required: Yes
Type: string

The identifier of the usage limit to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UsageLimitNotFoundFault:

The usage limit identifier can't be found.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeAccountAttributes

$result = $client->describeAccountAttributes([/* ... */]);
$promise = $client->describeAccountAttributesAsync([/* ... */]);

Returns a list of attributes attached to an account

Parameter Syntax

$result = $client->describeAccountAttributes([
    'AttributeNames' => ['<string>', ...],
]);

Parameter Details

Members
AttributeNames
Type: Array of strings

A list of attribute names.

Result Syntax

[
    'AccountAttributes' => [
        [
            'AttributeName' => '<string>',
            'AttributeValues' => [
                [
                    'AttributeValue' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
AccountAttributes
Type: Array of AccountAttribute structures

A list of attributes assigned to an account.

Errors

There are no errors described for this operation.

DescribeAuthenticationProfiles

$result = $client->describeAuthenticationProfiles([/* ... */]);
$promise = $client->describeAuthenticationProfilesAsync([/* ... */]);

Describes an authentication profile.

Parameter Syntax

$result = $client->describeAuthenticationProfiles([
    'AuthenticationProfileName' => '<string>',
]);

Parameter Details

Members
AuthenticationProfileName
Type: string

The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.

Result Syntax

[
    'AuthenticationProfiles' => [
        [
            'AuthenticationProfileContent' => '<string>',
            'AuthenticationProfileName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
AuthenticationProfiles
Type: Array of AuthenticationProfile structures

The list of authentication profiles.

Errors

AuthenticationProfileNotFoundFault:

The authentication profile can't be found.

InvalidAuthenticationProfileRequestFault:

The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.

DescribeClusterDbRevisions

$result = $client->describeClusterDbRevisions([/* ... */]);
$promise = $client->describeClusterDbRevisionsAsync([/* ... */]);

Returns an array of ClusterDbRevision objects.

Parameter Syntax

$result = $client->describeClusterDbRevisions([
    'ClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members
ClusterIdentifier
Type: string

A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

Marker
Type: string

An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

Default: 100

Constraints: minimum 20, maximum 100.

Result Syntax

[
    'ClusterDbRevisions' => [
        [
            'ClusterIdentifier' => '<string>',
            'CurrentDatabaseRevision' => '<string>',
            'DatabaseRevisionReleaseDate' => <DateTime>,
            'RevisionTargets' => [
                [
                    'DatabaseRevision' => '<string>',
                    'DatabaseRevisionReleaseDate' => <DateTime>,
                    'Description' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
ClusterDbRevisions
Type: Array of ClusterDbRevision structures

A list of revisions.

Marker
Type: string

A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

DescribeClusterParameterGroups

$result = $client->describeClusterParameterGroups([/* ... */]);
$promise = $client->describeClusterParameterGroupsAsync([/* ... */]);

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeClusterParameterGroups([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ParameterGroupName' => '<string>',
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ParameterGroupName
Type: string

The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Result Syntax

[
    'Marker' => '<string>',
    'ParameterGroups' => [
        [
            'Description' => '<string>',
            'ParameterGroupFamily' => '<string>',
            'ParameterGroupName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

ParameterGroups
Type: Array of ClusterParameterGroup structures

A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

Errors

ClusterParameterGroupNotFoundFault:

The parameter group name does not refer to an existing parameter group.

InvalidTagFault:

The tag is invalid.

DescribeClusterParameters

$result = $client->describeClusterParameters([/* ... */]);
$promise = $client->describeClusterParametersAsync([/* ... */]);

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->describeClusterParameters([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ParameterGroupName' => '<string>', // REQUIRED
    'Source' => '<string>',
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ParameterGroupName
Required: Yes
Type: string

The name of a cluster parameter group for which to return details.

Source
Type: string

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Result Syntax

[
    'Marker' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ApplyType' => 'static|dynamic',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Parameters
Type: Array of Parameter structures

A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

Errors

ClusterParameterGroupNotFoundFault:

The parameter group name does not refer to an existing parameter group.

DescribeClusterSecurityGroups

$result = $client->describeClusterSecurityGroups([/* ... */]);
$promise = $client->describeClusterSecurityGroupsAsync([/* ... */]);

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeClusterSecurityGroups([
    'ClusterSecurityGroupName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
ClusterSecurityGroupName
Type: string

The name of a cluster security group for which you are requesting details. You must specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

Example: securitygroup1

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You must specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

Result Syntax

[
    'ClusterSecurityGroups' => [
        [
            'ClusterSecurityGroupName' => '<string>',
            'Description' => '<string>',
            'EC2SecurityGroups' => [
                [
                    'EC2SecurityGroupName' => '<string>',
                    'EC2SecurityGroupOwnerId' => '<string>',
                    'Status' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'IPRanges' => [
                [
                    'CIDRIP' => '<string>',
                    'Status' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
ClusterSecurityGroups
Type: Array of ClusterSecurityGroup structures

A list of ClusterSecurityGroup instances.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

ClusterSecurityGroupNotFoundFault:

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

InvalidTagFault:

The tag is invalid.

DescribeClusterSnapshots

$result = $client->describeClusterSnapshots([/* ... */]);
$promise = $client->describeClusterSnapshotsAsync([/* ... */]);

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeClusterSnapshots([
    'ClusterExists' => true || false,
    'ClusterIdentifier' => '<string>',
    'EndTime' => <integer || string || DateTime>,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'OwnerAccount' => '<string>',
    'SnapshotArn' => '<string>',
    'SnapshotIdentifier' => '<string>',
    'SnapshotType' => '<string>',
    'SortingEntities' => [
        [
            'Attribute' => 'SOURCE_TYPE|TOTAL_SIZE|CREATE_TIME', // REQUIRED
            'SortOrder' => 'ASC|DESC',
        ],
        // ...
    ],
    'StartTime' => <integer || string || DateTime>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
ClusterExists
Type: boolean

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

  • If ClusterExists is set to true, ClusterIdentifier is required.

  • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

ClusterIdentifier
Type: string

The identifier of the cluster which generated the requested snapshots.

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

OwnerAccount
Type: string

The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

SnapshotArn
Type: string

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

SnapshotIdentifier
Type: string

The snapshot identifier of the snapshot about which to return information.

SnapshotType
Type: string

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

SortingEntities
Type: Array of SnapshotSortingEntity structures

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Result Syntax

[
    'Marker' => '<string>',
    'Snapshots' => [
        [
            'AccountsWithRestoreAccess' => [
                [
                    'AccountAlias' => '<string>',
                    'AccountId' => '<string>',
                ],
                // ...
            ],
            'ActualIncrementalBackupSizeInMegaBytes' => <float>,
            'AvailabilityZone' => '<string>',
            'BackupProgressInMegaBytes' => <float>,
            'ClusterCreateTime' => <DateTime>,
            'ClusterIdentifier' => '<string>',
            'ClusterVersion' => '<string>',
            'CurrentBackupRateInMegaBytesPerSecond' => <float>,
            'DBName' => '<string>',
            'ElapsedTimeInSeconds' => <integer>,
            'Encrypted' => true || false,
            'EncryptedWithHSM' => true || false,
            'EngineFullVersion' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'EstimatedSecondsToCompletion' => <integer>,
            'KmsKeyId' => '<string>',
            'MaintenanceTrackName' => '<string>',
            'ManualSnapshotRemainingDays' => <integer>,
            'ManualSnapshotRetentionPeriod' => <integer>,
            'MasterPasswordSecretArn' => '<string>',
            'MasterPasswordSecretKmsKeyId' => '<string>',
            'MasterUsername' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'OwnerAccount' => '<string>',
            'Port' => <integer>,
            'RestorableNodeTypes' => ['<string>', ...],
            'SnapshotArn' => '<string>',
            'SnapshotCreateTime' => <DateTime>,
            'SnapshotIdentifier' => '<string>',
            'SnapshotRetentionStartTime' => <DateTime>,
            'SnapshotType' => '<string>',
            'SourceRegion' => '<string>',
            'Status' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TotalBackupSizeInMegaBytes' => <float>,
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Snapshots
Type: Array of Snapshot structures

A list of Snapshot instances.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

InvalidTagFault:

The tag is invalid.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeClusterSubnetGroups

$result = $client->describeClusterSubnetGroups([/* ... */]);
$promise = $client->describeClusterSubnetGroupsAsync([/* ... */]);

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeClusterSubnetGroups([
    'ClusterSubnetGroupName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
ClusterSubnetGroupName
Type: string

The name of the cluster subnet group for which information is requested.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

Result Syntax

[
    'ClusterSubnetGroups' => [
        [
            'ClusterSubnetGroupName' => '<string>',
            'Description' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                        'SupportedPlatforms' => [
                            [
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'SupportedClusterIpAddressTypes' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
ClusterSubnetGroups
Type: Array of ClusterSubnetGroup structures

A list of ClusterSubnetGroup instances.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

ClusterSubnetGroupNotFoundFault:

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

InvalidTagFault:

The tag is invalid.

DescribeClusterTracks

$result = $client->describeClusterTracks([/* ... */]);
$promise = $client->describeClusterTracksAsync([/* ... */]);

Returns a list of all the available maintenance tracks.

Parameter Syntax

$result = $client->describeClusterTracks([
    'MaintenanceTrackName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members
MaintenanceTrackName
Type: string

The name of the maintenance track.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

An integer value for the maximum number of maintenance tracks to return.

Result Syntax

[
    'MaintenanceTracks' => [
        [
            'DatabaseVersion' => '<string>',
            'MaintenanceTrackName' => '<string>',
            'UpdateTargets' => [
                [
                    'DatabaseVersion' => '<string>',
                    'MaintenanceTrackName' => '<string>',
                    'SupportedOperations' => [
                        [
                            'OperationName' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
MaintenanceTracks
Type: Array of MaintenanceTrack structures

A list of maintenance tracks output by the DescribeClusterTracks operation.

Marker
Type: string

The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Errors

InvalidClusterTrackFault:

The provided cluster track name is not valid.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

DescribeClusterVersions

$result = $client->describeClusterVersions([/* ... */]);
$promise = $client->describeClusterVersionsAsync([/* ... */]);

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->describeClusterVersions([
    'ClusterParameterGroupFamily' => '<string>',
    'ClusterVersion' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members
ClusterParameterGroupFamily
Type: string

The name of a specific cluster parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

ClusterVersion
Type: string

The specific cluster version to return.

Example: 1.0

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Result Syntax

[
    'ClusterVersions' => [
        [
            'ClusterParameterGroupFamily' => '<string>',
            'ClusterVersion' => '<string>',
            'Description' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
ClusterVersions
Type: Array of ClusterVersion structures

A list of Version elements.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

There are no errors described for this operation.

DescribeClusters

$result = $client->describeClusters([/* ... */]);
$promise = $client->describeClustersAsync([/* ... */]);

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.

If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeClusters([
    'ClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Result Syntax

[
    'Clusters' => [
        [
            'AllowVersionUpgrade' => true || false,
            'AquaConfiguration' => [
                'AquaConfigurationStatus' => 'enabled|disabled|auto',
                'AquaStatus' => 'enabled|disabled|applying',
            ],
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'AvailabilityZone' => '<string>',
            'AvailabilityZoneRelocationStatus' => '<string>',
            'ClusterAvailabilityStatus' => '<string>',
            'ClusterCreateTime' => <DateTime>,
            'ClusterIdentifier' => '<string>',
            'ClusterNamespaceArn' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
            'ClusterParameterGroups' => [
                [
                    'ClusterParameterStatusList' => [
                        [
                            'ParameterApplyErrorDescription' => '<string>',
                            'ParameterApplyStatus' => '<string>',
                            'ParameterName' => '<string>',
                        ],
                        // ...
                    ],
                    'ParameterApplyStatus' => '<string>',
                    'ParameterGroupName' => '<string>',
                ],
                // ...
            ],
            'ClusterPublicKey' => '<string>',
            'ClusterRevisionNumber' => '<string>',
            'ClusterSecurityGroups' => [
                [
                    'ClusterSecurityGroupName' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'ClusterSnapshotCopyStatus' => [
                'DestinationRegion' => '<string>',
                'ManualSnapshotRetentionPeriod' => <integer>,
                'RetentionPeriod' => <integer>,
                'SnapshotCopyGrantName' => '<string>',
            ],
            'ClusterStatus' => '<string>',
            'ClusterSubnetGroupName' => '<string>',
            'ClusterVersion' => '<string>',
            'CustomDomainCertificateArn' => '<string>',
            'CustomDomainCertificateExpiryDate' => <DateTime>,
            'CustomDomainName' => '<string>',
            'DBName' => '<string>',
            'DataTransferProgress' => [
                'CurrentRateInMegaBytesPerSecond' => <float>,
                'DataTransferredInMegaBytes' => <integer>,
                'ElapsedTimeInSeconds' => <integer>,
                'EstimatedTimeToCompletionInSeconds' => <integer>,
                'Status' => '<string>',
                'TotalDataInMegaBytes' => <integer>,
            ],
            'DefaultIamRoleArn' => '<string>',
            'DeferredMaintenanceWindows' => [
                [
                    'DeferMaintenanceEndTime' => <DateTime>,
                    'DeferMaintenanceIdentifier' => '<string>',
                    'DeferMaintenanceStartTime' => <DateTime>,
                ],
                // ...
            ],
            'ElasticIpStatus' => [
                'ElasticIp' => '<string>',
                'Status' => '<string>',
            ],
            'ElasticResizeNumberOfNodeOptions' => '<string>',
            'Encrypted' => true || false,
            'Endpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
                'VpcEndpoints' => [
                    [
                        'NetworkInterfaces' => [
                            [
                                'AvailabilityZone' => '<string>',
                                'Ipv6Address' => '<string>',
                                'NetworkInterfaceId' => '<string>',
                                'PrivateIpAddress' => '<string>',
                                'SubnetId' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcEndpointId' => '<string>',
                        'VpcId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'EnhancedVpcRouting' => true || false,
            'ExpectedNextSnapshotScheduleTime' => <DateTime>,
            'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
            'HsmStatus' => [
                'HsmClientCertificateIdentifier' => '<string>',
                'HsmConfigurationIdentifier' => '<string>',
                'Status' => '<string>',
            ],
            'IamRoles' => [
                [
                    'ApplyStatus' => '<string>',
                    'IamRoleArn' => '<string>',
                ],
                // ...
            ],
            'IpAddressType' => '<string>',
            'KmsKeyId' => '<string>',
            'MaintenanceTrackName' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'MasterPasswordSecretArn' => '<string>',
            'MasterPasswordSecretKmsKeyId' => '<string>',
            'MasterUsername' => '<string>',
            'ModifyStatus' => '<string>',
            'MultiAZ' => '<string>',
            'MultiAZSecondary' => [
                'AvailabilityZone' => '<string>',
                'ClusterNodes' => [
                    [
                        'NodeRole' => '<string>',
                        'PrivateIPAddress' => '<string>',
                        'PublicIPAddress' => '<string>',
                    ],
                    // ...
                ],
            ],
            'NextMaintenanceWindowStartTime' => <DateTime>,
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PendingActions' => ['<string>', ...],
            'PendingModifiedValues' => [
                'AutomatedSnapshotRetentionPeriod' => <integer>,
                'ClusterIdentifier' => '<string>',
                'ClusterType' => '<string>',
                'ClusterVersion' => '<string>',
                'EncryptionType' => '<string>',
                'EnhancedVpcRouting' => true || false,
                'MaintenanceTrackName' => '<string>',
                'MasterUserPassword' => '<string>',
                'NodeType' => '<string>',
                'NumberOfNodes' => <integer>,
                'PubliclyAccessible' => true || false,
            ],
            'PreferredMaintenanceWindow' => '<string>',
            'PubliclyAccessible' => true || false,
            'ReservedNodeExchangeStatus' => [
                'RequestTime' => <DateTime>,
                'ReservedNodeExchangeRequestId' => '<string>',
                'SourceReservedNodeCount' => <integer>,
                'SourceReservedNodeId' => '<string>',
                'SourceReservedNodeType' => '<string>',
                'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
                'TargetReservedNodeCount' => <integer>,
                'TargetReservedNodeOfferingId' => '<string>',
                'TargetReservedNodeType' => '<string>',
            ],
            'ResizeInfo' => [
                'AllowCancelResize' => true || false,
                'ResizeType' => '<string>',
            ],
            'RestoreStatus' => [
                'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
                'ElapsedTimeInSeconds' => <integer>,
                'EstimatedTimeToCompletionInSeconds' => <integer>,
                'ProgressInMegaBytes' => <integer>,
                'SnapshotSizeInMegaBytes' => <integer>,
                'Status' => '<string>',
            ],
            'SnapshotScheduleIdentifier' => '<string>',
            'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TotalStorageCapacityInMegaBytes' => <integer>,
            'VpcId' => '<string>',
            'VpcSecurityGroups' => [
                [
                    'Status' => '<string>',
                    'VpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
Clusters
Type: Array of Cluster structures

A list of Cluster objects, where each object describes one cluster.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidTagFault:

The tag is invalid.

DescribeCustomDomainAssociations

$result = $client->describeCustomDomainAssociations([/* ... */]);
$promise = $client->describeCustomDomainAssociationsAsync([/* ... */]);

Contains information about custom domain associations for a cluster.

Parameter Syntax

$result = $client->describeCustomDomainAssociations([
    'CustomDomainCertificateArn' => '<string>',
    'CustomDomainName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members
CustomDomainCertificateArn
Type: string

The certificate Amazon Resource Name (ARN) for the custom domain association.

CustomDomainName
Type: string

The custom domain name for the custom domain association.

Marker
Type: string

The marker for the custom domain association.

MaxRecords
Type: int

The maximum records setting for the associated custom domain.

Result Syntax

[
    'Associations' => [
        [
            'CertificateAssociations' => [
                [
                    'ClusterIdentifier' => '<string>',
                    'CustomDomainName' => '<string>',
                ],
                // ...
            ],
            'CustomDomainCertificateArn' => '<string>',
            'CustomDomainCertificateExpiryDate' => <DateTime>,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
Associations
Type: Array of Association structures

The associations for the custom domain.

Marker
Type: string

The marker for the custom domain association.

Errors

CustomDomainAssociationNotFoundFault:

An error occurred. The custom domain name couldn't be found.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeDataShares

$result = $client->describeDataShares([/* ... */]);
$promise = $client->describeDataSharesAsync([/* ... */]);

Shows the status of any inbound or outbound datashares available in the specified account.

Parameter Syntax

$result = $client->describeDataShares([
    'DataShareArn' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members
DataShareArn
Type: string

The Amazon resource name (ARN) of the datashare to describe details of.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Result Syntax

[
    'DataShares' => [
        [
            'AllowPubliclyAccessibleConsumers' => true || false,
            'DataShareArn' => '<string>',
            'DataShareAssociations' => [
                [
                    'ConsumerAcceptedWrites' => true || false,
                    'ConsumerIdentifier' => '<string>',
                    'ConsumerRegion' => '<string>',
                    'CreatedDate' => <DateTime>,
                    'ProducerAllowedWrites' => true || false,
                    'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
                    'StatusChangeDate' => <DateTime>,
                ],
                // ...
            ],
            'ManagedBy' => '<string>',
            'ProducerArn' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
DataShares
Type: Array of DataShare structures

The results returned from describing datashares.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Errors

InvalidDataShareFault:

There is an error with the datashare.

DescribeDataSharesForConsumer

$result = $client->describeDataSharesForConsumer([/* ... */]);
$promise = $client->describeDataSharesForConsumerAsync([/* ... */]);

Returns a list of datashares where the account identifier being called is a consumer account identifier.

Parameter Syntax

$result = $client->describeDataSharesForConsumer([
    'ConsumerArn' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'Status' => 'ACTIVE|AVAILABLE',
]);

Parameter Details

Members
ConsumerArn
Type: string

The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Status
Type: string

An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

Result Syntax

[
    'DataShares' => [
        [
            'AllowPubliclyAccessibleConsumers' => true || false,
            'DataShareArn' => '<string>',
            'DataShareAssociations' => [
                [
                    'ConsumerAcceptedWrites' => true || false,
                    'ConsumerIdentifier' => '<string>',
                    'ConsumerRegion' => '<string>',
                    'CreatedDate' => <DateTime>,
                    'ProducerAllowedWrites' => true || false,
                    'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
                    'StatusChangeDate' => <DateTime>,
                ],
                // ...
            ],
            'ManagedBy' => '<string>',
            'ProducerArn' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
DataShares
Type: Array of DataShare structures

Shows the results of datashares available for consumers.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Errors

InvalidNamespaceFault:

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

DescribeDataSharesForProducer

$result = $client->describeDataSharesForProducer([/* ... */]);
$promise = $client->describeDataSharesForProducerAsync([/* ... */]);

Returns a list of datashares when the account identifier being called is a producer account identifier.

Parameter Syntax

$result = $client->describeDataSharesForProducer([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ProducerArn' => '<string>',
    'Status' => 'ACTIVE|AUTHORIZED|PENDING_AUTHORIZATION|DEAUTHORIZED|REJECTED',
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

ProducerArn
Type: string

The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares.

Status
Type: string

An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

Result Syntax

[
    'DataShares' => [
        [
            'AllowPubliclyAccessibleConsumers' => true || false,
            'DataShareArn' => '<string>',
            'DataShareAssociations' => [
                [
                    'ConsumerAcceptedWrites' => true || false,
                    'ConsumerIdentifier' => '<string>',
                    'ConsumerRegion' => '<string>',
                    'CreatedDate' => <DateTime>,
                    'ProducerAllowedWrites' => true || false,
                    'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
                    'StatusChangeDate' => <DateTime>,
                ],
                // ...
            ],
            'ManagedBy' => '<string>',
            'ProducerArn' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
DataShares
Type: Array of DataShare structures

Shows the results of datashares available for producers.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Errors

InvalidNamespaceFault:

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

DescribeDefaultClusterParameters

$result = $client->describeDefaultClusterParameters([/* ... */]);
$promise = $client->describeDefaultClusterParametersAsync([/* ... */]);

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->describeDefaultClusterParameters([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ParameterGroupFamily' => '<string>', // REQUIRED
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ParameterGroupFamily
Required: Yes
Type: string

The name of the cluster parameter group family.

Result Syntax

[
    'DefaultClusterParameters' => [
        'Marker' => '<string>',
        'ParameterGroupFamily' => '<string>',
        'Parameters' => [
            [
                'AllowedValues' => '<string>',
                'ApplyType' => 'static|dynamic',
                'DataType' => '<string>',
                'Description' => '<string>',
                'IsModifiable' => true || false,
                'MinimumEngineVersion' => '<string>',
                'ParameterName' => '<string>',
                'ParameterValue' => '<string>',
                'Source' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
DefaultClusterParameters
Type: DefaultClusterParameters structure

Describes the default cluster parameters for a parameter group family.

Errors

There are no errors described for this operation.

DescribeEndpointAccess

$result = $client->describeEndpointAccess([/* ... */]);
$promise = $client->describeEndpointAccessAsync([/* ... */]);

Describes a Redshift-managed VPC endpoint.

Parameter Syntax

$result = $client->describeEndpointAccess([
    'ClusterIdentifier' => '<string>',
    'EndpointName' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ResourceOwner' => '<string>',
    'VpcId' => '<string>',
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The cluster identifier associated with the described endpoint.

EndpointName
Type: string

The name of the endpoint to be described.

Marker
Type: string

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

MaxRecords
Type: int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

ResourceOwner
Type: string

The Amazon Web Services account ID of the owner of the cluster.

VpcId
Type: string

The virtual private cloud (VPC) identifier with access to the cluster.

Result Syntax

[
    'EndpointAccessList' => [
        [
            'Address' => '<string>',
            'ClusterIdentifier' => '<string>',
            'EndpointCreateTime' => <DateTime>,
            'EndpointName' => '<string>',
            'EndpointStatus' => '<string>',
            'Port' => <integer>,
            'ResourceOwner' => '<string>',
            'SubnetGroupName' => '<string>',
            'VpcEndpoint' => [
                'NetworkInterfaces' => [
                    [
                        'AvailabilityZone' => '<string>',
                        'Ipv6Address' => '<string>',
                        'NetworkInterfaceId' => '<string>',
                        'PrivateIpAddress' => '<string>',
                        'SubnetId' => '<string>',
                    ],
                    // ...
                ],
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
            ],
            'VpcSecurityGroups' => [
                [
                    'Status' => '<string>',
                    'VpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
EndpointAccessList
Type: Array of EndpointAccess structures

The list of endpoints with access to the cluster.

Marker
Type: string

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

EndpointNotFoundFault:

The endpoint name doesn't refer to an existing endpoint.

DescribeEndpointAuthorization

$result = $client->describeEndpointAuthorization([/* ... */]);
$promise = $client->describeEndpointAuthorizationAsync([/* ... */]);

Describes an endpoint authorization.

Parameter Syntax

$result = $client->describeEndpointAuthorization([
    'Account' => '<string>',
    'ClusterIdentifier' => '<string>',
    'Grantee' => true || false,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members
Account
Type: string

The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.

ClusterIdentifier
Type: string

The cluster identifier of the cluster to access.

Grantee
Type: boolean

Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.

Marker
Type: string

An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

MaxRecords
Type: int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

Result Syntax

[
    'EndpointAuthorizationList' => [
        [
            'AllowedAllVPCs' => true || false,
            'AllowedVPCs' => ['<string>', ...],
            'AuthorizeTime' => <DateTime>,
            'ClusterIdentifier' => '<string>',
            'ClusterStatus' => '<string>',
            'EndpointCount' => <integer>,
            'Grantee' => '<string>',
            'Grantor' => '<string>',
            'Status' => 'Authorized|Revoking',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
EndpointAuthorizationList
Type: Array of EndpointAuthorization structures

The authorizations to an endpoint.

Marker
Type: string

An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeEventCategories

$result = $client->describeEventCategories([/* ... */]);
$promise = $client->describeEventCategoriesAsync([/* ... */]);

Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

Parameter Syntax

$result = $client->describeEventCategories([
    'SourceType' => '<string>',
]);

Parameter Details

Members
SourceType
Type: string

The source type, such as cluster or parameter group, to which the described event categories apply.

Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.

Result Syntax

[
    'EventCategoriesMapList' => [
        [
            'Events' => [
                [
                    'EventCategories' => ['<string>', ...],
                    'EventDescription' => '<string>',
                    'EventId' => '<string>',
                    'Severity' => '<string>',
                ],
                // ...
            ],
            'SourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
EventCategoriesMapList
Type: Array of EventCategoriesMap structures

A list of event categories descriptions.

Errors

There are no errors described for this operation.

DescribeEventSubscriptions

$result = $client->describeEventSubscriptions([/* ... */]);
$promise = $client->describeEventSubscriptionsAsync([/* ... */]);

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeEventSubscriptions([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SubscriptionName' => '<string>',
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

SubscriptionName
Type: string

The name of the Amazon Redshift event notification subscription to be described.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.

Result Syntax

[
    'EventSubscriptionsList' => [
        [
            'CustSubscriptionId' => '<string>',
            'CustomerAwsId' => '<string>',
            'Enabled' => true || false,
            'EventCategoriesList' => ['<string>', ...],
            'Severity' => '<string>',
            'SnsTopicArn' => '<string>',
            'SourceIdsList' => ['<string>', ...],
            'SourceType' => '<string>',
            'Status' => '<string>',
            'SubscriptionCreationTime' => <DateTime>,
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
EventSubscriptionsList
Type: Array of EventSubscription structures

A list of event subscriptions.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

SubscriptionNotFoundFault:

An Amazon Redshift event notification subscription with the specified name does not exist.

InvalidTagFault:

The tag is invalid.

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SourceIdentifier' => '<string>',
    'SourceType' => 'cluster|cluster-parameter-group|cluster-security-group|cluster-snapshot|scheduled-action',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members
Duration
Type: int

The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

Default: 60

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

SourceIdentifier
Type: string

The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

  • Specify a cluster identifier when SourceType is cluster.

  • Specify a cluster security group name when SourceType is cluster-security-group.

  • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

  • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

SourceType
Type: string

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

  • Specify cluster when SourceIdentifier is a cluster identifier.

  • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

  • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

  • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'EventCategories' => ['<string>', ...],
            'EventId' => '<string>',
            'Message' => '<string>',
            'Severity' => '<string>',
            'SourceIdentifier' => '<string>',
            'SourceType' => 'cluster|cluster-parameter-group|cluster-security-group|cluster-snapshot|scheduled-action',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
Events
Type: Array of Event structures

A list of Event instances.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

There are no errors described for this operation.

DescribeHsmClientCertificates

$result = $client->describeHsmClientCertificates([/* ... */]);
$promise = $client->describeHsmClientCertificatesAsync([/* ... */]);

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeHsmClientCertificates([
    'HsmClientCertificateIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
HsmClientCertificateIdentifier
Type: string

The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your Amazon Web Services account.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

Result Syntax

[
    'HsmClientCertificates' => [
        [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmClientCertificatePublicKey' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
HsmClientCertificates
Type: Array of HsmClientCertificate structures

A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

HsmClientCertificateNotFoundFault:

There is no Amazon Redshift HSM client certificate with the specified identifier.

InvalidTagFault:

The tag is invalid.

DescribeHsmConfigurations

$result = $client->describeHsmConfigurations([/* ... */]);
$promise = $client->describeHsmConfigurationsAsync([/* ... */]);

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeHsmConfigurations([
    'HsmConfigurationIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
HsmConfigurationIdentifier
Type: string

The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your Amazon Web Services account.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

Result Syntax

[
    'HsmConfigurations' => [
        [
            'Description' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'HsmIpAddress' => '<string>',
            'HsmPartitionName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
HsmConfigurations
Type: Array of HsmConfiguration structures

A list of HsmConfiguration objects.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

HsmConfigurationNotFoundFault:

There is no Amazon Redshift HSM configuration with the specified identifier.

InvalidTagFault:

The tag is invalid.

DescribeInboundIntegrations

$result = $client->describeInboundIntegrations([/* ... */]);
$promise = $client->describeInboundIntegrationsAsync([/* ... */]);

Returns a list of inbound integrations.

Parameter Syntax

$result = $client->describeInboundIntegrations([
    'IntegrationArn' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TargetArn' => '<string>',
]);

Parameter Details

Members
IntegrationArn
Type: string

The Amazon Resource Name (ARN) of the inbound integration.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TargetArn
Type: string

The Amazon Resource Name (ARN) of the target of an inbound integration.

Result Syntax

[
    'InboundIntegrations' => [
        [
            'CreateTime' => <DateTime>,
            'Errors' => [
                [
                    'ErrorCode' => '<string>',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
            'IntegrationArn' => '<string>',
            'SourceArn' => '<string>',
            'Status' => 'creating|active|modifying|failed|deleting|syncing|needs_attention',
            'TargetArn' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members
InboundIntegrations
Type: Array of InboundIntegration structures

A list of InboundIntegration instances.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Errors

IntegrationNotFoundFault:

The integration can't be found.

InvalidNamespaceFault:

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

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeLoggingStatus

$result = $client->describeLoggingStatus([/* ... */]);
$promise = $client->describeLoggingStatusAsync([/* ... */]);

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Parameter Syntax

$result = $client->describeLoggingStatus([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster from which to get the logging status.

Example: examplecluster

Result Syntax

[
    'BucketName' => '<string>',
    'LastFailureMessage' => '<string>',
    'LastFailureTime' => <DateTime>,
    'LastSuccessfulDeliveryTime' => <DateTime>,
    'LogDestinationType' => 's3|cloudwatch',
    'LogExports' => ['<string>', ...],
    'LoggingEnabled' => true || false,
    'S3KeyPrefix' => '<string>',
]

Result Details

Members
BucketName
Type: string

The name of the S3 bucket where the log files are stored.

LastFailureMessage
Type: string

The message indicating that logs failed to be delivered.

LastFailureTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time when logs failed to be delivered.

LastSuccessfulDeliveryTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time that logs were delivered.

LogDestinationType
Type: string

The log destination type. An enum with possible values of s3 and cloudwatch.

LogExports
Type: Array of strings

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

LoggingEnabled
Type: boolean

true if logging is on, false if logging is off.

S3KeyPrefix
Type: string

The prefix applied to the log file names.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeNodeConfigurationOptions

$result = $client->describeNodeConfigurationOptions([/* ... */]);
$promise = $client->describeNodeConfigurationOptionsAsync([/* ... */]);

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Parameter Syntax

$result = $client->describeNodeConfigurationOptions([
    'ActionType' => 'restore-cluster|recommend-node-config|resize-cluster', // REQUIRED
    'ClusterIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => 'NodeType|NumberOfNodes|EstimatedDiskUtilizationPercent|Mode',
            'Operator' => 'eq|lt|gt|le|ge|in|between',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'OwnerAccount' => '<string>',
    'SnapshotArn' => '<string>',
    'SnapshotIdentifier' => '<string>',
]);

Parameter Details

Members
ActionType
Required: Yes
Type: string

The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.

ClusterIdentifier
Type: string

The identifier of the cluster to evaluate for possible node configurations.

Filters
Type: Array of NodeConfigurationOptionsFilter structures

A set of name, operator, and value items to filter the results.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 500

Constraints: minimum 100, maximum 500.

OwnerAccount
Type: string

The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

SnapshotArn
Type: string

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

SnapshotIdentifier
Type: string

The identifier of the snapshot to evaluate for possible node configurations.

Result Syntax

[
    'Marker' => '<string>',
    'NodeConfigurationOptionList' => [
        [
            'EstimatedDiskUtilizationPercent' => <float>,
            'Mode' => 'standard|high-performance',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

NodeConfigurationOptionList
Type: Array of NodeConfigurationOption structures

A list of valid node configurations.

Errors

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

InvalidClusterSnapshotStateFault:

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

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

AccessToSnapshotDeniedFault:

The owner of the specified snapshot has not authorized your account to access the snapshot.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeOrderableClusterOptions

$result = $client->describeOrderableClusterOptions([/* ... */]);
$promise = $client->describeOrderableClusterOptionsAsync([/* ... */]);

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->describeOrderableClusterOptions([
    'ClusterVersion' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'NodeType' => '<string>',
]);

Parameter Details

Members
ClusterVersion
Type: string

The version filter value. Specify this parameter to show only the available offerings matching the specified version.

Default: All versions.

Constraints: Must be one of the version returned from DescribeClusterVersions.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

NodeType
Type: string

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

Result Syntax

[
    'Marker' => '<string>',
    'OrderableClusterOptions' => [
        [
            'AvailabilityZones' => [
                [
                    'Name' => '<string>',
                    'SupportedPlatforms' => [
                        [
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'NodeType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

OrderableClusterOptions
Type: Array of OrderableClusterOption structures

An OrderableClusterOption structure containing information about orderable options for the cluster.

Errors

There are no errors described for this operation.

DescribePartners

$result = $client->describePartners([/* ... */]);
$promise = $client->describePartnersAsync([/* ... */]);

Returns information about the partner integrations defined for a cluster.

Parameter Syntax

$result = $client->describePartners([
    'AccountId' => '<string>', // REQUIRED
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DatabaseName' => '<string>',
    'PartnerName' => '<string>',
]);

Parameter Details

Members
AccountId
Required: Yes
Type: string

The Amazon Web Services account ID that owns the cluster.

ClusterIdentifier
Required: Yes
Type: string

The cluster identifier of the cluster whose partner integration is being described.

DatabaseName
Type: string

The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.

PartnerName
Type: string

The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

Result Syntax

[
    'PartnerIntegrationInfoList' => [
        [
            'CreatedAt' => <DateTime>,
            'DatabaseName' => '<string>',
            'PartnerName' => '<string>',
            'Status' => 'Active|Inactive|RuntimeFailure|ConnectionFailure',
            'StatusMessage' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
PartnerIntegrationInfoList
Type: Array of PartnerIntegrationInfo structures

A list of partner integrations.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnauthorizedPartnerIntegrationFault:

The partner integration is not authorized.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeRedshiftIdcApplications

$result = $client->describeRedshiftIdcApplications([/* ... */]);
$promise = $client->describeRedshiftIdcApplicationsAsync([/* ... */]);

Lists the Amazon Redshift IAM Identity Center applications.

Parameter Syntax

$result = $client->describeRedshiftIdcApplications([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'RedshiftIdcApplicationArn' => '<string>',
]);

Parameter Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

RedshiftIdcApplicationArn
Type: string

The ARN for the Redshift application that integrates with IAM Identity Center.

Result Syntax

[
    'Marker' => '<string>',
    'RedshiftIdcApplications' => [
        [
            'AuthorizedTokenIssuerList' => [
                [
                    'AuthorizedAudiencesList' => ['<string>', ...],
                    'TrustedTokenIssuerArn' => '<string>',
                ],
                // ...
            ],
            'IamRoleArn' => '<string>',
            'IdcDisplayName' => '<string>',
            'IdcInstanceArn' => '<string>',
            'IdcManagedApplicationArn' => '<string>',
            'IdcOnboardStatus' => '<string>',
            'IdentityNamespace' => '<string>',
            'RedshiftIdcApplicationArn' => '<string>',
            'RedshiftIdcApplicationName' => '<string>',
            'ServiceIntegrations' => [
                [
                    'LakeFormation' => [
                        [
                            'LakeFormationQuery' => [
                                'Authorization' => 'Enabled|Disabled',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

RedshiftIdcApplications
Type: Array of RedshiftIdcApplication structures

The list of Amazon Redshift IAM Identity Center applications.

Errors

RedshiftIdcApplicationNotExistsFault:

The application you attempted to find doesn't exist.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceAccessDeniedFault:

A dependent service denied access for the integration.

DescribeReservedNodeExchangeStatus

$result = $client->describeReservedNodeExchangeStatus([/* ... */]);
$promise = $client->describeReservedNodeExchangeStatusAsync([/* ... */]);

Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.

Parameter Syntax

$result = $client->describeReservedNodeExchangeStatus([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ReservedNodeExchangeRequestId' => '<string>',
    'ReservedNodeId' => '<string>',
]);

Parameter Details

Members
Marker
Type: string

An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

ReservedNodeExchangeRequestId
Type: string

The identifier of the reserved-node exchange request.

ReservedNodeId
Type: string

The identifier of the source reserved node in a reserved-node exchange request.

Result Syntax

[
    'Marker' => '<string>',
    'ReservedNodeExchangeStatusDetails' => [
        [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.

ReservedNodeExchangeStatusDetails
Type: Array of ReservedNodeExchangeStatus structures

The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.

Errors

ReservedNodeNotFoundFault:

The specified reserved compute node not found.

ReservedNodeExchangeNotFoundFault:

The reserved-node exchange status wasn't found.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeReservedNodeOfferings

$result = $client->describeReservedNodeOfferings([/* ... */]);
$promise = $client->describeReservedNodeOfferingsAsync([/* ... */]);

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->describeReservedNodeOfferings([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ReservedNodeOfferingId' => '<string>',
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ReservedNodeOfferingId
Type: string

The unique identifier for the offering.

Result Syntax

[
    'Marker' => '<string>',
    'ReservedNodeOfferings' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'NodeType' => '<string>',
            'OfferingType' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedNodeOfferingId' => '<string>',
            'ReservedNodeOfferingType' => 'Regular|Upgradable',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

ReservedNodeOfferings
Type: Array of ReservedNodeOffering structures

A list of ReservedNodeOffering objects.

Errors

ReservedNodeOfferingNotFoundFault:

Specified offering does not exist.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

DescribeReservedNodes

$result = $client->describeReservedNodes([/* ... */]);
$promise = $client->describeReservedNodesAsync([/* ... */]);

Returns the descriptions of the reserved nodes.

Parameter Syntax

$result = $client->describeReservedNodes([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ReservedNodeId' => '<string>',
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ReservedNodeId
Type: string

Identifier for the node reservation.

Result Syntax

[
    'Marker' => '<string>',
    'ReservedNodes' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'NodeCount' => <integer>,
            'NodeType' => '<string>',
            'OfferingType' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedNodeId' => '<string>',
            'ReservedNodeOfferingId' => '<string>',
            'ReservedNodeOfferingType' => 'Regular|Upgradable',
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

ReservedNodes
Type: Array of ReservedNode structures

The list of ReservedNode objects.

Errors

ReservedNodeNotFoundFault:

The specified reserved compute node not found.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

DescribeResize

$result = $client->describeResize([/* ... */]);
$promise = $client->describeResizeAsync([/* ... */]);

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

Parameter Syntax

$result = $client->describeResize([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

By default, resize operations for all clusters defined for an Amazon Web Services account are returned.

Result Syntax

[
    'AvgResizeRateInMegaBytesPerSecond' => <float>,
    'DataTransferProgressPercent' => <float>,
    'ElapsedTimeInSeconds' => <integer>,
    'EstimatedTimeToCompletionInSeconds' => <integer>,
    'ImportTablesCompleted' => ['<string>', ...],
    'ImportTablesInProgress' => ['<string>', ...],
    'ImportTablesNotStarted' => ['<string>', ...],
    'Message' => '<string>',
    'ProgressInMegaBytes' => <integer>,
    'ResizeType' => '<string>',
    'Status' => '<string>',
    'TargetClusterType' => '<string>',
    'TargetEncryptionType' => '<string>',
    'TargetNodeType' => '<string>',
    'TargetNumberOfNodes' => <integer>,
    'TotalResizeDataInMegaBytes' => <integer>,
]

Result Details

Members
AvgResizeRateInMegaBytesPerSecond
Type: double

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.

DataTransferProgressPercent
Type: double

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

ElapsedTimeInSeconds
Type: long (int|float)

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.

EstimatedTimeToCompletionInSeconds
Type: long (int|float)

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.

ImportTablesCompleted
Type: Array of strings

The names of tables that have been completely imported .

Valid Values: List of table names.

ImportTablesInProgress
Type: Array of strings

The names of tables that are being currently imported.

Valid Values: List of table names.

ImportTablesNotStarted
Type: Array of strings

The names of tables that have not been yet imported.

Valid Values: List of table names

Message
Type: string

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

ProgressInMegaBytes
Type: long (int|float)

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

ResizeType
Type: string

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

Status
Type: string

The status of the resize operation.

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

TargetClusterType
Type: string

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

TargetEncryptionType
Type: string

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

Possible values are KMS and None.

TargetNodeType
Type: string

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

TargetNumberOfNodes
Type: int

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

TotalResizeDataInMegaBytes
Type: long (int|float)

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

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ResizeNotFoundFault:

A resize operation for the specified cluster is not found.

UnsupportedOperationFault:

The requested operation isn't supported.

DescribeScheduledActions

$result = $client->describeScheduledActions([/* ... */]);
$promise = $client->describeScheduledActionsAsync([/* ... */]);

Describes properties of scheduled actions.

Parameter Syntax

$result = $client->describeScheduledActions([
    'Active' => true || false,
    'EndTime' => <integer || string || DateTime>,
    'Filters' => [
        [
            'Name' => 'cluster-identifier|iam-role', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ScheduledActionName' => '<string>',
    'StartTime' => <integer || string || DateTime>,
    'TargetActionType' => 'ResizeCluster|PauseCluster|ResumeCluster',
]);

Parameter Details

Members
Active
Type: boolean

If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

Filters
Type: Array of ScheduledActionFilter structures

List of scheduled action filters.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ScheduledActionName
Type: string

The name of the scheduled action to retrieve.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

TargetActionType
Type: string

The type of the scheduled actions to retrieve.

Result Syntax

[
    'Marker' => '<string>',
    'ScheduledActions' => [
        [
            'EndTime' => <DateTime>,
            'IamRole' => '<string>',
            'NextInvocations' => [<DateTime>, ...],
            'Schedule' => '<string>',
            'ScheduledActionDescription' => '<string>',
            'ScheduledActionName' => '<string>',
            'StartTime' => <DateTime>,
            'State' => 'ACTIVE|DISABLED',
            'TargetAction' => [
                'PauseCluster' => [
                    'ClusterIdentifier' => '<string>',
                ],
                'ResizeCluster' => [
                    'Classic' => true || false,
                    'ClusterIdentifier' => '<string>',
                    'ClusterType' => '<string>',
                    'NodeType' => '<string>',
                    'NumberOfNodes' => <integer>,
                    'ReservedNodeId' => '<string>',
                    'TargetReservedNodeOfferingId' => '<string>',
                ],
                'ResumeCluster' => [
                    'ClusterIdentifier' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

ScheduledActions
Type: Array of ScheduledAction structures

List of retrieved scheduled actions.

Errors

ScheduledActionNotFoundFault:

The scheduled action cannot be found.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

DescribeSnapshotCopyGrants

$result = $client->describeSnapshotCopyGrants([/* ... */]);
$promise = $client->describeSnapshotCopyGrantsAsync([/* ... */]);

Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->describeSnapshotCopyGrants([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SnapshotCopyGrantName' => '<string>',
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

SnapshotCopyGrantName
Type: string

The name of the snapshot copy grant.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Result Syntax

[
    'Marker' => '<string>',
    'SnapshotCopyGrants' => [
        [
            'KmsKeyId' => '<string>',
            'SnapshotCopyGrantName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

SnapshotCopyGrants
Type: Array of SnapshotCopyGrant structures

The list of SnapshotCopyGrant objects.

Errors

SnapshotCopyGrantNotFoundFault:

The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.

InvalidTagFault:

The tag is invalid.

DescribeSnapshotSchedules

$result = $client->describeSnapshotSchedules([/* ... */]);
$promise = $client->describeSnapshotSchedulesAsync([/* ... */]);

Returns a list of snapshot schedules.

Parameter Syntax

$result = $client->describeSnapshotSchedules([
    'ClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ScheduleIdentifier' => '<string>',
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The unique identifier for the cluster whose snapshot schedules you want to view.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

MaxRecords
Type: int

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

ScheduleIdentifier
Type: string

A unique identifier for a snapshot schedule.

TagKeys
Type: Array of strings

The key value for a snapshot schedule tag.

TagValues
Type: Array of strings

The value corresponding to the key of the snapshot schedule tag.

Result Syntax

[
    'Marker' => '<string>',
    'SnapshotSchedules' => [
        [
            'AssociatedClusterCount' => <integer>,
            'AssociatedClusters' => [
                [
                    'ClusterIdentifier' => '<string>',
                    'ScheduleAssociationState' => 'MODIFYING|ACTIVE|FAILED',
                ],
                // ...
            ],
            'NextInvocations' => [<DateTime>, ...],
            'ScheduleDefinitions' => ['<string>', ...],
            'ScheduleDescription' => '<string>',
            'ScheduleIdentifier' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

SnapshotSchedules
Type: Array of SnapshotSchedule structures

A list of SnapshotSchedules.

Errors

There are no errors described for this operation.

DescribeStorage

$result = $client->describeStorage([/* ... */]);
$promise = $client->describeStorageAsync([/* ... */]);

Returns account level backups storage size and provisional storage.

Parameter Syntax

$result = $client->describeStorage([
]);

Parameter Details

Members

Result Syntax

[
    'TotalBackupSizeInMegaBytes' => <float>,
    'TotalProvisionedStorageInMegaBytes' => <float>,
]

Result Details

Members
TotalBackupSizeInMegaBytes
Type: double

The total amount of storage currently used for snapshots.

TotalProvisionedStorageInMegaBytes
Type: double

The total amount of storage currently provisioned.

Errors

There are no errors described for this operation.

DescribeTableRestoreStatus

$result = $client->describeTableRestoreStatus([/* ... */]);
$promise = $client->describeTableRestoreStatusAsync([/* ... */]);

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

Parameter Syntax

$result = $client->describeTableRestoreStatus([
    'ClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TableRestoreRequestId' => '<string>',
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The Amazon Redshift cluster that the table is being restored to.

Marker
Type: string

An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

MaxRecords
Type: int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

TableRestoreRequestId
Type: string

The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

Result Syntax

[
    'Marker' => '<string>',
    'TableRestoreStatusDetails' => [
        [
            'ClusterIdentifier' => '<string>',
            'Message' => '<string>',
            'NewTableName' => '<string>',
            'ProgressInMegaBytes' => <integer>,
            'RequestTime' => <DateTime>,
            'SnapshotIdentifier' => '<string>',
            'SourceDatabaseName' => '<string>',
            'SourceSchemaName' => '<string>',
            'SourceTableName' => '<string>',
            'Status' => 'PENDING|IN_PROGRESS|SUCCEEDED|FAILED|CANCELED',
            'TableRestoreRequestId' => '<string>',
            'TargetDatabaseName' => '<string>',
            'TargetSchemaName' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

TableRestoreStatusDetails
Type: Array of TableRestoreStatus structures

A list of status details for one or more table restore requests.

Errors

TableRestoreNotFoundFault:

The specified TableRestoreRequestId value was not found.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

DescribeTags

$result = $client->describeTags([/* ... */]);
$promise = $client->describeTagsAsync([/* ... */]);

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags:

  • You cannot specify an ARN and a resource-type value together in the same request.

  • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.

  • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Parameter Syntax

$result = $client->describeTags([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ResourceName' => '<string>',
    'ResourceType' => '<string>',
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
]);

Parameter Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

MaxRecords
Type: int

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

ResourceName
Type: string

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

ResourceType
Type: string

The type of resource with which you want to view tags. Valid resource types are:

  • Cluster

  • CIDR/IP

  • EC2 security group

  • Snapshot

  • Cluster security group

  • Subnet group

  • HSM connection

  • HSM certificate

  • Parameter group

  • Snapshot copy grant

For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Result Syntax

[
    'Marker' => '<string>',
    'TaggedResources' => [
        [
            'ResourceName' => '<string>',
            'ResourceType' => '<string>',
            'Tag' => [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

TaggedResources
Type: Array of TaggedResource structures

A list of tags with their associated resources.

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidTagFault:

The tag is invalid.

DescribeUsageLimits

$result = $client->describeUsageLimits([/* ... */]);
$promise = $client->describeUsageLimitsAsync([/* ... */]);

Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

  • If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.

  • If usage limit identifier is provided, then the corresponding usage limit object is returned.

  • If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.

  • If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.

Parameter Syntax

$result = $client->describeUsageLimits([
    'ClusterIdentifier' => '<string>',
    'FeatureType' => 'spectrum|concurrency-scaling|cross-region-datasharing',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'TagKeys' => ['<string>', ...],
    'TagValues' => ['<string>', ...],
    'UsageLimitId' => '<string>',
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The identifier of the cluster for which you want to describe usage limits.

FeatureType
Type: string

The feature type for which you want to describe usage limits.

Marker
Type: string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys
Type: Array of strings

A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

TagValues
Type: Array of strings

A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

UsageLimitId
Type: string

The identifier of the usage limit to describe.

Result Syntax

[
    'Marker' => '<string>',
    'UsageLimits' => [
        [
            'Amount' => <integer>,
            'BreachAction' => 'log|emit-metric|disable',
            'ClusterIdentifier' => '<string>',
            'FeatureType' => 'spectrum|concurrency-scaling|cross-region-datasharing',
            'LimitType' => 'time|data-scanned',
            'Period' => 'daily|weekly|monthly',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UsageLimitId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

UsageLimits
Type: Array of UsageLimit structures

Contains the output from the DescribeUsageLimits action.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

DisableLogging

$result = $client->disableLogging([/* ... */]);
$promise = $client->disableLoggingAsync([/* ... */]);

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameter Syntax

$result = $client->disableLogging([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster on which logging is to be stopped.

Example: examplecluster

Result Syntax

[
    'BucketName' => '<string>',
    'LastFailureMessage' => '<string>',
    'LastFailureTime' => <DateTime>,
    'LastSuccessfulDeliveryTime' => <DateTime>,
    'LogDestinationType' => 's3|cloudwatch',
    'LogExports' => ['<string>', ...],
    'LoggingEnabled' => true || false,
    'S3KeyPrefix' => '<string>',
]

Result Details

Members
BucketName
Type: string

The name of the S3 bucket where the log files are stored.

LastFailureMessage
Type: string

The message indicating that logs failed to be delivered.

LastFailureTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time when logs failed to be delivered.

LastSuccessfulDeliveryTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time that logs were delivered.

LogDestinationType
Type: string

The log destination type. An enum with possible values of s3 and cloudwatch.

LogExports
Type: Array of strings

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

LoggingEnabled
Type: boolean

true if logging is on, false if logging is off.

S3KeyPrefix
Type: string

The prefix applied to the log file names.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnsupportedOperationFault:

The requested operation isn't supported.

DisableSnapshotCopy

$result = $client->disableSnapshotCopy([/* ... */]);
$promise = $client->disableSnapshotCopyAsync([/* ... */]);

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

If your cluster and its snapshots are encrypted using an encrypted symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the key in the destination region.

Parameter Syntax

$result = $client->disableSnapshotCopy([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

SnapshotCopyAlreadyDisabledFault:

The cluster already has cross-region snapshot copy disabled.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

UnsupportedOperationFault:

The requested operation isn't supported.

DisassociateDataShareConsumer

$result = $client->disassociateDataShareConsumer([/* ... */]);
$promise = $client->disassociateDataShareConsumerAsync([/* ... */]);

From a datashare consumer account, remove association for the specified datashare.

Parameter Syntax

$result = $client->disassociateDataShareConsumer([
    'ConsumerArn' => '<string>',
    'ConsumerRegion' => '<string>',
    'DataShareArn' => '<string>', // REQUIRED
    'DisassociateEntireAccount' => true || false,
]);

Parameter Details

Members
ConsumerArn
Type: string

The Amazon Resource Name (ARN) of the consumer namespace that association for the datashare is removed from.

ConsumerRegion
Type: string

From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.

DataShareArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the datashare to remove association for.

DisassociateEntireAccount
Type: boolean

A value that specifies whether association for the datashare is removed from the entire account.

Result Syntax

[
    'AllowPubliclyAccessibleConsumers' => true || false,
    'DataShareArn' => '<string>',
    'DataShareAssociations' => [
        [
            'ConsumerAcceptedWrites' => true || false,
            'ConsumerIdentifier' => '<string>',
            'ConsumerRegion' => '<string>',
            'CreatedDate' => <DateTime>,
            'ProducerAllowedWrites' => true || false,
            'Status' => 'ACTIVE|PENDING_AUTHORIZATION|AUTHORIZED|DEAUTHORIZED|REJECTED|AVAILABLE',
            'StatusChangeDate' => <DateTime>,
        ],
        // ...
    ],
    'ManagedBy' => '<string>',
    'ProducerArn' => '<string>',
]

Result Details

Members
AllowPubliclyAccessibleConsumers
Type: boolean

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DataShareArn
Type: string

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

DataShareAssociations
Type: Array of DataShareAssociation structures

A value that specifies when the datashare has an association between producer and data consumers.

ManagedBy
Type: string

The identifier of a datashare to show its managing entity.

ProducerArn
Type: string

The Amazon Resource Name (ARN) of the producer namespace.

Errors

InvalidDataShareFault:

There is an error with the datashare.

InvalidNamespaceFault:

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

EnableLogging

$result = $client->enableLogging([/* ... */]);
$promise = $client->enableLoggingAsync([/* ... */]);

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameter Syntax

$result = $client->enableLogging([
    'BucketName' => '<string>',
    'ClusterIdentifier' => '<string>', // REQUIRED
    'LogDestinationType' => 's3|cloudwatch',
    'LogExports' => ['<string>', ...],
    'S3KeyPrefix' => '<string>',
]);

Parameter Details

Members
BucketName
Type: string

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

  • Must be in the same region as the cluster

  • The cluster must have read bucket and put object permissions

ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster on which logging is to be started.

Example: examplecluster

LogDestinationType
Type: string

The log destination type. An enum with possible values of s3 and cloudwatch.

LogExports
Type: Array of strings

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

S3KeyPrefix
Type: string

The prefix applied to the log file names.

Constraints:

  • Cannot exceed 512 characters

  • Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:

    • x00 to x20

    • x22

    • x27

    • x5c

    • x7f or larger

Result Syntax

[
    'BucketName' => '<string>',
    'LastFailureMessage' => '<string>',
    'LastFailureTime' => <DateTime>,
    'LastSuccessfulDeliveryTime' => <DateTime>,
    'LogDestinationType' => 's3|cloudwatch',
    'LogExports' => ['<string>', ...],
    'LoggingEnabled' => true || false,
    'S3KeyPrefix' => '<string>',
]

Result Details

Members
BucketName
Type: string

The name of the S3 bucket where the log files are stored.

LastFailureMessage
Type: string

The message indicating that logs failed to be delivered.

LastFailureTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time when logs failed to be delivered.

LastSuccessfulDeliveryTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time that logs were delivered.

LogDestinationType
Type: string

The log destination type. An enum with possible values of s3 and cloudwatch.

LogExports
Type: Array of strings

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

LoggingEnabled
Type: boolean

true if logging is on, false if logging is off.

S3KeyPrefix
Type: string

The prefix applied to the log file names.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

BucketNotFoundFault:

Could not find the specified S3 bucket.

InsufficientS3BucketPolicyFault:

The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.

InvalidS3KeyPrefixFault:

The string specified for the logging S3 key prefix does not comply with the documented constraints.

InvalidS3BucketNameFault:

The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnsupportedOperationFault:

The requested operation isn't supported.

EnableSnapshotCopy

$result = $client->enableSnapshotCopy([/* ... */]);
$promise = $client->enableSnapshotCopyAsync([/* ... */]);

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Parameter Syntax

$result = $client->enableSnapshotCopy([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DestinationRegion' => '<string>', // REQUIRED
    'ManualSnapshotRetentionPeriod' => <integer>,
    'RetentionPeriod' => <integer>,
    'SnapshotCopyGrantName' => '<string>',
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

DestinationRegion
Required: Yes
Type: string

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

ManualSnapshotRetentionPeriod
Type: int

The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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
Type: int

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default: 7.

Constraints: Must be at least 1 and no more than 35.

SnapshotCopyGrantName
Type: string

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

IncompatibleOrderableOptions:

The specified options are incompatible.

InvalidClusterStateFault:

The specified cluster is not in the available state.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

CopyToRegionDisabledFault:

Cross-region snapshot copy was temporarily disabled. Try your request again.

SnapshotCopyAlreadyEnabledFault:

The cluster already has cross-region snapshot copy enabled.

UnknownSnapshotCopyRegionFault:

The specified region is incorrect or does not exist.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

SnapshotCopyGrantNotFoundFault:

The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.

LimitExceededFault:

The encryption key has exceeded its grant limit in Amazon Web Services KMS.

DependentServiceRequestThrottlingFault:

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

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

FailoverPrimaryCompute

$result = $client->failoverPrimaryCompute([/* ... */]);
$promise = $client->failoverPrimaryComputeAsync([/* ... */]);

Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.

Parameter Syntax

$result = $client->failoverPrimaryCompute([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier of the cluster for which the primary compute unit will be failed over to another Availability Zone.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

InvalidClusterStateFault:

The specified cluster is not in the available state.

GetClusterCredentials

$result = $client->getClusterCredentials([/* ... */]);
$promise = $client->getClusterCredentialsAsync([/* ... */]);

Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.

If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.

In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser permission.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Parameter Syntax

$result = $client->getClusterCredentials([
    'AutoCreate' => true || false,
    'ClusterIdentifier' => '<string>',
    'CustomDomainName' => '<string>',
    'DbGroups' => ['<string>', ...],
    'DbName' => '<string>',
    'DbUser' => '<string>', // REQUIRED
    'DurationSeconds' => <integer>,
]);

Parameter Details

Members
AutoCreate
Type: boolean

Create a database user with the name specified for the user named in DbUser if one does not exist.

ClusterIdentifier
Type: string

The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.

CustomDomainName
Type: string

The custom domain name for the cluster credentials.

DbGroups
Type: Array of strings

A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

Database group name constraints

  • Must be 1 to 64 alphanumeric characters or hyphens

  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • First character must be a letter.

  • Must not contain a colon ( : ) or slash ( / ).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

DbName
Type: string

The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens

  • Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • First character must be a letter.

  • Must not contain a colon ( : ) or slash ( / ).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

DbUser
Required: Yes
Type: string

The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.

For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC.

  • Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • First character must be a letter.

  • Must not contain a colon ( : ) or slash ( / ).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

DurationSeconds
Type: int

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Result Syntax

[
    'DbPassword' => '<string>',
    'DbUser' => '<string>',
    'Expiration' => <DateTime>,
]

Result Details

Members
DbPassword
Type: string

A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

DbUser
Type: string

A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database permissions as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.

Expiration
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the password in DbPassword expires.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

GetClusterCredentialsWithIAM

$result = $client->getClusterCredentialsWithIAM([/* ... */]);
$promise = $client->getClusterCredentialsWithIAMAsync([/* ... */]);

Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide.

The Identity and Access Management (IAM) identity that runs this operation must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->getClusterCredentialsWithIAM([
    'ClusterIdentifier' => '<string>',
    'CustomDomainName' => '<string>',
    'DbName' => '<string>',
    'DurationSeconds' => <integer>,
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The unique identifier of the cluster that contains the database for which you are requesting credentials.

CustomDomainName
Type: string

The custom domain name for the IAM message cluster credentials.

DbName
Type: string

The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name. If the database name is not specified, access to all databases is allowed.

DurationSeconds
Type: int

The number of seconds until the returned temporary password expires.

Range: 900-3600. Default: 900.

Result Syntax

[
    'DbPassword' => '<string>',
    'DbUser' => '<string>',
    'Expiration' => <DateTime>,
    'NextRefreshTime' => <DateTime>,
]

Result Details

Members
DbPassword
Type: string

A temporary password that you provide when you connect to a database.

DbUser
Type: string

A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.

Expiration
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.

NextRefreshTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Reserved for future use.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

GetReservedNodeExchangeConfigurationOptions

$result = $client->getReservedNodeExchangeConfigurationOptions([/* ... */]);
$promise = $client->getReservedNodeExchangeConfigurationOptionsAsync([/* ... */]);

Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.

Parameter Syntax

$result = $client->getReservedNodeExchangeConfigurationOptions([
    'ActionType' => 'restore-cluster|resize-cluster', // REQUIRED
    'ClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SnapshotIdentifier' => '<string>',
]);

Parameter Details

Members
ActionType
Required: Yes
Type: string

The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.

ClusterIdentifier
Type: string

The identifier for the cluster that is the source for a reserved-node exchange.

Marker
Type: string

An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

SnapshotIdentifier
Type: string

The identifier for the snapshot that is the source for the reserved-node exchange.

Result Syntax

[
    'Marker' => '<string>',
    'ReservedNodeConfigurationOptionList' => [
        [
            'SourceReservedNode' => [
                'CurrencyCode' => '<string>',
                'Duration' => <integer>,
                'FixedPrice' => <float>,
                'NodeCount' => <integer>,
                'NodeType' => '<string>',
                'OfferingType' => '<string>',
                'RecurringCharges' => [
                    [
                        'RecurringChargeAmount' => <float>,
                        'RecurringChargeFrequency' => '<string>',
                    ],
                    // ...
                ],
                'ReservedNodeId' => '<string>',
                'ReservedNodeOfferingId' => '<string>',
                'ReservedNodeOfferingType' => 'Regular|Upgradable',
                'StartTime' => <DateTime>,
                'State' => '<string>',
                'UsagePrice' => <float>,
            ],
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOffering' => [
                'CurrencyCode' => '<string>',
                'Duration' => <integer>,
                'FixedPrice' => <float>,
                'NodeType' => '<string>',
                'OfferingType' => '<string>',
                'RecurringCharges' => [
                    [
                        'RecurringChargeAmount' => <float>,
                        'RecurringChargeFrequency' => '<string>',
                    ],
                    // ...
                ],
                'ReservedNodeOfferingId' => '<string>',
                'ReservedNodeOfferingType' => 'Regular|Upgradable',
                'UsagePrice' => <float>,
            ],
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request.

ReservedNodeConfigurationOptionList
Type: Array of ReservedNodeConfigurationOption structures

the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type.

Errors

ReservedNodeNotFoundFault:

The specified reserved compute node not found.

InvalidReservedNodeStateFault:

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

ReservedNodeAlreadyMigratedFault:

Indicates that the reserved node has already been exchanged.

ReservedNodeOfferingNotFoundFault:

Specified offering does not exist.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

GetReservedNodeExchangeOfferings

$result = $client->getReservedNodeExchangeOfferings([/* ... */]);
$promise = $client->getReservedNodeExchangeOfferingsAsync([/* ... */]);

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

Parameter Syntax

$result = $client->getReservedNodeExchangeOfferings([
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ReservedNodeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of ReservedNodeOfferings.

MaxRecords
Type: int

An integer setting the maximum number of ReservedNodeOfferings to retrieve.

ReservedNodeId
Required: Yes
Type: string

A string representing the node identifier for the DC1 Reserved Node to be exchanged.

Result Syntax

[
    'Marker' => '<string>',
    'ReservedNodeOfferings' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'NodeType' => '<string>',
            'OfferingType' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedNodeOfferingId' => '<string>',
            'ReservedNodeOfferingType' => 'Regular|Upgradable',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

ReservedNodeOfferings
Type: Array of ReservedNodeOffering structures

Returns an array of ReservedNodeOffering objects.

Errors

ReservedNodeNotFoundFault:

The specified reserved compute node not found.

InvalidReservedNodeStateFault:

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

ReservedNodeAlreadyMigratedFault:

Indicates that the reserved node has already been exchanged.

ReservedNodeOfferingNotFoundFault:

Specified offering does not exist.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Get the resource policy for a specified resource.

Parameter Syntax

$result = $client->getResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource of which its resource policy is fetched.

Result Syntax

[
    'ResourcePolicy' => [
        'Policy' => '<string>',
        'ResourceArn' => '<string>',
    ],
]

Result Details

Members
ResourcePolicy
Type: ResourcePolicy structure

The content of the resource policy.

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidPolicyFault:

The resource policy isn't valid.

UnsupportedOperationFault:

The requested operation isn't supported.

ListRecommendations

$result = $client->listRecommendations([/* ... */]);
$promise = $client->listRecommendationsAsync([/* ... */]);

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

Parameter Syntax

$result = $client->listRecommendations([
    'ClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'NamespaceArn' => '<string>',
]);

Parameter Details

Members
ClusterIdentifier
Type: string

The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

MaxRecords
Type: int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

NamespaceArn
Type: string

The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

Result Syntax

[
    'Marker' => '<string>',
    'Recommendations' => [
        [
            'ClusterIdentifier' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'Id' => '<string>',
            'ImpactRanking' => 'HIGH|MEDIUM|LOW',
            'NamespaceArn' => '<string>',
            'Observation' => '<string>',
            'RecommendationText' => '<string>',
            'RecommendationType' => '<string>',
            'RecommendedActions' => [
                [
                    'Command' => '<string>',
                    'Database' => '<string>',
                    'Text' => '<string>',
                    'Type' => 'SQL|CLI',
                ],
                // ...
            ],
            'ReferenceLinks' => [
                [
                    'Link' => '<string>',
                    'Text' => '<string>',
                ],
                // ...
            ],
            'Title' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Marker
Type: string

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Recommendations
Type: Array of Recommendation structures

The Advisor recommendations for action on the Amazon Redshift cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

UnsupportedOperationFault:

The requested operation isn't supported.

ModifyAquaConfiguration

$result = $client->modifyAquaConfiguration([/* ... */]);
$promise = $client->modifyAquaConfigurationAsync([/* ... */]);

This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Parameter Syntax

$result = $client->modifyAquaConfiguration([
    'AquaConfigurationStatus' => 'enabled|disabled|auto',
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
AquaConfigurationStatus
Type: string

This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster to be modified.

Result Syntax

[
    'AquaConfiguration' => [
        'AquaConfigurationStatus' => 'enabled|disabled|auto',
        'AquaStatus' => 'enabled|disabled|applying',
    ],
]

Result Details

Members
AquaConfiguration
Type: AquaConfiguration structure

This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnsupportedOperationFault:

The requested operation isn't supported.

ModifyAuthenticationProfile

$result = $client->modifyAuthenticationProfile([/* ... */]);
$promise = $client->modifyAuthenticationProfileAsync([/* ... */]);

Modifies an authentication profile.

Parameter Syntax

$result = $client->modifyAuthenticationProfile([
    'AuthenticationProfileContent' => '<string>', // REQUIRED
    'AuthenticationProfileName' => '<string>', // REQUIRED
]);

Parameter Details

Members
AuthenticationProfileContent
Required: Yes
Type: string

The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

AuthenticationProfileName
Required: Yes
Type: string

The name of the authentication profile to replace.

Result Syntax

[
    'AuthenticationProfileContent' => '<string>',
    'AuthenticationProfileName' => '<string>',
]

Result Details

Members
AuthenticationProfileContent
Type: string

The updated content of the authentication profile in JSON format.

AuthenticationProfileName
Type: string

The name of the authentication profile that was replaced.

Errors

AuthenticationProfileNotFoundFault:

The authentication profile can't be found.

AuthenticationProfileQuotaExceededFault:

The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.

InvalidAuthenticationProfileRequestFault:

The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.

ModifyCluster

$result = $client->modifyCluster([/* ... */]);
$promise = $client->modifyClusterAsync([/* ... */]);

Modifies the settings for a cluster.

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->modifyCluster([
    'AllowVersionUpgrade' => true || false,
    'AutomatedSnapshotRetentionPeriod' => <integer>,
    'AvailabilityZone' => '<string>',
    'AvailabilityZoneRelocation' => true || false,
    'ClusterIdentifier' => '<string>', // REQUIRED
    'ClusterParameterGroupName' => '<string>',
    'ClusterSecurityGroups' => ['<string>', ...],
    'ClusterType' => '<string>',
    'ClusterVersion' => '<string>',
    'ElasticIp' => '<string>',
    'Encrypted' => true || false,
    'EnhancedVpcRouting' => true || false,
    'HsmClientCertificateIdentifier' => '<string>',
    'HsmConfigurationIdentifier' => '<string>',
    'IpAddressType' => '<string>',
    'KmsKeyId' => '<string>',
    'MaintenanceTrackName' => '<string>',
    'ManageMasterPassword' => true || false,
    'ManualSnapshotRetentionPeriod' => <integer>,
    'MasterPasswordSecretKmsKeyId' => '<string>',
    'MasterUserPassword' => '<string>',
    'MultiAZ' => true || false,
    'NewClusterIdentifier' => '<string>',
    'NodeType' => '<string>',
    'NumberOfNodes' => <integer>,
    'Port' => <integer>,
    'PreferredMaintenanceWindow' => '<string>',
    'PubliclyAccessible' => true || false,
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
AllowVersionUpgrade
Type: boolean

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

AutomatedSnapshotRetentionPeriod
Type: int

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.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

AvailabilityZone
Type: string

The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

AvailabilityZoneRelocation
Type: boolean

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

ClusterIdentifier
Required: Yes
Type: string

The unique identifier of the cluster to be modified.

Example: examplecluster

ClusterParameterGroupName
Type: string

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

ClusterSecurityGroups
Type: Array of strings

A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

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

ClusterType
Type: string

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

ClusterVersion
Type: string

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Example: 1.0

ElasticIp
Type: 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.

Encrypted
Type: boolean

Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key.

If the value is not encrypted (false), then the cluster is decrypted.

EnhancedVpcRouting
Type: 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

HsmClientCertificateIdentifier
Type: string

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

HsmConfigurationIdentifier
Type: 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.

IpAddressType
Type: string

The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

KmsKeyId
Type: string

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

MaintenanceTrackName
Type: string

The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

ManageMasterPassword
Type: boolean

If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

ManualSnapshotRetentionPeriod
Type: int

The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.

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

The default value is -1.

MasterPasswordSecretKmsKeyId
Type: string

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

MasterUserPassword
Type: string

The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

You can't use MasterUserPassword if ManageMasterPassword is true.

Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.

Default: Uses existing setting.

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-126) except ' (single quote), " (double quote), \, /, or @.

MultiAZ
Type: boolean

If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.

NewClusterIdentifier
Type: string

The new identifier for the cluster.

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 Amazon Web Services account.

Example: examplecluster

NodeType
Type: string

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Valid Values: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

NumberOfNodes
Type: int

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Valid Values: Integer greater than 0.

Port
Type: int

The option to change the port of an Amazon Redshift cluster.

Valid Values:

  • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)

  • For clusters with dc2 nodes - Select a port within the range 1150-65535.

PreferredMaintenanceWindow
Type: string

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes.

PubliclyAccessible
Type: boolean

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

VpcSecurityGroupIds
Type: Array of strings

A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

InvalidClusterStateFault:

The specified cluster is not in the available state.

InvalidClusterSecurityGroupStateFault:

The state of the cluster security group is not available.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

NumberOfNodesQuotaExceededFault:

The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

NumberOfNodesPerClusterLimitExceededFault:

The operation would exceed the number of nodes allowed for a cluster.

ClusterSecurityGroupNotFoundFault:

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

ClusterParameterGroupNotFoundFault:

The parameter group name does not refer to an existing parameter group.

InsufficientClusterCapacityFault:

The number of nodes specified exceeds the allotted capacity of the cluster.

UnsupportedOptionFault:

A request option was specified that is not supported.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

HsmClientCertificateNotFoundFault:

There is no Amazon Redshift HSM client certificate with the specified identifier.

HsmConfigurationNotFoundFault:

There is no Amazon Redshift HSM configuration with the specified identifier.

ClusterAlreadyExistsFault:

The account already has a cluster with the given identifier.

LimitExceededFault:

The encryption key has exceeded its grant limit in Amazon Web Services KMS.

DependentServiceRequestThrottlingFault:

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

InvalidElasticIpFault:

The Elastic IP (EIP) is invalid or cannot be found.

TableLimitExceededFault:

The number of tables in the cluster exceeds the limit for the requested new cluster node type.

InvalidClusterTrackFault:

The provided cluster track name is not valid.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

UnsupportedOperationFault:

The requested operation isn't supported.

CustomCnameAssociationFault:

An error occurred when an attempt was made to change the custom domain association.

Ipv6CidrBlockNotFoundFault:

There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.

ModifyClusterDbRevision

$result = $client->modifyClusterDbRevision([/* ... */]);
$promise = $client->modifyClusterDbRevisionAsync([/* ... */]);

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

Parameter Syntax

$result = $client->modifyClusterDbRevision([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'RevisionTarget' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier of a cluster whose database revision you want to modify.

Example: examplecluster

RevisionTarget
Required: Yes
Type: string

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ClusterOnLatestRevisionFault:

Cluster is already on the latest database revision.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnsupportedOperationFault:

The requested operation isn't supported.

ModifyClusterIamRoles

$result = $client->modifyClusterIamRoles([/* ... */]);
$promise = $client->modifyClusterIamRolesAsync([/* ... */]);

Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->modifyClusterIamRoles([
    'AddIamRoles' => ['<string>', ...],
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DefaultIamRoleArn' => '<string>',
    'RemoveIamRoles' => ['<string>', ...],
]);

Parameter Details

Members
AddIamRoles
Type: Array of strings

Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format.

ClusterIdentifier
Required: Yes
Type: string

The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

DefaultIamRoleArn
Type: string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.

RemoveIamRoles
Type: Array of strings

Zero or more IAM roles in ARN format to disassociate from the cluster.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

InvalidClusterStateFault:

The specified cluster is not in the available state.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ModifyClusterMaintenance

$result = $client->modifyClusterMaintenance([/* ... */]);
$promise = $client->modifyClusterMaintenanceAsync([/* ... */]);

Modifies the maintenance settings of a cluster.

Parameter Syntax

$result = $client->modifyClusterMaintenance([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DeferMaintenance' => true || false,
    'DeferMaintenanceDuration' => <integer>,
    'DeferMaintenanceEndTime' => <integer || string || DateTime>,
    'DeferMaintenanceIdentifier' => '<string>',
    'DeferMaintenanceStartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

A unique identifier for the cluster.

DeferMaintenance
Type: boolean

A boolean indicating whether to enable the deferred maintenance window.

DeferMaintenanceDuration
Type: int

An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

DeferMaintenanceEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

DeferMaintenanceIdentifier
Type: string

A unique identifier for the deferred maintenance window.

DeferMaintenanceStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp indicating the start time for the deferred maintenance window.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

ModifyClusterParameterGroup

$result = $client->modifyClusterParameterGroup([/* ... */]);
$promise = $client->modifyClusterParameterGroupAsync([/* ... */]);

Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->modifyClusterParameterGroup([
    'ParameterGroupName' => '<string>', // REQUIRED
    'Parameters' => [ // REQUIRED
        [
            'AllowedValues' => '<string>',
            'ApplyType' => 'static|dynamic',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ParameterGroupName
Required: Yes
Type: string

The name of the parameter group to be modified.

Parameters
Required: Yes
Type: Array of Parameter structures

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Result Syntax

[
    'ParameterGroupName' => '<string>',
    'ParameterGroupStatus' => '<string>',
]

Result Details

Members
ParameterGroupName
Type: string

The name of the cluster parameter group.

ParameterGroupStatus
Type: string

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Errors

ClusterParameterGroupNotFoundFault:

The parameter group name does not refer to an existing parameter group.

InvalidClusterParameterGroupStateFault:

The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

ModifyClusterSnapshot

$result = $client->modifyClusterSnapshot([/* ... */]);
$promise = $client->modifyClusterSnapshotAsync([/* ... */]);

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

Parameter Syntax

$result = $client->modifyClusterSnapshot([
    'Force' => true || false,
    'ManualSnapshotRetentionPeriod' => <integer>,
    'SnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Force
Type: boolean

A Boolean option to override an exception if the retention period has already passed.

ManualSnapshotRetentionPeriod
Type: int

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

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

SnapshotIdentifier
Required: Yes
Type: string

The identifier of the snapshot whose setting you want to modify.

Result Syntax

[
    'Snapshot' => [
        'AccountsWithRestoreAccess' => [
            [
                'AccountAlias' => '<string>',
                'AccountId' => '<string>',
            ],
            // ...
        ],
        'ActualIncrementalBackupSizeInMegaBytes' => <float>,
        'AvailabilityZone' => '<string>',
        'BackupProgressInMegaBytes' => <float>,
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterVersion' => '<string>',
        'CurrentBackupRateInMegaBytesPerSecond' => <float>,
        'DBName' => '<string>',
        'ElapsedTimeInSeconds' => <integer>,
        'Encrypted' => true || false,
        'EncryptedWithHSM' => true || false,
        'EngineFullVersion' => '<string>',
        'EnhancedVpcRouting' => true || false,
        'EstimatedSecondsToCompletion' => <integer>,
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRemainingDays' => <integer>,
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'OwnerAccount' => '<string>',
        'Port' => <integer>,
        'RestorableNodeTypes' => ['<string>', ...],
        'SnapshotArn' => '<string>',
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotIdentifier' => '<string>',
        'SnapshotRetentionStartTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalBackupSizeInMegaBytes' => <float>,
        'VpcId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

Describes a snapshot.

Errors

InvalidClusterSnapshotStateFault:

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

ClusterSnapshotNotFoundFault:

The snapshot identifier does not refer to an existing cluster snapshot.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

ModifyClusterSnapshotSchedule

$result = $client->modifyClusterSnapshotSchedule([/* ... */]);
$promise = $client->modifyClusterSnapshotScheduleAsync([/* ... */]);

Modifies a snapshot schedule for a cluster.

Parameter Syntax

$result = $client->modifyClusterSnapshotSchedule([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'DisassociateSchedule' => true || false,
    'ScheduleIdentifier' => '<string>',
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

A unique identifier for the cluster whose snapshot schedule you want to modify.

DisassociateSchedule
Type: boolean

A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.

ScheduleIdentifier
Type: string

A unique alphanumeric identifier for the schedule that you want to associate with the cluster.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

SnapshotScheduleNotFoundFault:

We could not find the specified snapshot schedule.

InvalidClusterSnapshotScheduleStateFault:

The cluster snapshot schedule state is not valid.

ModifyClusterSubnetGroup

$result = $client->modifyClusterSubnetGroup([/* ... */]);
$promise = $client->modifyClusterSubnetGroupAsync([/* ... */]);

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

Parameter Syntax

$result = $client->modifyClusterSubnetGroup([
    'ClusterSubnetGroupName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'SubnetIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ClusterSubnetGroupName
Required: Yes
Type: string

The name of the subnet group to be modified.

Description
Type: string

A text description of the subnet group to be modified.

SubnetIds
Required: Yes
Type: Array of strings

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Result Syntax

[
    'ClusterSubnetGroup' => [
        'ClusterSubnetGroupName' => '<string>',
        'Description' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                    'SupportedPlatforms' => [
                        [
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'SupportedClusterIpAddressTypes' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members
ClusterSubnetGroup
Type: ClusterSubnetGroup structure

Describes a subnet group.

Errors

ClusterSubnetGroupNotFoundFault:

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

ClusterSubnetQuotaExceededFault:

The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

SubnetAlreadyInUse:

A specified subnet is already in use by another cluster.

InvalidSubnet:

The requested subnet is not valid, or not all of the subnets are in the same VPC.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

DependentServiceRequestThrottlingFault:

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

ModifyCustomDomainAssociation

$result = $client->modifyCustomDomainAssociation([/* ... */]);
$promise = $client->modifyCustomDomainAssociationAsync([/* ... */]);

Contains information for changing a custom domain association.

Parameter Syntax

$result = $client->modifyCustomDomainAssociation([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'CustomDomainCertificateArn' => '<string>', // REQUIRED
    'CustomDomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster to change a custom domain association for.

CustomDomainCertificateArn
Required: Yes
Type: string

The certificate Amazon Resource Name (ARN) for the changed custom domain association.

CustomDomainName
Required: Yes
Type: string

The custom domain name for a changed custom domain association.

Result Syntax

[
    'ClusterIdentifier' => '<string>',
    'CustomDomainCertExpiryTime' => '<string>',
    'CustomDomainCertificateArn' => '<string>',
    'CustomDomainName' => '<string>',
]

Result Details

Members
ClusterIdentifier
Type: string

The identifier of the cluster associated with the result for the changed custom domain association.

CustomDomainCertExpiryTime
Type: string

The certificate expiration time associated with the result for the changed custom domain association.

CustomDomainCertificateArn
Type: string

The certificate Amazon Resource Name (ARN) associated with the result for the changed custom domain association.

CustomDomainName
Type: string

The custom domain name associated with the result for the changed custom domain association.

Errors

UnsupportedOperationFault:

The requested operation isn't supported.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

CustomCnameAssociationFault:

An error occurred when an attempt was made to change the custom domain association.

CustomDomainAssociationNotFoundFault:

An error occurred. The custom domain name couldn't be found.

ModifyEndpointAccess

$result = $client->modifyEndpointAccess([/* ... */]);
$promise = $client->modifyEndpointAccessAsync([/* ... */]);

Modifies a Redshift-managed VPC endpoint.

Parameter Syntax

$result = $client->modifyEndpointAccess([
    'EndpointName' => '<string>', // REQUIRED
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
EndpointName
Required: Yes
Type: string

The endpoint to be modified.

VpcSecurityGroupIds
Type: Array of strings

The complete list of VPC security groups associated with the endpoint after the endpoint is modified.

Result Syntax

[
    'Address' => '<string>',
    'ClusterIdentifier' => '<string>',
    'EndpointCreateTime' => <DateTime>,
    'EndpointName' => '<string>',
    'EndpointStatus' => '<string>',
    'Port' => <integer>,
    'ResourceOwner' => '<string>',
    'SubnetGroupName' => '<string>',
    'VpcEndpoint' => [
        'NetworkInterfaces' => [
            [
                'AvailabilityZone' => '<string>',
                'Ipv6Address' => '<string>',
                'NetworkInterfaceId' => '<string>',
                'PrivateIpAddress' => '<string>',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointId' => '<string>',
        'VpcId' => '<string>',
    ],
    'VpcSecurityGroups' => [
        [
            'Status' => '<string>',
            'VpcSecurityGroupId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Address
Type: string

The DNS address of the endpoint.

ClusterIdentifier
Type: string

The cluster identifier of the cluster associated with the endpoint.

EndpointCreateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) that the endpoint was created.

EndpointName
Type: string

The name of the endpoint.

EndpointStatus
Type: string

The status of the endpoint.

Port
Type: int

The port number on which the cluster accepts incoming connections.

ResourceOwner
Type: string

The Amazon Web Services account ID of the owner of the cluster.

SubnetGroupName
Type: string

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

VpcEndpoint
Type: VpcEndpoint structure

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

VpcSecurityGroups
Type: Array of VpcSecurityGroupMembership structures

The security groups associated with the endpoint.

Errors

InvalidClusterSecurityGroupStateFault:

The state of the cluster security group is not available.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidEndpointStateFault:

The status of the endpoint is not valid.

EndpointNotFoundFault:

The endpoint name doesn't refer to an existing endpoint.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

ModifyEventSubscription

$result = $client->modifyEventSubscription([/* ... */]);
$promise = $client->modifyEventSubscriptionAsync([/* ... */]);

Modifies an existing Amazon Redshift event notification subscription.

Parameter Syntax

$result = $client->modifyEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'Severity' => '<string>',
    'SnsTopicArn' => '<string>',
    'SourceIds' => ['<string>', ...],
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Enabled
Type: boolean

A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

EventCategories
Type: Array of strings

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

Severity
Type: string

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

SnsTopicArn
Type: string

The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

SourceIds
Type: Array of strings

A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

SourceType
Type: string

The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

SubscriptionName
Required: Yes
Type: string

The name of the modified Amazon Redshift event notification subscription.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'Severity' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => <DateTime>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
EventSubscription
Type: EventSubscription structure

Describes event subscriptions.

Errors

SubscriptionNotFoundFault:

An Amazon Redshift event notification subscription with the specified name does not exist.

SNSInvalidTopicFault:

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

SNSNoAuthorizationFault:

You do not have permission to publish to the specified Amazon SNS topic.

SNSTopicArnNotFoundFault:

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

SubscriptionEventIdNotFoundFault:

An Amazon Redshift event with the specified event ID does not exist.

SubscriptionCategoryNotFoundFault:

The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.

SubscriptionSeverityNotFoundFault:

The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.

SourceNotFoundFault:

The specified Amazon Redshift event source could not be found.

InvalidSubscriptionStateFault:

The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.

ModifyRedshiftIdcApplication

$result = $client->modifyRedshiftIdcApplication([/* ... */]);
$promise = $client->modifyRedshiftIdcApplicationAsync([/* ... */]);

Changes an existing Amazon Redshift IAM Identity Center application.

Parameter Syntax

$result = $client->modifyRedshiftIdcApplication([
    'AuthorizedTokenIssuerList' => [
        [
            'AuthorizedAudiencesList' => ['<string>', ...],
            'TrustedTokenIssuerArn' => '<string>',
        ],
        // ...
    ],
    'IamRoleArn' => '<string>',
    'IdcDisplayName' => '<string>',
    'IdentityNamespace' => '<string>',
    'RedshiftIdcApplicationArn' => '<string>', // REQUIRED
    'ServiceIntegrations' => [
        [
            'LakeFormation' => [
                [
                    'LakeFormationQuery' => [
                        'Authorization' => 'Enabled|Disabled', // REQUIRED
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
AuthorizedTokenIssuerList
Type: Array of AuthorizedTokenIssuer structures

The authorized token issuer list for the Amazon Redshift IAM Identity Center application to change.

IamRoleArn
Type: string

The IAM role ARN associated with the Amazon Redshift IAM Identity Center application to change. It has the required permissions to be assumed and invoke the IDC Identity Center API.

IdcDisplayName
Type: string

The display name for the Amazon Redshift IAM Identity Center application to change. It appears on the console.

IdentityNamespace
Type: string

The namespace for the Amazon Redshift IAM Identity Center application to change. It determines which managed application verifies the connection token.

RedshiftIdcApplicationArn
Required: Yes
Type: string

The ARN for the Redshift application that integrates with IAM Identity Center.

ServiceIntegrations
Type: Array of ServiceIntegrationsUnion structures

A collection of service integrations associated with the application.

Result Syntax

[
    'RedshiftIdcApplication' => [
        'AuthorizedTokenIssuerList' => [
            [
                'AuthorizedAudiencesList' => ['<string>', ...],
                'TrustedTokenIssuerArn' => '<string>',
            ],
            // ...
        ],
        'IamRoleArn' => '<string>',
        'IdcDisplayName' => '<string>',
        'IdcInstanceArn' => '<string>',
        'IdcManagedApplicationArn' => '<string>',
        'IdcOnboardStatus' => '<string>',
        'IdentityNamespace' => '<string>',
        'RedshiftIdcApplicationArn' => '<string>',
        'RedshiftIdcApplicationName' => '<string>',
        'ServiceIntegrations' => [
            [
                'LakeFormation' => [
                    [
                        'LakeFormationQuery' => [
                            'Authorization' => 'Enabled|Disabled',
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
RedshiftIdcApplication
Type: RedshiftIdcApplication structure

Contains properties for the Redshift IDC application.

Errors

RedshiftIdcApplicationNotExistsFault:

The application you attempted to find doesn't exist.

DependentServiceUnavailableFault:

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

UnsupportedOperationFault:

The requested operation isn't supported.

DependentServiceAccessDeniedFault:

A dependent service denied access for the integration.

ModifyScheduledAction

$result = $client->modifyScheduledAction([/* ... */]);
$promise = $client->modifyScheduledActionAsync([/* ... */]);

Modifies a scheduled action.

Parameter Syntax

$result = $client->modifyScheduledAction([
    'Enable' => true || false,
    'EndTime' => <integer || string || DateTime>,
    'IamRole' => '<string>',
    'Schedule' => '<string>',
    'ScheduledActionDescription' => '<string>',
    'ScheduledActionName' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>,
    'TargetAction' => [
        'PauseCluster' => [
            'ClusterIdentifier' => '<string>', // REQUIRED
        ],
        'ResizeCluster' => [
            'Classic' => true || false,
            'ClusterIdentifier' => '<string>', // REQUIRED
            'ClusterType' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'ReservedNodeId' => '<string>',
            'TargetReservedNodeOfferingId' => '<string>',
        ],
        'ResumeCluster' => [
            'ClusterIdentifier' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
Enable
Type: boolean

A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

IamRole
Type: string

A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Schedule
Type: string

A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

ScheduledActionDescription
Type: string

A modified description of the scheduled action.

ScheduledActionName
Required: Yes
Type: string

The name of the scheduled action to modify.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

TargetAction
Type: ScheduledActionType structure

A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

Result Syntax

[
    'EndTime' => <DateTime>,
    'IamRole' => '<string>',
    'NextInvocations' => [<DateTime>, ...],
    'Schedule' => '<string>',
    'ScheduledActionDescription' => '<string>',
    'ScheduledActionName' => '<string>',
    'StartTime' => <DateTime>,
    'State' => 'ACTIVE|DISABLED',
    'TargetAction' => [
        'PauseCluster' => [
            'ClusterIdentifier' => '<string>',
        ],
        'ResizeCluster' => [
            'Classic' => true || false,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'ReservedNodeId' => '<string>',
            'TargetReservedNodeOfferingId' => '<string>',
        ],
        'ResumeCluster' => [
            'ClusterIdentifier' => '<string>',
        ],
    ],
]

Result Details

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

IamRole
Type: string

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

NextInvocations
Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s

List of times when the scheduled action will run.

Schedule
Type: string

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

ScheduledActionDescription
Type: string

The description of the scheduled action.

ScheduledActionName
Type: string

The name of the scheduled action.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

State
Type: string

The state of the scheduled action. For example, DISABLED.

TargetAction
Type: ScheduledActionType structure

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

ScheduledActionNotFoundFault:

The scheduled action cannot be found.

ScheduledActionTypeUnsupportedFault:

The action type specified for a scheduled action is not supported.

InvalidScheduleFault:

The schedule you submitted isn't valid.

InvalidScheduledActionFault:

The scheduled action is not valid.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

UnsupportedOperationFault:

The requested operation isn't supported.

ModifySnapshotCopyRetentionPeriod

$result = $client->modifySnapshotCopyRetentionPeriod([/* ... */]);
$promise = $client->modifySnapshotCopyRetentionPeriodAsync([/* ... */]);

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Parameter Syntax

$result = $client->modifySnapshotCopyRetentionPeriod([
    'ClusterIdentifier' => '<string>', // REQUIRED
    'Manual' => true || false,
    'RetentionPeriod' => <integer>, // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Manual
Type: boolean

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

RetentionPeriod
Required: Yes
Type: int

The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

SnapshotCopyDisabledFault:

Cross-region snapshot copy was temporarily disabled. Try your request again.

UnauthorizedOperation:

Your account is not authorized to perform the requested operation.

InvalidClusterStateFault:

The specified cluster is not in the available state.

InvalidRetentionPeriodFault:

The retention period specified is either in the past or is not a valid value.

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

ModifySnapshotSchedule

$result = $client->modifySnapshotSchedule([/* ... */]);
$promise = $client->modifySnapshotScheduleAsync([/* ... */]);

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

Parameter Syntax

$result = $client->modifySnapshotSchedule([
    'ScheduleDefinitions' => ['<string>', ...], // REQUIRED
    'ScheduleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ScheduleDefinitions
Required: Yes
Type: Array of strings

An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".

ScheduleIdentifier
Required: Yes
Type: string

A unique alphanumeric identifier of the schedule to modify.

Result Syntax

[
    'AssociatedClusterCount' => <integer>,
    'AssociatedClusters' => [
        [
            'ClusterIdentifier' => '<string>',
            'ScheduleAssociationState' => 'MODIFYING|ACTIVE|FAILED',
        ],
        // ...
    ],
    'NextInvocations' => [<DateTime>, ...],
    'ScheduleDefinitions' => ['<string>', ...],
    'ScheduleDescription' => '<string>',
    'ScheduleIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
AssociatedClusterCount
Type: int

The number of clusters associated with the schedule.

AssociatedClusters
Type: Array of ClusterAssociatedToSchedule structures

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

NextInvocations
Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s

ScheduleDefinitions
Type: Array of strings

A list of ScheduleDefinitions.

ScheduleDescription
Type: string

The description of the schedule.

ScheduleIdentifier
Type: string

A unique identifier for the schedule.

Tags
Type: Array of Tag structures

An optional set of tags describing the schedule.

Errors

InvalidScheduleFault:

The schedule you submitted isn't valid.

SnapshotScheduleNotFoundFault:

We could not find the specified snapshot schedule.

SnapshotScheduleUpdateInProgressFault:

The specified snapshot schedule is already being updated.

ModifyUsageLimit

$result = $client->modifyUsageLimit([/* ... */]);
$promise = $client->modifyUsageLimitAsync([/* ... */]);

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Parameter Syntax

$result = $client->modifyUsageLimit([
    'Amount' => <integer>,
    'BreachAction' => 'log|emit-metric|disable',
    'UsageLimitId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Amount
Type: long (int|float)

The new limit amount. For more information about this parameter, see UsageLimit.

BreachAction
Type: string

The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.

UsageLimitId
Required: Yes
Type: string

The identifier of the usage limit to modify.

Result Syntax

[
    'Amount' => <integer>,
    'BreachAction' => 'log|emit-metric|disable',
    'ClusterIdentifier' => '<string>',
    'FeatureType' => 'spectrum|concurrency-scaling|cross-region-datasharing',
    'LimitType' => 'time|data-scanned',
    'Period' => 'daily|weekly|monthly',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UsageLimitId' => '<string>',
]

Result Details

Members
Amount
Type: long (int|float)

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

BreachAction
Type: string

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

ClusterIdentifier
Type: string

The identifier of the cluster with a usage limit.

FeatureType
Type: string

The Amazon Redshift feature to which the limit applies.

LimitType
Type: string

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Period
Type: string

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Tags
Type: Array of Tag structures

A list of tag instances.

UsageLimitId
Type: string

The identifier of the usage limit.

Errors

InvalidUsageLimitFault:

The usage limit is not valid.

UsageLimitNotFoundFault:

The usage limit identifier can't be found.

UnsupportedOperationFault:

The requested operation isn't supported.

PauseCluster

$result = $client->pauseCluster([/* ... */]);
$promise = $client->pauseClusterAsync([/* ... */]);

Pauses a cluster.

Parameter Syntax

$result = $client->pauseCluster([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The identifier of the cluster to be paused.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

InvalidClusterStateFault:

The specified cluster is not in the available state.

UnsupportedOperationFault:

The requested operation isn't supported.

PurchaseReservedNodeOffering

$result = $client->purchaseReservedNodeOffering([/* ... */]);
$promise = $client->purchaseReservedNodeOfferingAsync([/* ... */]);

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->purchaseReservedNodeOffering([
    'NodeCount' => <integer>,
    'ReservedNodeOfferingId' => '<string>', // REQUIRED
]);

Parameter Details

Members
NodeCount
Type: int

The number of reserved nodes that you want to purchase.

Default: 1

ReservedNodeOfferingId
Required: Yes
Type: string

The unique identifier of the reserved node offering you want to purchase.

Result Syntax

[
    'ReservedNode' => [
        'CurrencyCode' => '<string>',
        'Duration' => <integer>,
        'FixedPrice' => <float>,
        'NodeCount' => <integer>,
        'NodeType' => '<string>',
        'OfferingType' => '<string>',
        'RecurringCharges' => [
            [
                'RecurringChargeAmount' => <float>,
                'RecurringChargeFrequency' => '<string>',
            ],
            // ...
        ],
        'ReservedNodeId' => '<string>',
        'ReservedNodeOfferingId' => '<string>',
        'ReservedNodeOfferingType' => 'Regular|Upgradable',
        'StartTime' => <DateTime>,
        'State' => '<string>',
        'UsagePrice' => <float>,
    ],
]

Result Details

Members
ReservedNode
Type: ReservedNode structure

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

Errors

ReservedNodeOfferingNotFoundFault:

Specified offering does not exist.

ReservedNodeAlreadyExistsFault:

User already has a reservation with the given identifier.

ReservedNodeQuotaExceededFault:

Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

UnsupportedOperationFault:

The requested operation isn't supported.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Updates the resource policy for a specified resource.

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Policy
Required: Yes
Type: string

The content of the resource policy being updated.

ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource of which its resource policy is updated.

Result Syntax

[
    'ResourcePolicy' => [
        'Policy' => '<string>',
        'ResourceArn' => '<string>',
    ],
]

Result Details

Members
ResourcePolicy
Type: ResourcePolicy structure

The content of the updated resource policy.

Errors

ResourceNotFoundFault:

The resource could not be found.

InvalidPolicyFault:

The resource policy isn't valid.

ConflictPolicyUpdateFault:

There is a conflict while updating the resource policy.

UnsupportedOperationFault:

The requested operation isn't supported.

RebootCluster

$result = $client->rebootCluster([/* ... */]);
$promise = $client->rebootClusterAsync([/* ... */]);

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Parameter Syntax

$result = $client->rebootCluster([
    'ClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClusterIdentifier
Required: Yes
Type: string

The cluster identifier.

Result Syntax

[
    'Cluster' => [
        'AllowVersionUpgrade' => true || false,
        'AquaConfiguration' => [
            'AquaConfigurationStatus' => 'enabled|disabled|auto',
            'AquaStatus' => 'enabled|disabled|applying',
        ],
        'AutomatedSnapshotRetentionPeriod' => <integer>,
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneRelocationStatus' => '<string>',
        'ClusterAvailabilityStatus' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterIdentifier' => '<string>',
        'ClusterNamespaceArn' => '<string>',
        'ClusterNodes' => [
            [
                'NodeRole' => '<string>',
                'PrivateIPAddress' => '<string>',
                'PublicIPAddress' => '<string>',
            ],
            // ...
        ],
        'ClusterParameterGroups' => [
            [
                'ClusterParameterStatusList' => [
                    [
                        'ParameterApplyErrorDescription' => '<string>',
                        'ParameterApplyStatus' => '<string>',
                        'ParameterName' => '<string>',
                    ],
                    // ...
                ],
                'ParameterApplyStatus' => '<string>',
                'ParameterGroupName' => '<string>',
            ],
            // ...
        ],
        'ClusterPublicKey' => '<string>',
        'ClusterRevisionNumber' => '<string>',
        'ClusterSecurityGroups' => [
            [
                'ClusterSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'ClusterSnapshotCopyStatus' => [
            'DestinationRegion' => '<string>',
            'ManualSnapshotRetentionPeriod' => <integer>,
            'RetentionPeriod' => <integer>,
            'SnapshotCopyGrantName' => '<string>',
        ],
        'ClusterStatus' => '<string>',
        'ClusterSubnetGroupName' => '<string>',
        'ClusterVersion' => '<string>',
        'CustomDomainCertificateArn' => '<string>',
        'CustomDomainCertificateExpiryDate' => <DateTime>,
        'CustomDomainName' => '<string>',
        'DBName' => '<string>',
        'DataTransferProgress' => [
            'CurrentRateInMegaBytesPerSecond' => <float>,
            'DataTransferredInMegaBytes' => <integer>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'Status' => '<string>',
            'TotalDataInMegaBytes' => <integer>,
        ],
        'DefaultIamRoleArn' => '<string>',
        'DeferredMaintenanceWindows' => [
            [
                'DeferMaintenanceEndTime' => <DateTime>,
                'DeferMaintenanceIdentifier' => '<string>',
                'DeferMaintenanceStartTime' => <DateTime>,
            ],
            // ...
        ],
        'ElasticIpStatus' => [
            'ElasticIp' => '<string>',
            'Status' => '<string>',
        ],
        'ElasticResizeNumberOfNodeOptions' => '<string>',
        'Encrypted' => true || false,
        'Endpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
            'VpcEndpoints' => [
                [
                    'NetworkInterfaces' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'Ipv6Address' => '<string>',
                            'NetworkInterfaceId' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'SubnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcEndpointId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'EnhancedVpcRouting' => true || false,
        'ExpectedNextSnapshotScheduleTime' => <DateTime>,
        'ExpectedNextSnapshotScheduleTimeStatus' => '<string>',
        'HsmStatus' => [
            'HsmClientCertificateIdentifier' => '<string>',
            'HsmConfigurationIdentifier' => '<string>',
            'Status' => '<string>',
        ],
        'IamRoles' => [
            [
                'ApplyStatus' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            // ...
        ],
        'IpAddressType' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceTrackName' => '<string>',
        'ManualSnapshotRetentionPeriod' => <integer>,
        'MasterPasswordSecretArn' => '<string>',
        'MasterPasswordSecretKmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'ModifyStatus' => '<string>',
        'MultiAZ' => '<string>',
        'MultiAZSecondary' => [
            'AvailabilityZone' => '<string>',
            'ClusterNodes' => [
                [
                    'NodeRole' => '<string>',
                    'PrivateIPAddress' => '<string>',
                    'PublicIPAddress' => '<string>',
                ],
                // ...
            ],
        ],
        'NextMaintenanceWindowStartTime' => <DateTime>,
        'NodeType' => '<string>',
        'NumberOfNodes' => <integer>,
        'PendingActions' => ['<string>', ...],
        'PendingModifiedValues' => [
            'AutomatedSnapshotRetentionPeriod' => <integer>,
            'ClusterIdentifier' => '<string>',
            'ClusterType' => '<string>',
            'ClusterVersion' => '<string>',
            'EncryptionType' => '<string>',
            'EnhancedVpcRouting' => true || false,
            'MaintenanceTrackName' => '<string>',
            'MasterUserPassword' => '<string>',
            'NodeType' => '<string>',
            'NumberOfNodes' => <integer>,
            'PubliclyAccessible' => true || false,
        ],
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'ReservedNodeExchangeStatus' => [
            'RequestTime' => <DateTime>,
            'ReservedNodeExchangeRequestId' => '<string>',
            'SourceReservedNodeCount' => <integer>,
            'SourceReservedNodeId' => '<string>',
            'SourceReservedNodeType' => '<string>',
            'Status' => 'REQUESTED|PENDING|IN_PROGRESS|RETRYING|SUCCEEDED|FAILED',
            'TargetReservedNodeCount' => <integer>,
            'TargetReservedNodeOfferingId' => '<string>',
            'TargetReservedNodeType' => '<string>',
        ],
        'ResizeInfo' => [
            'AllowCancelResize' => true || false,
            'ResizeType' => '<string>',
        ],
        'RestoreStatus' => [
            'CurrentRestoreRateInMegaBytesPerSecond' => <float>,
            'ElapsedTimeInSeconds' => <integer>,
            'EstimatedTimeToCompletionInSeconds' => <integer>,
            'ProgressInMegaBytes' => <integer>,
            'SnapshotSizeInMegaBytes' => <integer>,
            'Status' => '<string>',
        ],
        'SnapshotScheduleIdentifier' => '<string>',
        'SnapshotScheduleState' => 'MODIFYING|ACTIVE|FAILED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TotalStorageCapacityInMegaBytes' => <integer>,
        'VpcId' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Cluster
Type: Cluster structure

Describes a cluster.

Errors

InvalidClusterStateFault:

The specified cluster is not in the available state.

ClusterNotFoundFault:

The ClusterIdentifier parameter does not refer to an existing cluster.

RejectDataShare