ConvertRecoveryPointToSnapshot

$result = $client->convertRecoveryPointToSnapshot([/* ... */]);
$promise = $client->convertRecoveryPointToSnapshotAsync([/* ... */]);

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.

Parameter Syntax

$result = $client->convertRecoveryPointToSnapshot([
    'recoveryPointId' => '<string>', // REQUIRED
    'retentionPeriod' => <integer>,
    'snapshotName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'snapshot' => [
        'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
        'accountsWithRestoreAccess' => ['<string>', ...],
        'actualIncrementalBackupSizeInMegaBytes' => <float>,
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'backupProgressInMegaBytes' => <float>,
        'currentBackupRateInMegaBytesPerSecond' => <float>,
        'elapsedTimeInSeconds' => <integer>,
        'estimatedSecondsToCompletion' => <integer>,
        'kmsKeyId' => '<string>',
        'namespaceArn' => '<string>',
        'namespaceName' => '<string>',
        'ownerAccount' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreateTime' => <DateTime>,
        'snapshotName' => '<string>',
        'snapshotRemainingDays' => <integer>,
        'snapshotRetentionPeriod' => <integer>,
        'snapshotRetentionStartTime' => <DateTime>,
        'status' => 'AVAILABLE|CREATING|DELETED|CANCELLED|FAILED|COPYING',
        'totalBackupSizeInMegaBytes' => <float>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

TooManyTagsException:

The request exceeded the number of tags allowed for a resource.

ServiceQuotaExceededException:

The service limit was exceeded.

CreateCustomDomainAssociation

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

Creates a custom domain association for Amazon Redshift Serverless.

Parameter Syntax

$result = $client->createCustomDomainAssociation([
    'customDomainCertificateArn' => '<string>', // REQUIRED
    'customDomainName' => '<string>', // REQUIRED
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'customDomainCertificateArn' => '<string>',
    'customDomainCertificateExpiryTime' => <DateTime>,
    'customDomainName' => '<string>',
    'workgroupName' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

CreateEndpointAccess

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

Creates an Amazon Redshift Serverless managed VPC endpoint.

Parameter Syntax

$result = $client->createEndpointAccess([
    'endpointName' => '<string>', // REQUIRED
    'ownerAccount' => '<string>',
    'subnetIds' => ['<string>', ...], // REQUIRED
    'vpcSecurityGroupIds' => ['<string>', ...],
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'endpoint' => [
        'address' => '<string>',
        'endpointArn' => '<string>',
        'endpointCreateTime' => <DateTime>,
        'endpointName' => '<string>',
        'endpointStatus' => '<string>',
        'port' => <integer>,
        'subnetIds' => ['<string>', ...],
        'vpcEndpoint' => [
            'networkInterfaces' => [
                [
                    'availabilityZone' => '<string>',
                    'ipv6Address' => '<string>',
                    'networkInterfaceId' => '<string>',
                    'privateIpAddress' => '<string>',
                    'subnetId' => '<string>',
                ],
                // ...
            ],
            'vpcEndpointId' => '<string>',
            'vpcId' => '<string>',
        ],
        'vpcSecurityGroups' => [
            [
                'status' => '<string>',
                'vpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The service limit was exceeded.

CreateNamespace

$result = $client->createNamespace([/* ... */]);
$promise = $client->createNamespaceAsync([/* ... */]);

Creates a namespace in Amazon Redshift Serverless.

Parameter Syntax

$result = $client->createNamespace([
    'adminPasswordSecretKmsKeyId' => '<string>',
    'adminUserPassword' => '<string>',
    'adminUsername' => '<string>',
    'dbName' => '<string>',
    'defaultIamRoleArn' => '<string>',
    'iamRoles' => ['<string>', ...],
    'kmsKeyId' => '<string>',
    'logExports' => ['<string>', ...],
    'manageAdminPassword' => true || false,
    'namespaceName' => '<string>', // REQUIRED
    'redshiftIdcApplicationArn' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'namespace' => [
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'creationDate' => <DateTime>,
        'dbName' => '<string>',
        'defaultIamRoleArn' => '<string>',
        'iamRoles' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'logExports' => ['<string>', ...],
        'namespaceArn' => '<string>',
        'namespaceId' => '<string>',
        'namespaceName' => '<string>',
        'status' => 'AVAILABLE|MODIFYING|DELETING',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

TooManyTagsException:

The request exceeded the number of tags allowed for a resource.

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 CreateSnapshot API operation.

Parameter Syntax

$result = $client->createScheduledAction([
    'enabled' => true || false,
    'endTime' => <integer || string || DateTime>,
    'namespaceName' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'schedule' => [ // REQUIRED
        'at' => <integer || string || DateTime>,
        'cron' => '<string>',
    ],
    'scheduledActionDescription' => '<string>',
    'scheduledActionName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>,
    'targetAction' => [ // REQUIRED
        'createSnapshot' => [
            'namespaceName' => '<string>', // REQUIRED
            'retentionPeriod' => <integer>,
            'snapshotNamePrefix' => '<string>', // REQUIRED
            'tags' => [
                [
                    'key' => '<string>', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'scheduledAction' => [
        'endTime' => <DateTime>,
        'namespaceName' => '<string>',
        'nextInvocations' => [<DateTime>, ...],
        'roleArn' => '<string>',
        'schedule' => [
            'at' => <DateTime>,
            'cron' => '<string>',
        ],
        'scheduledActionDescription' => '<string>',
        'scheduledActionName' => '<string>',
        'scheduledActionUuid' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'ACTIVE|DISABLED',
        'targetAction' => [
            'createSnapshot' => [
                'namespaceName' => '<string>',
                'retentionPeriod' => <integer>,
                'snapshotNamePrefix' => '<string>',
                'tags' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

CreateSnapshot

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.

Parameter Syntax

$result = $client->createSnapshot([
    'namespaceName' => '<string>', // REQUIRED
    'retentionPeriod' => <integer>,
    'snapshotName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'snapshot' => [
        'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
        'accountsWithRestoreAccess' => ['<string>', ...],
        'actualIncrementalBackupSizeInMegaBytes' => <float>,
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'backupProgressInMegaBytes' => <float>,
        'currentBackupRateInMegaBytesPerSecond' => <float>,
        'elapsedTimeInSeconds' => <integer>,
        'estimatedSecondsToCompletion' => <integer>,
        'kmsKeyId' => '<string>',
        'namespaceArn' => '<string>',
        'namespaceName' => '<string>',
        'ownerAccount' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreateTime' => <DateTime>,
        'snapshotName' => '<string>',
        'snapshotRemainingDays' => <integer>,
        'snapshotRetentionPeriod' => <integer>,
        'snapshotRetentionStartTime' => <DateTime>,
        'status' => 'AVAILABLE|CREATING|DELETED|CANCELLED|FAILED|COPYING',
        'totalBackupSizeInMegaBytes' => <float>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

TooManyTagsException:

The request exceeded the number of tags allowed for a resource.

ServiceQuotaExceededException:

The service limit was exceeded.

CreateSnapshotCopyConfiguration

$result = $client->createSnapshotCopyConfiguration([/* ... */]);
$promise = $client->createSnapshotCopyConfigurationAsync([/* ... */]);

Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.

Parameter Syntax

$result = $client->createSnapshotCopyConfiguration([
    'destinationKmsKeyId' => '<string>',
    'destinationRegion' => '<string>', // REQUIRED
    'namespaceName' => '<string>', // REQUIRED
    'snapshotRetentionPeriod' => <integer>,
]);

Parameter Details

Result Syntax

[
    'snapshotCopyConfiguration' => [
        'destinationKmsKeyId' => '<string>',
        'destinationRegion' => '<string>',
        'namespaceName' => '<string>',
        'snapshotCopyConfigurationArn' => '<string>',
        'snapshotCopyConfigurationId' => '<string>',
        'snapshotRetentionPeriod' => <integer>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The service limit was exceeded.

CreateUsageLimit

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

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Parameter Syntax

$result = $client->createUsageLimit([
    'amount' => <integer>, // REQUIRED
    'breachAction' => 'log|emit-metric|deactivate',
    'period' => 'daily|weekly|monthly',
    'resourceArn' => '<string>', // REQUIRED
    'usageType' => 'serverless-compute|cross-region-datasharing', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'usageLimit' => [
        'amount' => <integer>,
        'breachAction' => 'log|emit-metric|deactivate',
        'period' => 'daily|weekly|monthly',
        'resourceArn' => '<string>',
        'usageLimitArn' => '<string>',
        'usageLimitId' => '<string>',
        'usageType' => 'serverless-compute|cross-region-datasharing',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException:

The service limit was exceeded.

CreateWorkgroup

$result = $client->createWorkgroup([/* ... */]);
$promise = $client->createWorkgroupAsync([/* ... */]);

Creates an workgroup in Amazon Redshift Serverless.

Parameter Syntax

$result = $client->createWorkgroup([
    'baseCapacity' => <integer>,
    'configParameters' => [
        [
            'parameterKey' => '<string>',
            'parameterValue' => '<string>',
        ],
        // ...
    ],
    'enhancedVpcRouting' => true || false,
    'ipAddressType' => '<string>',
    'maxCapacity' => <integer>,
    'namespaceName' => '<string>', // REQUIRED
    'port' => <integer>,
    'publiclyAccessible' => true || false,
    'securityGroupIds' => ['<string>', ...],
    'subnetIds' => ['<string>', ...],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'workgroup' => [
        'baseCapacity' => <integer>,
        'configParameters' => [
            [
                'parameterKey' => '<string>',
                'parameterValue' => '<string>',
            ],
            // ...
        ],
        'creationDate' => <DateTime>,
        'crossAccountVpcs' => ['<string>', ...],
        'customDomainCertificateArn' => '<string>',
        'customDomainCertificateExpiryTime' => <DateTime>,
        'customDomainName' => '<string>',
        'endpoint' => [
            'address' => '<string>',
            'port' => <integer>,
            'vpcEndpoints' => [
                [
                    'networkInterfaces' => [
                        [
                            'availabilityZone' => '<string>',
                            'ipv6Address' => '<string>',
                            'networkInterfaceId' => '<string>',
                            'privateIpAddress' => '<string>',
                            'subnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'vpcEndpointId' => '<string>',
                    'vpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'enhancedVpcRouting' => true || false,
        'ipAddressType' => '<string>',
        'maxCapacity' => <integer>,
        'namespaceName' => '<string>',
        'patchVersion' => '<string>',
        'port' => <integer>,
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

InsufficientCapacityException:

There is an insufficient capacity to perform the action.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

TooManyTagsException:

The request exceeded the number of tags allowed for a resource.

Ipv6CidrBlockNotFoundException:

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.

DeleteCustomDomainAssociation

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

Deletes a custom domain association for Amazon Redshift Serverless.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

DeleteEndpointAccess

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

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'endpoint' => [
        'address' => '<string>',
        'endpointArn' => '<string>',
        'endpointCreateTime' => <DateTime>,
        'endpointName' => '<string>',
        'endpointStatus' => '<string>',
        'port' => <integer>,
        'subnetIds' => ['<string>', ...],
        'vpcEndpoint' => [
            'networkInterfaces' => [
                [
                    'availabilityZone' => '<string>',
                    'ipv6Address' => '<string>',
                    'networkInterfaceId' => '<string>',
                    'privateIpAddress' => '<string>',
                    'subnetId' => '<string>',
                ],
                // ...
            ],
            'vpcEndpointId' => '<string>',
            'vpcId' => '<string>',
        ],
        'vpcSecurityGroups' => [
            [
                'status' => '<string>',
                'vpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

DeleteNamespace

$result = $client->deleteNamespace([/* ... */]);
$promise = $client->deleteNamespaceAsync([/* ... */]);

Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

Parameter Syntax

$result = $client->deleteNamespace([
    'finalSnapshotName' => '<string>',
    'finalSnapshotRetentionPeriod' => <integer>,
    'namespaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'namespace' => [
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'creationDate' => <DateTime>,
        'dbName' => '<string>',
        'defaultIamRoleArn' => '<string>',
        'iamRoles' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'logExports' => ['<string>', ...],
        'namespaceArn' => '<string>',
        'namespaceId' => '<string>',
        'namespaceName' => '<string>',
        'status' => 'AVAILABLE|MODIFYING|DELETING',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

DeleteResourcePolicy

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

Deletes the specified resource policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

DeleteScheduledAction

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

Deletes a scheduled action.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'scheduledAction' => [
        'endTime' => <DateTime>,
        'namespaceName' => '<string>',
        'nextInvocations' => [<DateTime>, ...],
        'roleArn' => '<string>',
        'schedule' => [
            'at' => <DateTime>,
            'cron' => '<string>',
        ],
        'scheduledActionDescription' => '<string>',
        'scheduledActionName' => '<string>',
        'scheduledActionUuid' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'ACTIVE|DISABLED',
        'targetAction' => [
            'createSnapshot' => [
                'namespaceName' => '<string>',
                'retentionPeriod' => <integer>,
                'snapshotNamePrefix' => '<string>',
                'tags' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

DeleteSnapshot

$result = $client->deleteSnapshot([/* ... */]);
$promise = $client->deleteSnapshotAsync([/* ... */]);

Deletes a snapshot from Amazon Redshift Serverless.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'snapshot' => [
        'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
        'accountsWithRestoreAccess' => ['<string>', ...],
        'actualIncrementalBackupSizeInMegaBytes' => <float>,
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'backupProgressInMegaBytes' => <float>,
        'currentBackupRateInMegaBytesPerSecond' => <float>,
        'elapsedTimeInSeconds' => <integer>,
        'estimatedSecondsToCompletion' => <integer>,
        'kmsKeyId' => '<string>',
        'namespaceArn' => '<string>',
        'namespaceName' => '<string>',
        'ownerAccount' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreateTime' => <DateTime>,
        'snapshotName' => '<string>',
        'snapshotRemainingDays' => <integer>,
        'snapshotRetentionPeriod' => <integer>,
        'snapshotRetentionStartTime' => <DateTime>,
        'status' => 'AVAILABLE|CREATING|DELETED|CANCELLED|FAILED|COPYING',
        'totalBackupSizeInMegaBytes' => <float>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

DeleteSnapshotCopyConfiguration

$result = $client->deleteSnapshotCopyConfiguration([/* ... */]);
$promise = $client->deleteSnapshotCopyConfigurationAsync([/* ... */]);

Deletes a snapshot copy configuration

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'snapshotCopyConfiguration' => [
        'destinationKmsKeyId' => '<string>',
        'destinationRegion' => '<string>',
        'namespaceName' => '<string>',
        'snapshotCopyConfigurationArn' => '<string>',
        'snapshotCopyConfigurationId' => '<string>',
        'snapshotRetentionPeriod' => <integer>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteUsageLimit

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

Deletes a usage limit from Amazon Redshift Serverless.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'usageLimit' => [
        'amount' => <integer>,
        'breachAction' => 'log|emit-metric|deactivate',
        'period' => 'daily|weekly|monthly',
        'resourceArn' => '<string>',
        'usageLimitArn' => '<string>',
        'usageLimitId' => '<string>',
        'usageType' => 'serverless-compute|cross-region-datasharing',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

DeleteWorkgroup

$result = $client->deleteWorkgroup([/* ... */]);
$promise = $client->deleteWorkgroupAsync([/* ... */]);

Deletes a workgroup.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'workgroup' => [
        'baseCapacity' => <integer>,
        'configParameters' => [
            [
                'parameterKey' => '<string>',
                'parameterValue' => '<string>',
            ],
            // ...
        ],
        'creationDate' => <DateTime>,
        'crossAccountVpcs' => ['<string>', ...],
        'customDomainCertificateArn' => '<string>',
        'customDomainCertificateExpiryTime' => <DateTime>,
        'customDomainName' => '<string>',
        'endpoint' => [
            'address' => '<string>',
            'port' => <integer>,
            'vpcEndpoints' => [
                [
                    'networkInterfaces' => [
                        [
                            'availabilityZone' => '<string>',
                            'ipv6Address' => '<string>',
                            'networkInterfaceId' => '<string>',
                            'privateIpAddress' => '<string>',
                            'subnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'vpcEndpointId' => '<string>',
                    'vpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'enhancedVpcRouting' => true || false,
        'ipAddressType' => '<string>',
        'maxCapacity' => <integer>,
        'namespaceName' => '<string>',
        'patchVersion' => '<string>',
        'port' => <integer>,
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetCredentials

$result = $client->getCredentials([/* ... */]);
$promise = $client->getCredentialsAsync([/* ... */]);

Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

 <p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p> 

Parameter Syntax

$result = $client->getCredentials([
    'customDomainName' => '<string>',
    'dbName' => '<string>',
    'durationSeconds' => <integer>,
    'workgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dbPassword' => '<string>',
    'dbUser' => '<string>',
    'expiration' => <DateTime>,
    'nextRefreshTime' => <DateTime>,
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetCustomDomainAssociation

$result = $client->getCustomDomainAssociation([/* ... */]);
$promise = $client->getCustomDomainAssociationAsync([/* ... */]);

Gets information about a specific custom domain association.

Parameter Syntax

$result = $client->getCustomDomainAssociation([
    'customDomainName' => '<string>', // REQUIRED
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'customDomainCertificateArn' => '<string>',
    'customDomainCertificateExpiryTime' => <DateTime>,
    'customDomainName' => '<string>',
    'workgroupName' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

GetEndpointAccess

$result = $client->getEndpointAccess([/* ... */]);
$promise = $client->getEndpointAccessAsync([/* ... */]);

Returns information, such as the name, about a VPC endpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'endpoint' => [
        'address' => '<string>',
        'endpointArn' => '<string>',
        'endpointCreateTime' => <DateTime>,
        'endpointName' => '<string>',
        'endpointStatus' => '<string>',
        'port' => <integer>,
        'subnetIds' => ['<string>', ...],
        'vpcEndpoint' => [
            'networkInterfaces' => [
                [
                    'availabilityZone' => '<string>',
                    'ipv6Address' => '<string>',
                    'networkInterfaceId' => '<string>',
                    'privateIpAddress' => '<string>',
                    'subnetId' => '<string>',
                ],
                // ...
            ],
            'vpcEndpointId' => '<string>',
            'vpcId' => '<string>',
        ],
        'vpcSecurityGroups' => [
            [
                'status' => '<string>',
                'vpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetNamespace

$result = $client->getNamespace([/* ... */]);
$promise = $client->getNamespaceAsync([/* ... */]);

Returns information about a namespace in Amazon Redshift Serverless.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'namespace' => [
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'creationDate' => <DateTime>,
        'dbName' => '<string>',
        'defaultIamRoleArn' => '<string>',
        'iamRoles' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'logExports' => ['<string>', ...],
        'namespaceArn' => '<string>',
        'namespaceId' => '<string>',
        'namespaceName' => '<string>',
        'status' => 'AVAILABLE|MODIFYING|DELETING',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetRecoveryPoint

$result = $client->getRecoveryPoint([/* ... */]);
$promise = $client->getRecoveryPointAsync([/* ... */]);

Returns information about a recovery point.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'recoveryPoint' => [
        'namespaceArn' => '<string>',
        'namespaceName' => '<string>',
        'recoveryPointCreateTime' => <DateTime>,
        'recoveryPointId' => '<string>',
        'totalSizeInMegaBytes' => <float>,
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Returns a resource policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resourcePolicy' => [
        'policy' => '<string>',
        'resourceArn' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetScheduledAction

$result = $client->getScheduledAction([/* ... */]);
$promise = $client->getScheduledActionAsync([/* ... */]);

Returns information about a scheduled action.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'scheduledAction' => [
        'endTime' => <DateTime>,
        'namespaceName' => '<string>',
        'nextInvocations' => [<DateTime>, ...],
        'roleArn' => '<string>',
        'schedule' => [
            'at' => <DateTime>,
            'cron' => '<string>',
        ],
        'scheduledActionDescription' => '<string>',
        'scheduledActionName' => '<string>',
        'scheduledActionUuid' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'ACTIVE|DISABLED',
        'targetAction' => [
            'createSnapshot' => [
                'namespaceName' => '<string>',
                'retentionPeriod' => <integer>,
                'snapshotNamePrefix' => '<string>',
                'tags' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetSnapshot

$result = $client->getSnapshot([/* ... */]);
$promise = $client->getSnapshotAsync([/* ... */]);

Returns information about a specific snapshot.

Parameter Syntax

$result = $client->getSnapshot([
    'ownerAccount' => '<string>',
    'snapshotArn' => '<string>',
    'snapshotName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'snapshot' => [
        'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
        'accountsWithRestoreAccess' => ['<string>', ...],
        'actualIncrementalBackupSizeInMegaBytes' => <float>,
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'backupProgressInMegaBytes' => <float>,
        'currentBackupRateInMegaBytesPerSecond' => <float>,
        'elapsedTimeInSeconds' => <integer>,
        'estimatedSecondsToCompletion' => <integer>,
        'kmsKeyId' => '<string>',
        'namespaceArn' => '<string>',
        'namespaceName' => '<string>',
        'ownerAccount' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreateTime' => <DateTime>,
        'snapshotName' => '<string>',
        'snapshotRemainingDays' => <integer>,
        'snapshotRetentionPeriod' => <integer>,
        'snapshotRetentionStartTime' => <DateTime>,
        'status' => 'AVAILABLE|CREATING|DELETED|CANCELLED|FAILED|COPYING',
        'totalBackupSizeInMegaBytes' => <float>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetTableRestoreStatus

$result = $client->getTableRestoreStatus([/* ... */]);
$promise = $client->getTableRestoreStatusAsync([/* ... */]);

Returns information about a TableRestoreStatus object.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tableRestoreStatus' => [
        'message' => '<string>',
        'namespaceName' => '<string>',
        'newTableName' => '<string>',
        'progressInMegaBytes' => <integer>,
        'recoveryPointId' => '<string>',
        'requestTime' => <DateTime>,
        'snapshotName' => '<string>',
        'sourceDatabaseName' => '<string>',
        'sourceSchemaName' => '<string>',
        'sourceTableName' => '<string>',
        'status' => '<string>',
        'tableRestoreRequestId' => '<string>',
        'targetDatabaseName' => '<string>',
        'targetSchemaName' => '<string>',
        'totalDataInMegaBytes' => <integer>,
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetUsageLimit

$result = $client->getUsageLimit([/* ... */]);
$promise = $client->getUsageLimitAsync([/* ... */]);

Returns information about a usage limit.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'usageLimit' => [
        'amount' => <integer>,
        'breachAction' => 'log|emit-metric|deactivate',
        'period' => 'daily|weekly|monthly',
        'resourceArn' => '<string>',
        'usageLimitArn' => '<string>',
        'usageLimitId' => '<string>',
        'usageType' => 'serverless-compute|cross-region-datasharing',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

GetWorkgroup

$result = $client->getWorkgroup([/* ... */]);
$promise = $client->getWorkgroupAsync([/* ... */]);

Returns information about a specific workgroup.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'workgroup' => [
        'baseCapacity' => <integer>,
        'configParameters' => [
            [
                'parameterKey' => '<string>',
                'parameterValue' => '<string>',
            ],
            // ...
        ],
        'creationDate' => <DateTime>,
        'crossAccountVpcs' => ['<string>', ...],
        'customDomainCertificateArn' => '<string>',
        'customDomainCertificateExpiryTime' => <DateTime>,
        'customDomainName' => '<string>',
        'endpoint' => [
            'address' => '<string>',
            'port' => <integer>,
            'vpcEndpoints' => [
                [
                    'networkInterfaces' => [
                        [
                            'availabilityZone' => '<string>',
                            'ipv6Address' => '<string>',
                            'networkInterfaceId' => '<string>',
                            'privateIpAddress' => '<string>',
                            'subnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'vpcEndpointId' => '<string>',
                    'vpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'enhancedVpcRouting' => true || false,
        'ipAddressType' => '<string>',
        'maxCapacity' => <integer>,
        'namespaceName' => '<string>',
        'patchVersion' => '<string>',
        'port' => <integer>,
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListCustomDomainAssociations

$result = $client->listCustomDomainAssociations([/* ... */]);
$promise = $client->listCustomDomainAssociationsAsync([/* ... */]);

Lists custom domain associations for Amazon Redshift Serverless.

Parameter Syntax

$result = $client->listCustomDomainAssociations([
    'customDomainCertificateArn' => '<string>',
    'customDomainName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'associations' => [
        [
            'customDomainCertificateArn' => '<string>',
            'customDomainCertificateExpiryTime' => <DateTime>,
            'customDomainName' => '<string>',
            'workgroupName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

InvalidPaginationException:

The provided pagination token is invalid.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ListEndpointAccess

$result = $client->listEndpointAccess([/* ... */]);
$promise = $client->listEndpointAccessAsync([/* ... */]);

Returns an array of EndpointAccess objects and relevant information.

Parameter Syntax

$result = $client->listEndpointAccess([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'ownerAccount' => '<string>',
    'vpcId' => '<string>',
    'workgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'endpoints' => [
        [
            'address' => '<string>',
            'endpointArn' => '<string>',
            'endpointCreateTime' => <DateTime>,
            'endpointName' => '<string>',
            'endpointStatus' => '<string>',
            'port' => <integer>,
            'subnetIds' => ['<string>', ...],
            'vpcEndpoint' => [
                'networkInterfaces' => [
                    [
                        'availabilityZone' => '<string>',
                        'ipv6Address' => '<string>',
                        'networkInterfaceId' => '<string>',
                        'privateIpAddress' => '<string>',
                        'subnetId' => '<string>',
                    ],
                    // ...
                ],
                'vpcEndpointId' => '<string>',
                'vpcId' => '<string>',
            ],
            'vpcSecurityGroups' => [
                [
                    'status' => '<string>',
                    'vpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
            'workgroupName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListNamespaces

$result = $client->listNamespaces([/* ... */]);
$promise = $client->listNamespacesAsync([/* ... */]);

Returns information about a list of specified namespaces.

Parameter Syntax

$result = $client->listNamespaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'namespaces' => [
        [
            'adminPasswordSecretArn' => '<string>',
            'adminPasswordSecretKmsKeyId' => '<string>',
            'adminUsername' => '<string>',
            'creationDate' => <DateTime>,
            'dbName' => '<string>',
            'defaultIamRoleArn' => '<string>',
            'iamRoles' => ['<string>', ...],
            'kmsKeyId' => '<string>',
            'logExports' => ['<string>', ...],
            'namespaceArn' => '<string>',
            'namespaceId' => '<string>',
            'namespaceName' => '<string>',
            'status' => 'AVAILABLE|MODIFYING|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListRecoveryPoints

$result = $client->listRecoveryPoints([/* ... */]);
$promise = $client->listRecoveryPointsAsync([/* ... */]);

Returns an array of recovery points.

Parameter Syntax

$result = $client->listRecoveryPoints([
    'endTime' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'nextToken' => '<string>',
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recoveryPoints' => [
        [
            'namespaceArn' => '<string>',
            'namespaceName' => '<string>',
            'recoveryPointCreateTime' => <DateTime>,
            'recoveryPointId' => '<string>',
            'totalSizeInMegaBytes' => <float>,
            'workgroupName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListScheduledActions

$result = $client->listScheduledActions([/* ... */]);
$promise = $client->listScheduledActionsAsync([/* ... */]);

Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.

Parameter Syntax

$result = $client->listScheduledActions([
    'maxResults' => <integer>,
    'namespaceName' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'scheduledActions' => [
        [
            'namespaceName' => '<string>',
            'scheduledActionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

InvalidPaginationException:

The provided pagination token is invalid.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListSnapshotCopyConfigurations

$result = $client->listSnapshotCopyConfigurations([/* ... */]);
$promise = $client->listSnapshotCopyConfigurationsAsync([/* ... */]);

Returns a list of snapshot copy configurations.

Parameter Syntax

$result = $client->listSnapshotCopyConfigurations([
    'maxResults' => <integer>,
    'namespaceName' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'snapshotCopyConfigurations' => [
        [
            'destinationKmsKeyId' => '<string>',
            'destinationRegion' => '<string>',
            'namespaceName' => '<string>',
            'snapshotCopyConfigurationArn' => '<string>',
            'snapshotCopyConfigurationId' => '<string>',
            'snapshotRetentionPeriod' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

InvalidPaginationException:

The provided pagination token is invalid.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListSnapshots

$result = $client->listSnapshots([/* ... */]);
$promise = $client->listSnapshotsAsync([/* ... */]);

Returns a list of snapshots.

Parameter Syntax

$result = $client->listSnapshots([
    'endTime' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'nextToken' => '<string>',
    'ownerAccount' => '<string>',
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'snapshots' => [
        [
            'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
            'accountsWithRestoreAccess' => ['<string>', ...],
            'actualIncrementalBackupSizeInMegaBytes' => <float>,
            'adminPasswordSecretArn' => '<string>',
            'adminPasswordSecretKmsKeyId' => '<string>',
            'adminUsername' => '<string>',
            'backupProgressInMegaBytes' => <float>,
            'currentBackupRateInMegaBytesPerSecond' => <float>,
            'elapsedTimeInSeconds' => <integer>,
            'estimatedSecondsToCompletion' => <integer>,
            'kmsKeyId' => '<string>',
            'namespaceArn' => '<string>',
            'namespaceName' => '<string>',
            'ownerAccount' => '<string>',
            'snapshotArn' => '<string>',
            'snapshotCreateTime' => <DateTime>,
            'snapshotName' => '<string>',
            'snapshotRemainingDays' => <integer>,
            'snapshotRetentionPeriod' => <integer>,
            'snapshotRetentionStartTime' => <DateTime>,
            'status' => 'AVAILABLE|CREATING|DELETED|CANCELLED|FAILED|COPYING',
            'totalBackupSizeInMegaBytes' => <float>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListTableRestoreStatus

$result = $client->listTableRestoreStatus([/* ... */]);
$promise = $client->listTableRestoreStatusAsync([/* ... */]);

Returns information about an array of TableRestoreStatus objects.

Parameter Syntax

$result = $client->listTableRestoreStatus([
    'maxResults' => <integer>,
    'namespaceName' => '<string>',
    'nextToken' => '<string>',
    'workgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tableRestoreStatuses' => [
        [
            'message' => '<string>',
            'namespaceName' => '<string>',
            'newTableName' => '<string>',
            'progressInMegaBytes' => <integer>,
            'recoveryPointId' => '<string>',
            'requestTime' => <DateTime>,
            'snapshotName' => '<string>',
            'sourceDatabaseName' => '<string>',
            'sourceSchemaName' => '<string>',
            'sourceTableName' => '<string>',
            'status' => '<string>',
            'tableRestoreRequestId' => '<string>',
            'targetDatabaseName' => '<string>',
            'targetSchemaName' => '<string>',
            'totalDataInMegaBytes' => <integer>,
            'workgroupName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidPaginationException:

The provided pagination token is invalid.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags assigned to a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.

ListUsageLimits

$result = $client->listUsageLimits([/* ... */]);
$promise = $client->listUsageLimitsAsync([/* ... */]);

Lists all usage limits within Amazon Redshift Serverless.

Parameter Syntax

$result = $client->listUsageLimits([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArn' => '<string>',
    'usageType' => 'serverless-compute|cross-region-datasharing',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'usageLimits' => [
        [
            'amount' => <integer>,
            'breachAction' => 'log|emit-metric|deactivate',
            'period' => 'daily|weekly|monthly',
            'resourceArn' => '<string>',
            'usageLimitArn' => '<string>',
            'usageLimitId' => '<string>',
            'usageType' => 'serverless-compute|cross-region-datasharing',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

InvalidPaginationException:

The provided pagination token is invalid.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ListWorkgroups

$result = $client->listWorkgroups([/* ... */]);
$promise = $client->listWorkgroupsAsync([/* ... */]);

Returns information about a list of specified workgroups.

Parameter Syntax

$result = $client->listWorkgroups([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'ownerAccount' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'workgroups' => [
        [
            'baseCapacity' => <integer>,
            'configParameters' => [
                [
                    'parameterKey' => '<string>',
                    'parameterValue' => '<string>',
                ],
                // ...
            ],
            'creationDate' => <DateTime>,
            'crossAccountVpcs' => ['<string>', ...],
            'customDomainCertificateArn' => '<string>',
            'customDomainCertificateExpiryTime' => <DateTime>,
            'customDomainName' => '<string>',
            'endpoint' => [
                'address' => '<string>',
                'port' => <integer>,
                'vpcEndpoints' => [
                    [
                        'networkInterfaces' => [
                            [
                                'availabilityZone' => '<string>',
                                'ipv6Address' => '<string>',
                                'networkInterfaceId' => '<string>',
                                'privateIpAddress' => '<string>',
                                'subnetId' => '<string>',
                            ],
                            // ...
                        ],
                        'vpcEndpointId' => '<string>',
                        'vpcId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'enhancedVpcRouting' => true || false,
            'ipAddressType' => '<string>',
            'maxCapacity' => <integer>,
            'namespaceName' => '<string>',
            'patchVersion' => '<string>',
            'port' => <integer>,
            'publiclyAccessible' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
            'subnetIds' => ['<string>', ...],
            'workgroupArn' => '<string>',
            'workgroupId' => '<string>',
            'workgroupName' => '<string>',
            'workgroupVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

Parameter Syntax

$result = $client->putResourcePolicy([
    'policy' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'resourcePolicy' => [
        'policy' => '<string>',
        'resourceArn' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException:

The service limit was exceeded.

RestoreFromRecoveryPoint

$result = $client->restoreFromRecoveryPoint([/* ... */]);
$promise = $client->restoreFromRecoveryPointAsync([/* ... */]);

Restore the data from a recovery point.

Parameter Syntax

$result = $client->restoreFromRecoveryPoint([
    'namespaceName' => '<string>', // REQUIRED
    'recoveryPointId' => '<string>', // REQUIRED
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'namespace' => [
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'creationDate' => <DateTime>,
        'dbName' => '<string>',
        'defaultIamRoleArn' => '<string>',
        'iamRoles' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'logExports' => ['<string>', ...],
        'namespaceArn' => '<string>',
        'namespaceId' => '<string>',
        'namespaceName' => '<string>',
        'status' => 'AVAILABLE|MODIFYING|DELETING',
    ],
    'recoveryPointId' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

RestoreFromSnapshot

$result = $client->restoreFromSnapshot([/* ... */]);
$promise = $client->restoreFromSnapshotAsync([/* ... */]);

Restores a namespace from a snapshot.

Parameter Syntax

$result = $client->restoreFromSnapshot([
    'adminPasswordSecretKmsKeyId' => '<string>',
    'manageAdminPassword' => true || false,
    'namespaceName' => '<string>', // REQUIRED
    'ownerAccount' => '<string>',
    'snapshotArn' => '<string>',
    'snapshotName' => '<string>',
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'namespace' => [
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'creationDate' => <DateTime>,
        'dbName' => '<string>',
        'defaultIamRoleArn' => '<string>',
        'iamRoles' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'logExports' => ['<string>', ...],
        'namespaceArn' => '<string>',
        'namespaceId' => '<string>',
        'namespaceName' => '<string>',
        'status' => 'AVAILABLE|MODIFYING|DELETING',
    ],
    'ownerAccount' => '<string>',
    'snapshotName' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException:

The service limit was exceeded.

RestoreTableFromRecoveryPoint

$result = $client->restoreTableFromRecoveryPoint([/* ... */]);
$promise = $client->restoreTableFromRecoveryPointAsync([/* ... */]);

Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.

Parameter Syntax

$result = $client->restoreTableFromRecoveryPoint([
    'activateCaseSensitiveIdentifier' => true || false,
    'namespaceName' => '<string>', // REQUIRED
    'newTableName' => '<string>', // REQUIRED
    'recoveryPointId' => '<string>', // REQUIRED
    'sourceDatabaseName' => '<string>', // REQUIRED
    'sourceSchemaName' => '<string>',
    'sourceTableName' => '<string>', // REQUIRED
    'targetDatabaseName' => '<string>',
    'targetSchemaName' => '<string>',
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tableRestoreStatus' => [
        'message' => '<string>',
        'namespaceName' => '<string>',
        'newTableName' => '<string>',
        'progressInMegaBytes' => <integer>,
        'recoveryPointId' => '<string>',
        'requestTime' => <DateTime>,
        'snapshotName' => '<string>',
        'sourceDatabaseName' => '<string>',
        'sourceSchemaName' => '<string>',
        'sourceTableName' => '<string>',
        'status' => '<string>',
        'tableRestoreRequestId' => '<string>',
        'targetDatabaseName' => '<string>',
        'targetSchemaName' => '<string>',
        'totalDataInMegaBytes' => <integer>,
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

RestoreTableFromSnapshot

$result = $client->restoreTableFromSnapshot([/* ... */]);
$promise = $client->restoreTableFromSnapshotAsync([/* ... */]);

Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.

Parameter Syntax

$result = $client->restoreTableFromSnapshot([
    'activateCaseSensitiveIdentifier' => true || false,
    'namespaceName' => '<string>', // REQUIRED
    'newTableName' => '<string>', // REQUIRED
    'snapshotName' => '<string>', // REQUIRED
    'sourceDatabaseName' => '<string>', // REQUIRED
    'sourceSchemaName' => '<string>',
    'sourceTableName' => '<string>', // REQUIRED
    'targetDatabaseName' => '<string>',
    'targetSchemaName' => '<string>',
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tableRestoreStatus' => [
        'message' => '<string>',
        'namespaceName' => '<string>',
        'newTableName' => '<string>',
        'progressInMegaBytes' => <integer>,
        'recoveryPointId' => '<string>',
        'requestTime' => <DateTime>,
        'snapshotName' => '<string>',
        'sourceDatabaseName' => '<string>',
        'sourceSchemaName' => '<string>',
        'sourceTableName' => '<string>',
        'status' => '<string>',
        'tableRestoreRequestId' => '<string>',
        'targetDatabaseName' => '<string>',
        'targetSchemaName' => '<string>',
        'totalDataInMegaBytes' => <integer>,
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

TooManyTagsException:

The request exceeded the number of tags allowed for a resource.

ThrottlingException:

The request was denied due to request throttling.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag or set of tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

ThrottlingException:

The request was denied due to request throttling.

UpdateCustomDomainAssociation

$result = $client->updateCustomDomainAssociation([/* ... */]);
$promise = $client->updateCustomDomainAssociationAsync([/* ... */]);

Updates an Amazon Redshift Serverless certificate associated with a custom domain.

Parameter Syntax

$result = $client->updateCustomDomainAssociation([
    'customDomainCertificateArn' => '<string>', // REQUIRED
    'customDomainName' => '<string>', // REQUIRED
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'customDomainCertificateArn' => '<string>',
    'customDomainCertificateExpiryTime' => <DateTime>,
    'customDomainName' => '<string>',
    'workgroupName' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

UpdateEndpointAccess

$result = $client->updateEndpointAccess([/* ... */]);
$promise = $client->updateEndpointAccessAsync([/* ... */]);

Updates an Amazon Redshift Serverless managed endpoint.

Parameter Syntax

$result = $client->updateEndpointAccess([
    'endpointName' => '<string>', // REQUIRED
    'vpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'endpoint' => [
        'address' => '<string>',
        'endpointArn' => '<string>',
        'endpointCreateTime' => <DateTime>,
        'endpointName' => '<string>',
        'endpointStatus' => '<string>',
        'port' => <integer>,
        'subnetIds' => ['<string>', ...],
        'vpcEndpoint' => [
            'networkInterfaces' => [
                [
                    'availabilityZone' => '<string>',
                    'ipv6Address' => '<string>',
                    'networkInterfaceId' => '<string>',
                    'privateIpAddress' => '<string>',
                    'subnetId' => '<string>',
                ],
                // ...
            ],
            'vpcEndpointId' => '<string>',
            'vpcId' => '<string>',
        ],
        'vpcSecurityGroups' => [
            [
                'status' => '<string>',
                'vpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
        'workgroupName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

UpdateNamespace

$result = $client->updateNamespace([/* ... */]);
$promise = $client->updateNamespaceAsync([/* ... */]);

Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.

Parameter Syntax

$result = $client->updateNamespace([
    'adminPasswordSecretKmsKeyId' => '<string>',
    'adminUserPassword' => '<string>',
    'adminUsername' => '<string>',
    'defaultIamRoleArn' => '<string>',
    'iamRoles' => ['<string>', ...],
    'kmsKeyId' => '<string>',
    'logExports' => ['<string>', ...],
    'manageAdminPassword' => true || false,
    'namespaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'namespace' => [
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'creationDate' => <DateTime>,
        'dbName' => '<string>',
        'defaultIamRoleArn' => '<string>',
        'iamRoles' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'logExports' => ['<string>', ...],
        'namespaceArn' => '<string>',
        'namespaceId' => '<string>',
        'namespaceName' => '<string>',
        'status' => 'AVAILABLE|MODIFYING|DELETING',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

UpdateScheduledAction

$result = $client->updateScheduledAction([/* ... */]);
$promise = $client->updateScheduledActionAsync([/* ... */]);

Updates a scheduled action.

Parameter Syntax

$result = $client->updateScheduledAction([
    'enabled' => true || false,
    'endTime' => <integer || string || DateTime>,
    'roleArn' => '<string>',
    'schedule' => [
        'at' => <integer || string || DateTime>,
        'cron' => '<string>',
    ],
    'scheduledActionDescription' => '<string>',
    'scheduledActionName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>,
    'targetAction' => [
        'createSnapshot' => [
            'namespaceName' => '<string>', // REQUIRED
            'retentionPeriod' => <integer>,
            'snapshotNamePrefix' => '<string>', // REQUIRED
            'tags' => [
                [
                    'key' => '<string>', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'scheduledAction' => [
        'endTime' => <DateTime>,
        'namespaceName' => '<string>',
        'nextInvocations' => [<DateTime>, ...],
        'roleArn' => '<string>',
        'schedule' => [
            'at' => <DateTime>,
            'cron' => '<string>',
        ],
        'scheduledActionDescription' => '<string>',
        'scheduledActionName' => '<string>',
        'scheduledActionUuid' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'ACTIVE|DISABLED',
        'targetAction' => [
            'createSnapshot' => [
                'namespaceName' => '<string>',
                'retentionPeriod' => <integer>,
                'snapshotNamePrefix' => '<string>',
                'tags' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

UpdateSnapshot

$result = $client->updateSnapshot([/* ... */]);
$promise = $client->updateSnapshotAsync([/* ... */]);

Updates a snapshot.

Parameter Syntax

$result = $client->updateSnapshot([
    'retentionPeriod' => <integer>,
    'snapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'snapshot' => [
        'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
        'accountsWithRestoreAccess' => ['<string>', ...],
        'actualIncrementalBackupSizeInMegaBytes' => <float>,
        'adminPasswordSecretArn' => '<string>',
        'adminPasswordSecretKmsKeyId' => '<string>',
        'adminUsername' => '<string>',
        'backupProgressInMegaBytes' => <float>,
        'currentBackupRateInMegaBytesPerSecond' => <float>,
        'elapsedTimeInSeconds' => <integer>,
        'estimatedSecondsToCompletion' => <integer>,
        'kmsKeyId' => '<string>',
        'namespaceArn' => '<string>',
        'namespaceName' => '<string>',
        'ownerAccount' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreateTime' => <DateTime>,
        'snapshotName' => '<string>',
        'snapshotRemainingDays' => <integer>,
        'snapshotRetentionPeriod' => <integer>,
        'snapshotRetentionStartTime' => <DateTime>,
        'status' => 'AVAILABLE|CREATING|DELETED|CANCELLED|FAILED|COPYING',
        'totalBackupSizeInMegaBytes' => <float>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

UpdateSnapshotCopyConfiguration

$result = $client->updateSnapshotCopyConfiguration([/* ... */]);
$promise = $client->updateSnapshotCopyConfigurationAsync([/* ... */]);

Updates a snapshot copy configuration.

Parameter Syntax

$result = $client->updateSnapshotCopyConfiguration([
    'snapshotCopyConfigurationId' => '<string>', // REQUIRED
    'snapshotRetentionPeriod' => <integer>,
]);

Parameter Details

Result Syntax

[
    'snapshotCopyConfiguration' => [
        'destinationKmsKeyId' => '<string>',
        'destinationRegion' => '<string>',
        'namespaceName' => '<string>',
        'snapshotCopyConfigurationArn' => '<string>',
        'snapshotCopyConfigurationId' => '<string>',
        'snapshotRetentionPeriod' => <integer>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException:

You do not have sufficient access to perform this action.

UpdateUsageLimit

$result = $client->updateUsageLimit([/* ... */]);
$promise = $client->updateUsageLimitAsync([/* ... */]);

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

Parameter Syntax

$result = $client->updateUsageLimit([
    'amount' => <integer>,
    'breachAction' => 'log|emit-metric|deactivate',
    'usageLimitId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'usageLimit' => [
        'amount' => <integer>,
        'breachAction' => 'log|emit-metric|deactivate',
        'period' => 'daily|weekly|monthly',
        'resourceArn' => '<string>',
        'usageLimitArn' => '<string>',
        'usageLimitId' => '<string>',
        'usageType' => 'serverless-compute|cross-region-datasharing',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

UpdateWorkgroup

$result = $client->updateWorkgroup([/* ... */]);
$promise = $client->updateWorkgroupAsync([/* ... */]);

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.

Parameter Syntax

$result = $client->updateWorkgroup([
    'baseCapacity' => <integer>,
    'configParameters' => [
        [
            'parameterKey' => '<string>',
            'parameterValue' => '<string>',
        ],
        // ...
    ],
    'enhancedVpcRouting' => true || false,
    'ipAddressType' => '<string>',
    'maxCapacity' => <integer>,
    'port' => <integer>,
    'publiclyAccessible' => true || false,
    'securityGroupIds' => ['<string>', ...],
    'subnetIds' => ['<string>', ...],
    'workgroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'workgroup' => [
        'baseCapacity' => <integer>,
        'configParameters' => [
            [
                'parameterKey' => '<string>',
                'parameterValue' => '<string>',
            ],
            // ...
        ],
        'creationDate' => <DateTime>,
        'crossAccountVpcs' => ['<string>', ...],
        'customDomainCertificateArn' => '<string>',
        'customDomainCertificateExpiryTime' => <DateTime>,
        'customDomainName' => '<string>',
        'endpoint' => [
            'address' => '<string>',
            'port' => <integer>,
            'vpcEndpoints' => [
                [
                    'networkInterfaces' => [
                        [
                            'availabilityZone' => '<string>',
                            'ipv6Address' => '<string>',
                            'networkInterfaceId' => '<string>',
                            'privateIpAddress' => '<string>',
                            'subnetId' => '<string>',
                        ],
                        // ...
                    ],
                    'vpcEndpointId' => '<string>',
                    'vpcId' => '<string>',
                ],
                // ...
            ],
        ],
        'enhancedVpcRouting' => true || false,
        'ipAddressType' => '<string>',
        'maxCapacity' => <integer>,
        'namespaceName' => '<string>',
        'patchVersion' => '<string>',
        'port' => <integer>,
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

InsufficientCapacityException:

There is an insufficient capacity to perform the action.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

ValidationException:

The input failed to satisfy the constraints specified by an AWS service.

Ipv6CidrBlockNotFoundException:

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.