SDK for PHP 3.x

Client: Aws\RedshiftServerless\RedshiftServerlessClient
Service ID: redshift-serverless
Version: 2021-04-21

This page describes the parameters and results for the operations of the Redshift Serverless (2021-04-21), and shows how to use the Aws\RedshiftServerless\RedshiftServerlessClient object to call the described operations. This documentation is specific to the 2021-04-21 API version of the service.

Operation Summary

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

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

ConvertRecoveryPointToSnapshot ( array $params = [] )
Converts a recovery point to a snapshot.
CreateCustomDomainAssociation ( array $params = [] )
Creates a custom domain association for Amazon Redshift Serverless.
CreateEndpointAccess ( array $params = [] )
Creates an Amazon Redshift Serverless managed VPC endpoint.
CreateNamespace ( array $params = [] )
Creates a namespace in Amazon Redshift Serverless.
CreateScheduledAction ( array $params = [] )
Creates a scheduled action.
CreateSnapshot ( array $params = [] )
Creates a snapshot of all databases in a namespace.
CreateSnapshotCopyConfiguration ( array $params = [] )
Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
CreateUsageLimit ( array $params = [] )
Creates a usage limit for a specified Amazon Redshift Serverless usage type.
CreateWorkgroup ( array $params = [] )
Creates an workgroup in Amazon Redshift Serverless.
DeleteCustomDomainAssociation ( array $params = [] )
Deletes a custom domain association for Amazon Redshift Serverless.
DeleteEndpointAccess ( array $params = [] )
Deletes an Amazon Redshift Serverless managed VPC endpoint.
DeleteNamespace ( array $params = [] )
Deletes a namespace from Amazon Redshift Serverless.
DeleteResourcePolicy ( array $params = [] )
Deletes the specified resource policy.
DeleteScheduledAction ( array $params = [] )
Deletes a scheduled action.
DeleteSnapshot ( array $params = [] )
Deletes a snapshot from Amazon Redshift Serverless.
DeleteSnapshotCopyConfiguration ( array $params = [] )
Deletes a snapshot copy configuration
DeleteUsageLimit ( array $params = [] )
Deletes a usage limit from Amazon Redshift Serverless.
DeleteWorkgroup ( array $params = [] )
Deletes a workgroup.
GetCredentials ( array $params = [] )
Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
GetCustomDomainAssociation ( array $params = [] )
Gets information about a specific custom domain association.
GetEndpointAccess ( array $params = [] )
Returns information, such as the name, about a VPC endpoint.
GetNamespace ( array $params = [] )
Returns information about a namespace in Amazon Redshift Serverless.
GetRecoveryPoint ( array $params = [] )
Returns information about a recovery point.
GetResourcePolicy ( array $params = [] )
Returns a resource policy.
GetScheduledAction ( array $params = [] )
Returns information about a scheduled action.
GetSnapshot ( array $params = [] )
Returns information about a specific snapshot.
GetTableRestoreStatus ( array $params = [] )
Returns information about a TableRestoreStatus object.
GetUsageLimit ( array $params = [] )
Returns information about a usage limit.
GetWorkgroup ( array $params = [] )
Returns information about a specific workgroup.
ListCustomDomainAssociations ( array $params = [] )
Lists custom domain associations for Amazon Redshift Serverless.
ListEndpointAccess ( array $params = [] )
Returns an array of EndpointAccess objects and relevant information.
ListManagedWorkgroups ( array $params = [] )
Returns information about a list of specified managed workgroups in your account.
ListNamespaces ( array $params = [] )
Returns information about a list of specified namespaces.
ListRecoveryPoints ( array $params = [] )
Returns an array of recovery points.
ListScheduledActions ( array $params = [] )
Returns a list of scheduled actions.
ListSnapshotCopyConfigurations ( array $params = [] )
Returns a list of snapshot copy configurations.
ListSnapshots ( array $params = [] )
Returns a list of snapshots.
ListTableRestoreStatus ( array $params = [] )
Returns information about an array of TableRestoreStatus objects.
ListTagsForResource ( array $params = [] )
Lists the tags assigned to a resource.
ListUsageLimits ( array $params = [] )
Lists all usage limits within Amazon Redshift Serverless.
ListWorkgroups ( array $params = [] )
Returns information about a list of specified workgroups.
PutResourcePolicy ( array $params = [] )
Creates or updates a resource policy.
RestoreFromRecoveryPoint ( array $params = [] )
Restore the data from a recovery point.
RestoreFromSnapshot ( array $params = [] )
Restores a namespace from a snapshot.
RestoreTableFromRecoveryPoint ( array $params = [] )
Restores a table from a recovery point to your Amazon Redshift Serverless instance.
RestoreTableFromSnapshot ( array $params = [] )
Restores a table from a snapshot to your Amazon Redshift Serverless instance.
TagResource ( array $params = [] )
Assigns one or more tags to a resource.
UntagResource ( array $params = [] )
Removes a tag or set of tags from a resource.
UpdateCustomDomainAssociation ( array $params = [] )
Updates an Amazon Redshift Serverless certificate associated with a custom domain.
UpdateEndpointAccess ( array $params = [] )
Updates an Amazon Redshift Serverless managed endpoint.
UpdateNamespace ( array $params = [] )
Updates a namespace with the specified settings.
UpdateScheduledAction ( array $params = [] )
Updates a scheduled action.
UpdateSnapshot ( array $params = [] )
Updates a snapshot.
UpdateSnapshotCopyConfiguration ( array $params = [] )
Updates a snapshot copy configuration.
UpdateUsageLimit ( array $params = [] )
Update a usage limit in Amazon Redshift Serverless.
UpdateWorkgroup ( array $params = [] )
Updates a workgroup with the specified configuration settings.

