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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details