Paginators

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

ListCustomDomainAssociations
ListEndpointAccess
ListManagedWorkgroups
ListNamespaces
ListRecoveryPoints
ListScheduledActions
ListSnapshotCopyConfigurations
ListSnapshots
ListTableRestoreStatus
ListUsageLimits
ListWorkgroups

Operations

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

Members
recoveryPointId
Required: Yes
Type: string

The unique identifier of the recovery point.

retentionPeriod
Type: int

How long to retain the snapshot.

snapshotName
Required: Yes
Type: string

The name of the snapshot.

tags
Type: Array of Tag structures

An array of Tag objects to associate with the created snapshot.

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

Members
snapshot
Type: Snapshot structure

The snapshot converted from the recovery point.

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

Members
customDomainCertificateArn
Required: Yes
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

customDomainName
Required: Yes
Type: string

The custom domain name to associate with the workgroup.

workgroupName
Required: Yes
Type: string

The name of the workgroup associated with the database.

Result Syntax

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

Result Details

Members
customDomainCertificateArn
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

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

The expiration time for the certificate.

customDomainName
Type: string

The custom domain name to associate with the workgroup.

workgroupName
Type: string

The name of the workgroup associated with the database.

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

Members
endpointName
Required: Yes
Type: string

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

ownerAccount
Type: string

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

subnetIds
Required: Yes
Type: Array of strings

The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

vpcSecurityGroupIds
Type: Array of strings

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

workgroupName
Required: Yes
Type: string

The name of the workgroup to associate with the VPC endpoint.

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

Members
endpoint
Type: EndpointAccess structure

The created VPC endpoint.

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

Members
adminPasswordSecretKmsKeyId
Type: string

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

adminUserPassword
Type: string

The password of the administrator for the first database created in the namespace.

You can't use adminUserPassword if manageAdminPassword is true.

adminUsername
Type: string

The username of the administrator for the first database created in the namespace.

dbName
Type: string

The name of the first database created in the namespace.

defaultIamRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

iamRoles
Type: Array of strings

A list of IAM roles to associate with the namespace.

kmsKeyId
Type: string

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

logExports
Type: Array of strings

The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.

manageAdminPassword
Type: boolean

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

namespaceName
Required: Yes
Type: string

The name of the namespace.

redshiftIdcApplicationArn
Type: string

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

tags
Type: Array of Tag structures

A list of tag instances.

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

Members
namespace
Type: Namespace structure

The created namespace object.

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

Members
enabled
Type: boolean

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

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

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

namespaceName
Required: Yes
Type: string

The name of the namespace for which to create a scheduled action.

roleArn
Required: Yes
Type: string

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

schedule
Required: Yes
Type: Schedule structure

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

  • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

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

scheduledActionDescription
Type: string

The description of the scheduled action.

scheduledActionName
Required: Yes
Type: string

The name of the scheduled action.

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

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

targetAction
Required: Yes
Type: TargetAction structure

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

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

Members
scheduledAction
Type: ScheduledActionResponse structure

The returned ScheduledAction object that describes the properties of a scheduled action.

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

Members
namespaceName
Required: Yes
Type: string

The namespace to create a snapshot for.

retentionPeriod
Type: int

How long to retain the created snapshot.

snapshotName
Required: Yes
Type: string

The name of the snapshot.

tags
Type: Array of Tag structures

An array of Tag objects to associate with the snapshot.

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

Members
snapshot
Type: Snapshot structure

The created snapshot object.

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

Members
destinationKmsKeyId
Type: string

The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.

destinationRegion
Required: Yes
Type: string

The destination Amazon Web Services Region that you want to copy snapshots to.

namespaceName
Required: Yes
Type: string

The name of the namespace to copy snapshots from.

snapshotRetentionPeriod
Type: int

The retention period of the snapshots that you copy to the destination Amazon Web Services Region.

Result Syntax

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

Result Details

Members
snapshotCopyConfiguration
Required: Yes
Type: SnapshotCopyConfiguration structure

The snapshot copy configuration object that is returned.

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

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

The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

breachAction
Type: string

The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

period
Type: string

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

resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

usageType
Required: Yes
Type: string

The type of Amazon Redshift Serverless usage to create a usage limit for.

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

Members
usageLimit
Type: UsageLimit structure

The returned usage limit object.

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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:

  • Creating a public access workgroup

  • Modifying a private workgroup to public

  • Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

Parameter Syntax

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

Parameter Details

Members
baseCapacity
Type: int

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

configParameters
Type: Array of ConfigParameter structures

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

enhancedVpcRouting
Type: boolean

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

ipAddressType
Type: string

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

maxCapacity
Type: int

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

namespaceName
Required: Yes
Type: string

The name of the namespace to associate with the workgroup.

port
Type: int

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

pricePerformanceTarget
Type: PerformanceTarget structure

An object that represents the price performance target settings for the workgroup.

publiclyAccessible
Type: boolean

A value that specifies whether the workgroup can be accessed from a public network.

securityGroupIds
Type: Array of strings

An array of security group IDs to associate with the workgroup.

subnetIds
Type: Array of strings

An array of VPC subnet IDs to associate with the workgroup.

tags
Type: Array of Tag structures

A array of tag instances.

workgroupName
Required: Yes
Type: string

The name of the created workgroup.

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>,
        'pricePerformanceTarget' => [
            'level' => <integer>,
            'status' => 'ENABLED|DISABLED',
        ],
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Members
workgroup
Type: Workgroup structure

The created workgroup object.

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

Members
customDomainName
Required: Yes
Type: string

The custom domain name associated with the workgroup.

workgroupName
Required: Yes
Type: string

The name of the workgroup associated with the database.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
endpointName
Required: Yes
Type: string

The name of the VPC endpoint to delete.

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

Members
endpoint
Type: EndpointAccess structure

The deleted VPC endpoint.

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

Members
finalSnapshotName
Type: string

The name of the snapshot to be created before the namespace is deleted.

finalSnapshotRetentionPeriod
Type: int

How long to retain the final snapshot.

namespaceName
Required: Yes
Type: string

The name of the namespace to delete.

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

Members
namespace
Required: Yes
Type: Namespace structure

The deleted namespace object.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the policy to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
scheduledActionName
Required: Yes
Type: string

The name of the scheduled action to delete.

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

Members
scheduledAction
Type: ScheduledActionResponse structure

The deleted scheduled action object.

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

Members
snapshotName
Required: Yes
Type: string

The name of the snapshot to be deleted.

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

Members
snapshot
Type: Snapshot structure

The deleted snapshot object.

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

Members
snapshotCopyConfigurationId
Required: Yes
Type: string

The ID of the snapshot copy configuration to delete.

Result Syntax

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

Result Details

Members
snapshotCopyConfiguration
Required: Yes
Type: SnapshotCopyConfiguration structure

The deleted snapshot copy configuration object.

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

Members
usageLimitId
Required: Yes
Type: string

The unique identifier of the usage limit to delete.

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

Members
usageLimit
Type: UsageLimit structure

The deleted usage limit object.

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

Members
workgroupName
Required: Yes
Type: string

The name of the workgroup to be deleted.

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>,
        'pricePerformanceTarget' => [
            'level' => <integer>,
            'status' => 'ENABLED|DISABLED',
        ],
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Members
workgroup
Required: Yes
Type: Workgroup structure

The deleted workgroup object.

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

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.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Parameter Syntax

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

Parameter Details

Members
customDomainName
Type: string

The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.

dbName
Type: string

The name of the database to get temporary authorization to log on to.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens.

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

  • The first character must be a letter.

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

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

durationSeconds
Type: int

The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

workgroupName
Type: string

The name of the workgroup associated with the database.

Result Syntax

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

Result Details

Members
dbPassword
Type: string

A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

dbUser
Type: string

A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC.

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

The date and time the password in DbPassword expires.

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

The date and time of when the DbUser and DbPassword authorization refreshes.

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

Members
customDomainName
Required: Yes
Type: string

The custom domain name associated with the workgroup.

workgroupName
Required: Yes
Type: string

The name of the workgroup associated with the database.

Result Syntax

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

Result Details

Members
customDomainCertificateArn
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

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

The expiration time for the certificate.

customDomainName
Type: string

The custom domain name associated with the workgroup.

workgroupName
Type: string

The name of the workgroup associated with the database.

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

Members
endpointName
Required: Yes
Type: string

The name of the VPC endpoint to return information for.

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

Members
endpoint
Type: EndpointAccess structure

The returned VPC endpoint.

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

Members
namespaceName
Required: Yes
Type: string

The name of the namespace to retrieve information for.

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

Members
namespace
Required: Yes
Type: Namespace structure

The returned namespace object.

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

Members
recoveryPointId
Required: Yes
Type: string

The unique identifier of the recovery point to return information for.

Result Syntax

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

Result Details

Members
recoveryPoint
Type: RecoveryPoint structure

The returned recovery point object.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to return.

Result Syntax

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

Result Details

Members
resourcePolicy
Type: ResourcePolicy structure

The returned resource policy.

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

Members
scheduledActionName
Required: Yes
Type: string

The name of the scheduled action.

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

Members
scheduledAction
Type: ScheduledActionResponse structure

The returned scheduled action object.

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

Members
ownerAccount
Type: string

The owner Amazon Web Services account of a snapshot shared with another user.

snapshotArn
Type: string

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

snapshotName
Type: string

The name of the snapshot to return.

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

Members
snapshot
Type: Snapshot structure

The returned snapshot object.

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

Members
tableRestoreRequestId
Required: Yes
Type: string

The ID of the RestoreTableFromSnapshot request to return status for.

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

Members
tableRestoreStatus
Type: TableRestoreStatus structure

The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.

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

Members
usageLimitId
Required: Yes
Type: string

The unique identifier of the usage limit to return information for.

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

Members
usageLimit
Type: UsageLimit structure

The returned usage limit object.

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

Members
workgroupName
Required: Yes
Type: string

The name of the workgroup to return information for.

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>,
        'pricePerformanceTarget' => [
            'level' => <integer>,
            'status' => 'ENABLED|DISABLED',
        ],
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Members
workgroup
Required: Yes
Type: Workgroup structure

The returned workgroup object.

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

Members
customDomainCertificateArn
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

customDomainName
Type: string

The custom domain name associated with the workgroup.

maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken
Type: string

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Result Syntax

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

Result Details

Members
associations
Type: Array of Association structures

A list of Association objects.

nextToken
Type: string

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken
Type: string

If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.

ownerAccount
Type: string

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

vpcId
Type: string

The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

workgroupName
Type: string

The name of the workgroup associated with the VPC endpoint to return.

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

Members
endpoints
Required: Yes
Type: Array of EndpointAccess structures

The returned VPC endpoints.

nextToken
Type: string

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

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.

ListManagedWorkgroups

$result = $client->listManagedWorkgroups([/* ... */]);
$promise = $client->listManagedWorkgroupsAsync([/* ... */]);

Returns information about a list of specified managed workgroups in your account.

Parameter Syntax

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

Parameter Details

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken
Type: string

If your initial ListManagedWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListManagedWorkgroups operations, which returns results in the next page.

sourceArn
Type: string

The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.

Result Syntax

[
    'managedWorkgroups' => [
        [
            'creationDate' => <DateTime>,
            'managedWorkgroupId' => '<string>',
            'managedWorkgroupName' => '<string>',
            'sourceArn' => '<string>',
            'status' => 'CREATING|DELETING|MODIFYING|AVAILABLE|NOT_AVAILABLE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
managedWorkgroups
Type: Array of ManagedWorkgroupListItem structures

The returned array of managed workgroups.

nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

Errors

InternalServerException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken
Type: string

If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

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

Members
namespaces
Required: Yes
Type: Array of Namespace structures

The list of returned namespaces.

nextToken
Type: string

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

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

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

The time when creation of the recovery point finished.

maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

namespaceArn
Type: string

The Amazon Resource Name (ARN) of the namespace from which to list recovery points.

namespaceName
Type: string

The name of the namespace to list recovery points for.

nextToken
Type: string

If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.

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

The time when the recovery point's creation was initiated.

Result Syntax

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

Result Details

Members
nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

recoveryPoints
Type: Array of RecoveryPoint structures

The returned recovery point objects.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.

namespaceName
Type: string

The name of namespace associated with the scheduled action to retrieve.

nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Result Syntax

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

Result Details

Members
nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

scheduledActions
Type: Array of ScheduledActionAssociation structures

All of the returned scheduled action association objects.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

namespaceName
Type: string

The namespace from which to list all snapshot copy configurations.

nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Result Syntax

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

Result Details

Members
nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

snapshotCopyConfigurations
Required: Yes
Type: Array of SnapshotCopyConfiguration structures

All of the returned snapshot copy configurations.

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

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

The timestamp showing when the snapshot creation finished.

maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

namespaceArn
Type: string

The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

namespaceName
Type: string

The namespace from which to list all snapshots.

nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ownerAccount
Type: string

The owner Amazon Web Services account of the snapshot.

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

The time when the creation of the snapshot was initiated.

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

Members
nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

snapshots
Type: Array of Snapshot structures

All of the returned snapshot objects.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

namespaceName
Type: string

The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .

nextToken
Type: string

If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.

workgroupName
Type: string

The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

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

Members
nextToken
Type: string

If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.

tableRestoreStatuses
Type: Array of TableRestoreStatus structures

The array of returned TableRestoreStatus objects.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to list tags for.

Result Syntax

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

Result Details

Members
tags
Type: Array of Tag structures

A map of the key-value pairs assigned to the resource.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

nextToken
Type: string

If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

resourceArn
Type: string

The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

usageType
Type: string

The Amazon Redshift Serverless feature whose limits you want to see.

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

Members
nextToken
Type: string

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

usageLimits
Type: Array of UsageLimit structures

An array of returned usage limit objects.

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

Members
maxResults
Type: int

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken
Type: string

If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

ownerAccount
Type: string

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

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>,
            'pricePerformanceTarget' => [
                'level' => <integer>,
                'status' => 'ENABLED|DISABLED',
            ],
            'publiclyAccessible' => true || false,
            'securityGroupIds' => ['<string>', ...],
            'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
            'subnetIds' => ['<string>', ...],
            'workgroupArn' => '<string>',
            'workgroupId' => '<string>',
            'workgroupName' => '<string>',
            'workgroupVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

workgroups
Required: Yes
Type: Array of Workgroup structures

The returned array of workgroups.

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

Members
policy
Required: Yes
Type: string

The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.

"{\"Version\": \"2012-10-17\", \"Statement\" : [{ \"Sid\": \"AllowUserRestoreFromSnapshot\", \"Principal\":{\"AWS\": [\"739247239426\"]}, \"Action\": [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": \"Allow\" }]}"

resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the account to create or update a resource policy for.

Result Syntax

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

Result Details

Members
resourcePolicy
Type: ResourcePolicy structure

The policy that was created or updated.

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

Members
namespaceName
Required: Yes
Type: string

The name of the namespace to restore data into.

recoveryPointId
Required: Yes
Type: string

The unique identifier of the recovery point to restore from.

workgroupName
Required: Yes
Type: string

The name of the workgroup used to restore data.

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

Members
namespace
Type: Namespace structure

The namespace that data was restored into.

recoveryPointId
Type: string

The unique identifier of the recovery point used for the restore.

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

Members
adminPasswordSecretKmsKeyId
Type: string

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

manageAdminPassword
Type: boolean

If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

namespaceName
Required: Yes
Type: string

The name of the namespace to restore the snapshot to.

ownerAccount
Type: string

The Amazon Web Services account that owns the snapshot.

snapshotArn
Type: string

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

snapshotName
Type: string

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

workgroupName
Required: Yes
Type: string

The name of the workgroup used to restore the snapshot.

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

Members
namespace
Type: Namespace structure

A collection of database objects and users.

ownerAccount
Type: string

The owner Amazon Web Services; account of the snapshot that was restored.

snapshotName
Type: string

The name of the snapshot used to restore the namespace.

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

Members
activateCaseSensitiveIdentifier
Type: boolean

Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.

namespaceName
Required: Yes
Type: string

Namespace of the recovery point to restore from.

newTableName
Required: Yes
Type: string

The name of the table to create from the restore operation.

recoveryPointId
Required: Yes
Type: string

The ID of the recovery point to restore the table from.

sourceDatabaseName
Required: Yes
Type: string

The name of the source database that contains the table being restored.

sourceSchemaName
Type: string

The name of the source schema that contains the table being restored.

sourceTableName
Required: Yes
Type: string

The name of the source table being restored.

targetDatabaseName
Type: string

The name of the database to restore the table to.

targetSchemaName
Type: string

The name of the schema to restore the table to.

workgroupName
Required: Yes
Type: string

The workgroup to restore the table to.

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

Members
tableRestoreStatus
Type: TableRestoreStatus structure

Contains information about a table restore request.

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

Members
activateCaseSensitiveIdentifier
Type: boolean

Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.

namespaceName
Required: Yes
Type: string

The namespace of the snapshot to restore from.

newTableName
Required: Yes
Type: string

The name of the table to create from the restore operation.

snapshotName
Required: Yes
Type: string

The name of the snapshot to restore the table from.

sourceDatabaseName
Required: Yes
Type: string

The name of the source database that contains the table being restored.

sourceSchemaName
Type: string

The name of the source schema that contains the table being restored.

sourceTableName
Required: Yes
Type: string

The name of the source table being restored.

targetDatabaseName
Type: string

The name of the database to restore the table to.

targetSchemaName
Type: string

The name of the schema to restore the table to.

workgroupName
Required: Yes
Type: string

The workgroup to restore the table to.

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

Members
tableRestoreStatus
Type: TableRestoreStatus structure

The TableRestoreStatus object that contains the status of the restore operation.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to tag.

tags
Required: Yes
Type: Array of Tag structures

The map of the key-value pairs used to tag the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to remove tags from.

tagKeys
Required: Yes
Type: Array of strings

The tag or set of tags to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
customDomainCertificateArn
Required: Yes
Type: string

The custom domain name’s certificate Amazon resource name (ARN). This is optional.

customDomainName
Required: Yes
Type: string

The custom domain name associated with the workgroup.

workgroupName
Required: Yes
Type: string

The name of the workgroup associated with the database.

Result Syntax

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

Result Details

Members
customDomainCertificateArn
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

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

The expiration time for the certificate.

customDomainName
Type: string

The custom domain name associated with the workgroup.

workgroupName
Type: string

The name of the workgroup associated with the database.

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

Members
endpointName
Required: Yes
Type: string

The name of the VPC endpoint to update.

vpcSecurityGroupIds
Type: Array of strings

The list of VPC security groups associated with the endpoint after the endpoint is modified.

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

Members
endpoint
Type: EndpointAccess structure

The updated VPC endpoint.

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

Members
adminPasswordSecretKmsKeyId
Type: string

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

adminUserPassword
Type: string

The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.

You can't use adminUserPassword if manageAdminPassword is true.

adminUsername
Type: string

The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

defaultIamRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.

iamRoles
Type: Array of strings

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

kmsKeyId
Type: string

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

logExports
Type: Array of strings

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

manageAdminPassword
Type: boolean

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

namespaceName
Required: Yes
Type: string

The name of the namespace to update. You can't update the name of a namespace once it is created.

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

Members
namespace
Required: Yes
Type: Namespace structure

A list of tag instances.

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

Members
enabled
Type: boolean

Specifies whether to enable the scheduled action.

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

The end time in UTC of the scheduled action to update.

roleArn
Type: string

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

schedule
Type: Schedule structure

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

  • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

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

scheduledActionDescription
Type: string

The descripion of the scheduled action to update to.

scheduledActionName
Required: Yes
Type: string

The name of the scheduled action to update to.

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

The start time in UTC of the scheduled action to update to.

targetAction
Type: TargetAction structure

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

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

Members
scheduledAction
Type: ScheduledActionResponse structure

The ScheduledAction object that was updated.

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

Members
retentionPeriod
Type: int

The new retention period of the snapshot.

snapshotName
Required: Yes
Type: string

The name of the snapshot.

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

Members
snapshot
Type: Snapshot structure

The updated snapshot object.

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

Members
snapshotCopyConfigurationId
Required: Yes
Type: string

The ID of the snapshot copy configuration to update.

snapshotRetentionPeriod
Type: int

The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.

Result Syntax

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

Result Details

Members
snapshotCopyConfiguration
Required: Yes
Type: SnapshotCopyConfiguration structure

The updated snapshot copy configuration object.

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

Members
amount
Type: long (int|float)

The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

breachAction
Type: string

The new action that Amazon Redshift Serverless takes when the limit is reached.

usageLimitId
Required: Yes
Type: string

The identifier of the usage limit to update.

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

Members
usageLimit
Type: UsageLimit structure

The updated usage limit object.

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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:

  • Creating a public access workgroup

  • Modifying a private workgroup to public

  • Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

Parameter Syntax

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

Parameter Details

Members
baseCapacity
Type: int

The new base data warehouse capacity in Redshift Processing Units (RPUs).

configParameters
Type: Array of ConfigParameter structures

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

enhancedVpcRouting
Type: boolean

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

ipAddressType
Type: string

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

maxCapacity
Type: int

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

port
Type: int

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

pricePerformanceTarget
Type: PerformanceTarget structure

An object that represents the price performance target settings for the workgroup.

publiclyAccessible
Type: boolean

A value that specifies whether the workgroup can be accessible from a public network.

securityGroupIds
Type: Array of strings

An array of security group IDs to associate with the workgroup.

subnetIds
Type: Array of strings

An array of VPC subnet IDs to associate with the workgroup.

workgroupName
Required: Yes
Type: string

The name of the workgroup to update. You can't update the name of a workgroup once it is created.

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>,
        'pricePerformanceTarget' => [
            'level' => <integer>,
            'status' => 'ENABLED|DISABLED',
        ],
        'publiclyAccessible' => true || false,
        'securityGroupIds' => ['<string>', ...],
        'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
        'subnetIds' => ['<string>', ...],
        'workgroupArn' => '<string>',
        'workgroupId' => '<string>',
        'workgroupName' => '<string>',
        'workgroupVersion' => '<string>',
    ],
]

Result Details

Members
workgroup
Required: Yes
Type: Workgroup structure

The updated workgroup object.

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.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
code
Type: string
message
Type: string

Association

Description

An object that represents the custom domain name association.

Members
customDomainCertificateArn
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

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

The expiration time for the certificate.

customDomainName
Type: string

The custom domain name associated with the workgroup.

workgroupName
Type: string

The name of the workgroup associated with the database.

ConfigParameter

Description

An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

Members
parameterKey
Type: string

The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

parameterValue
Type: string

The value of the parameter to set.

ConflictException

Description

The submitted action has conflicts.

Members
message
Required: Yes
Type: string

CreateSnapshotScheduleActionParameters

Description

The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

Members
namespaceName
Required: Yes
Type: string

The name of the namespace for which you want to configure a scheduled action to create a snapshot.

retentionPeriod
Type: int

The retention period of the snapshot created by the scheduled action.

snapshotNamePrefix
Required: Yes
Type: string

A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

tags
Type: Array of Tag structures

An array of Tag objects to associate with the snapshot.

Endpoint

Description

The VPC endpoint object.

Members
address
Type: string

The DNS address of the VPC endpoint.

port
Type: int

The port that Amazon Redshift Serverless listens on.

vpcEndpoints
Type: Array of VpcEndpoint structures

An array of VpcEndpoint objects.

EndpointAccess

Description

Information about an Amazon Redshift Serverless VPC endpoint.

Members
address
Type: string

The DNS address of the endpoint.

endpointArn
Type: string

The Amazon Resource Name (ARN) of the VPC endpoint.

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

The time that the endpoint was created.

endpointName
Type: string

The name of the VPC endpoint.

endpointStatus
Type: string

The status of the VPC endpoint.

port
Type: int

The port number on which Amazon Redshift Serverless accepts incoming connections.

subnetIds
Type: Array of strings

The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

vpcEndpoint
Type: VpcEndpoint structure

The connection endpoint for connecting to Amazon Redshift Serverless.

vpcSecurityGroups
Type: Array of VpcSecurityGroupMembership structures

The security groups associated with the endpoint.

workgroupName
Type: string

The name of the workgroup associated with the endpoint.

InsufficientCapacityException

Description

There is an insufficient capacity to perform the action.

Members
message
Required: Yes
Type: string

InternalServerException

Description

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

Members
message
Required: Yes
Type: string

InvalidPaginationException

Description

The provided pagination token is invalid.

Members
message
Required: Yes
Type: string

Ipv6CidrBlockNotFoundException

Description

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.

Members
message
Required: Yes
Type: string

ManagedWorkgroupListItem

Description

A collection of Amazon Redshift compute resources managed by AWS Glue.

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

The creation date of the managed workgroup.

managedWorkgroupId
Type: string

The unique identifier of the managed workgroup.

managedWorkgroupName
Type: string

The name of the managed workgroup.

sourceArn
Type: string

The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.

status
Type: string

The status of the managed workgroup.

Namespace

Description

A collection of database objects and users.

Members
adminPasswordSecretArn
Type: string

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

adminPasswordSecretKmsKeyId
Type: string

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

adminUsername
Type: string

The username of the administrator for the first database created in the namespace.

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

The date of when the namespace was created.

dbName
Type: string

The name of the first database created in the namespace.

defaultIamRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

iamRoles
Type: Array of strings

A list of IAM roles to associate with the namespace.

kmsKeyId
Type: string

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

logExports
Type: Array of strings

The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

namespaceArn
Type: string

The Amazon Resource Name (ARN) associated with a namespace.

namespaceId
Type: string

The unique identifier of a namespace.

namespaceName
Type: string

The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

status
Type: string

The status of the namespace.

NetworkInterface

Description

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

Members
availabilityZone
Type: string

The availability Zone.

ipv6Address
Type: string

The IPv6 address of the network interface within the subnet.

networkInterfaceId
Type: string

The unique identifier of the network interface.

privateIpAddress
Type: string

The IPv4 address of the network interface within the subnet.

subnetId
Type: string

The unique identifier of the subnet.

PerformanceTarget

Description

An object that represents the price performance target settings for the workgroup.

Members
level
Type: int

The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.

status
Type: string

Whether the price performance target is enabled for the workgroup.

RecoveryPoint

Description

The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.

Members
namespaceArn
Type: string

The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.

namespaceName
Type: string

The name of the namespace the recovery point is associated with.

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

The time the recovery point is created.

recoveryPointId
Type: string

The unique identifier of the recovery point.

totalSizeInMegaBytes
Type: double

The total size of the data in the recovery point in megabytes.

workgroupName
Type: string

The name of the workgroup the recovery point is associated with.

ResourceNotFoundException

Description

The resource could not be found.

Members
message
Required: Yes
Type: string
resourceName
Type: string

The name of the resource that could not be found.

ResourcePolicy

Description

The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

Members
policy
Type: string

The resource policy.

resourceArn
Type: string

The Amazon Resource Name (ARN) of the policy.

Schedule

Description

The schedule of when Amazon Redshift Serverless should run the scheduled action.

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

The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

cron
Type: string

The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

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

ScheduledActionAssociation

Description

Contains names of objects associated with a scheduled action.

Members
namespaceName
Type: string

Name of associated Amazon Redshift Serverless namespace.

scheduledActionName
Type: string

Name of associated scheduled action.

ScheduledActionResponse

Description

The returned scheduled action object.

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

The end time of

namespaceName
Type: string

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

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

An array of timestamps of when the next scheduled actions will trigger.

roleArn
Type: string

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

schedule
Type: Schedule structure

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

  • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

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

scheduledActionDescription
Type: string

The description of the scheduled action.

scheduledActionName
Type: string

The name of the scheduled action.

scheduledActionUuid
Type: string

The uuid of the scheduled action.

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

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

state
Type: string

The state of the scheduled action.

targetAction
Type: TargetAction structure

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

ServiceQuotaExceededException

Description

The service limit was exceeded.

Members
message
Required: Yes
Type: string

Snapshot

Description

A snapshot object that contains databases.

Members
accountsWithProvisionedRestoreAccess
Type: Array of strings

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

accountsWithRestoreAccess
Type: Array of strings

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

actualIncrementalBackupSizeInMegaBytes
Type: double

The size of the incremental backup in megabytes.

adminPasswordSecretArn
Type: string

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

adminPasswordSecretKmsKeyId
Type: string

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

adminUsername
Type: string

The username of the database within a snapshot.

backupProgressInMegaBytes
Type: double

The size in megabytes of the data that has been backed up to a snapshot.

currentBackupRateInMegaBytesPerSecond
Type: double

The rate at which data is backed up into a snapshot in megabytes per second.

elapsedTimeInSeconds
Type: long (int|float)

The amount of time it took to back up data into a snapshot.

estimatedSecondsToCompletion
Type: long (int|float)

The estimated amount of seconds until the snapshot completes backup.

kmsKeyId
Type: string

The unique identifier of the KMS key used to encrypt the snapshot.

namespaceArn
Type: string

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

namespaceName
Type: string

The name of the namepsace.

ownerAccount
Type: string

The owner Amazon Web Services; account of the snapshot.

snapshotArn
Type: string

The Amazon Resource Name (ARN) of the snapshot.

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

The timestamp of when the snapshot was created.

snapshotName
Type: string

The name of the snapshot.

snapshotRemainingDays
Type: int

The amount of days until the snapshot is deleted.

snapshotRetentionPeriod
Type: int

The period of time, in days, of how long the snapshot is retained.

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

The timestamp of when data within the snapshot started getting retained.

status
Type: string

The status of the snapshot.

totalBackupSizeInMegaBytes
Type: double

The total size, in megabytes, of how big the snapshot is.

SnapshotCopyConfiguration

Description

The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.

Members
destinationKmsKeyId
Type: string

The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.

destinationRegion
Type: string

The destination Amazon Web Services Region to copy snapshots to.

namespaceName
Type: string

The name of the namespace to copy snapshots from in the source Amazon Web Services Region.

snapshotCopyConfigurationArn
Type: string

The ARN of the snapshot copy configuration object.

snapshotCopyConfigurationId
Type: string

The ID of the snapshot copy configuration object.

snapshotRetentionPeriod
Type: int

The retention period of snapshots that are copied to the destination Amazon Web Services Region.

TableRestoreStatus

Description

Contains information about a table restore request.

Members
message
Type: string

A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.

namespaceName
Type: string

The namespace of the table being restored from.

newTableName
Type: string

The name of the table to create from the restore operation.

progressInMegaBytes
Type: long (int|float)

The amount of data restored to the new table so far, in megabytes (MB).

recoveryPointId
Type: string

The ID of the recovery point being restored from.

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

The time that the table restore request was made, in Universal Coordinated Time (UTC).

snapshotName
Type: string

The name of the snapshot being restored from.

sourceDatabaseName
Type: string

The name of the source database being restored from.

sourceSchemaName
Type: string

The name of the source schema being restored from.

sourceTableName
Type: string

The name of the source table being restored from.

status
Type: string

A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.

tableRestoreRequestId
Type: string

The ID of the RestoreTableFromSnapshot request.

targetDatabaseName
Type: string

The name of the database to restore to.

targetSchemaName
Type: string

The name of the schema to restore to.

totalDataInMegaBytes
Type: long (int|float)

The total amount of data to restore to the new table, in megabytes (MB).

workgroupName
Type: string

The name of the workgroup being restored from.

Tag

Description

A map of key-value pairs.

Members
key
Required: Yes
Type: string

The key to use in the tag.

value
Required: Yes
Type: string

The value of the tag.

TargetAction

Description

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

Members
createSnapshot

The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

ThrottlingException

Description

The request was denied due to request throttling.

Members
code
Type: string
message
Type: string

TooManyTagsException

Description

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

Members
message
Type: string
resourceName
Type: string

The name of the resource that exceeded the number of tags allowed for a resource.

UsageLimit

Description

The usage limit object.

Members
amount
Type: long (int|float)

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

breachAction
Type: string

The action that Amazon Redshift Serverless takes when the limit is reached.

period
Type: string

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

resourceArn
Type: string

The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

usageLimitArn
Type: string

The Amazon Resource Name (ARN) of the resource associated with the usage limit.

usageLimitId
Type: string

The identifier of the usage limit.

usageType
Type: string

The Amazon Redshift Serverless feature to limit.

ValidationException

Description

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

Members
message
Required: Yes
Type: string

VpcEndpoint

Description

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

Members
networkInterfaces
Type: Array of NetworkInterface structures

One or more network interfaces of the endpoint. Also known as an interface endpoint.

vpcEndpointId
Type: string

The connection endpoint ID for connecting to Amazon Redshift Serverless.

vpcId
Type: string

The VPC identifier that the endpoint is associated with.

VpcSecurityGroupMembership

Description

Describes the members of a VPC security group.

Members
status
Type: string

The status of the VPC security group.

vpcSecurityGroupId
Type: string

The unique identifier of the VPC security group.

Workgroup

Description

The collection of computing resources from which an endpoint is created.

Members
baseCapacity
Type: int

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

configParameters
Type: Array of ConfigParameter structures

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

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

The creation date of the workgroup.

crossAccountVpcs
Type: Array of strings

A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

customDomainCertificateArn
Type: string

The custom domain name’s certificate Amazon resource name (ARN).

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

The expiration time for the certificate.

customDomainName
Type: string

The custom domain name associated with the workgroup.

endpoint
Type: Endpoint structure

The endpoint that is created from the workgroup.

enhancedVpcRouting
Type: boolean

The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

ipAddressType
Type: string

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

maxCapacity
Type: int

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

namespaceName
Type: string

The namespace the workgroup is associated with.

patchVersion
Type: string

The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

port
Type: int

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

pricePerformanceTarget
Type: PerformanceTarget structure

An object that represents the price performance target settings for the workgroup.

publiclyAccessible
Type: boolean

A value that specifies whether the workgroup can be accessible from a public network.

securityGroupIds
Type: Array of strings

An array of security group IDs to associate with the workgroup.

status
Type: string

The status of the workgroup.

subnetIds
Type: Array of strings

An array of subnet IDs the workgroup is associated with.

workgroupArn
Type: string

The Amazon Resource Name (ARN) that links to the workgroup.

workgroupId
Type: string

The unique identifier of the workgroup.

workgroupName
Type: string

The name of the workgroup.

workgroupVersion
Type: string

The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.