Redshift Serverless 2021-04-21
- 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.
- CreateEndpointAccess ( array $params = [] )
Creates an Amazon Redshift Serverless managed VPC endpoint.
- CreateNamespace ( array $params = [] )
Creates a namespace in Amazon Redshift Serverless.
- CreateSnapshot ( array $params = [] )
Creates a snapshot of all databases in a namespace.
- 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.
- 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.
- DeleteSnapshot ( array $params = [] )
Deletes a snapshot from Amazon Redshift Serverless.
- 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.
- 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.
- 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.
- ListEndpointAccess ( array $params = [] )
Returns an array of EndpointAccess objects and relevant information.
- ListNamespaces ( array $params = [] )
Returns information about a list of specified namespaces.
- ListRecoveryPoints ( array $params = [] )
Returns an array of recovery points.
- 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.
- 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.
- UpdateEndpointAccess ( array $params = [] )
Updates an Amazon Redshift Serverless managed endpoint.
- UpdateNamespace ( array $params = [] )
Updates a namespace with the specified settings.
- UpdateSnapshot ( array $params = [] )
Updates a snapshot.
- 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:
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>,
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
The request exceeded the number of tags allowed for a resource.
-
ServiceQuotaExceededException:
The service limit was exceeded.
CreateEndpointAccess
$result = $client->createEndpointAccess([/* ... */]); $promise = $client->createEndpointAccessAsync([/* ... */]);
Creates an Amazon Redshift Serverless managed VPC endpoint.
Parameter Syntax
$result = $client->createEndpointAccess([
'endpointName' => '<string>', // REQUIRED
'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.
- 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>',
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
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([
'adminUserPassword' => '<string>',
'adminUsername' => '<string>',
'dbName' => '<string>',
'defaultIamRoleArn' => '<string>',
'iamRoles' => ['<string>', ...],
'kmsKeyId' => '<string>',
'logExports' => ['<string>', ...],
'namespaceName' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- adminUserPassword
-
- Type: string
The password of the administrator for the first database created in the namespace.
- 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, anduseractivitylog. - namespaceName
-
- Required: Yes
- Type: string
The name of the namespace.
- tags
-
- Type: Array of Tag structures
A list of tag instances.
Result Syntax
[
'namespace' => [
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
The request exceeded the number of tags allowed for a resource.
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>,
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
The request exceeded the number of tags allowed for a resource.
-
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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
ServiceQuotaExceededException:
The service limit was exceeded.
CreateWorkgroup
$result = $client->createWorkgroup([/* ... */]); $promise = $client->createWorkgroupAsync([/* ... */]);
Creates an workgroup in Amazon Redshift Serverless.
Parameter Syntax
$result = $client->createWorkgroup([
'baseCapacity' => <integer>,
'configParameters' => [
[
'parameterKey' => '<string>',
'parameterValue' => '<string>',
],
// ...
],
'enhancedVpcRouting' => true || false,
'namespaceName' => '<string>', // REQUIRED
'port' => <integer>,
'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_sensitivity_identifier,enable_user_activity_logging,query_group,search_path, 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.
- 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.
- 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>,
'endpoint' => [
'address' => '<string>',
'port' => <integer>,
'vpcEndpoints' => [
[
'networkInterfaces' => [
[
'availabilityZone' => '<string>',
'networkInterfaceId' => '<string>',
'privateIpAddress' => '<string>',
'subnetId' => '<string>',
],
// ...
],
'vpcEndpointId' => '<string>',
'vpcId' => '<string>',
],
// ...
],
],
'enhancedVpcRouting' => true || false,
'namespaceName' => '<string>',
'port' => <integer>,
'publiclyAccessible' => true || false,
'securityGroupIds' => ['<string>', ...],
'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
'subnetIds' => ['<string>', ...],
'workgroupArn' => '<string>',
'workgroupId' => '<string>',
'workgroupName' => '<string>',
],
]
Result Details
Members
- workgroup
-
- Type: Workgroup structure
The created workgroup object.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
InsufficientCapacityException:
There is an insufficient capacity to perform the action.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
The request exceeded the number of tags allowed for a resource.
DeleteEndpointAccess
$result = $client->deleteEndpointAccess([/* ... */]); $promise = $client->deleteEndpointAccessAsync([/* ... */]);
Deletes an Amazon Redshift Serverless managed VPC endpoint.
Parameter Syntax
$result = $client->deleteEndpointAccess([
'endpointName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'endpoint' => [
'address' => '<string>',
'endpointArn' => '<string>',
'endpointCreateTime' => <DateTime>,
'endpointName' => '<string>',
'endpointStatus' => '<string>',
'port' => <integer>,
'subnetIds' => ['<string>', ...],
'vpcEndpoint' => [
'networkInterfaces' => [
[
'availabilityZone' => '<string>',
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[
'namespace' => [
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The input failed to satisfy the constraints specified by an AWS service.
DeleteSnapshot
$result = $client->deleteSnapshot([/* ... */]); $promise = $client->deleteSnapshotAsync([/* ... */]);
Deletes a snapshot from Amazon Redshift Serverless.
Parameter Syntax
$result = $client->deleteSnapshot([
'snapshotName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'snapshot' => [
'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
'accountsWithRestoreAccess' => ['<string>', ...],
'actualIncrementalBackupSizeInMegaBytes' => <float>,
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
DeleteUsageLimit
$result = $client->deleteUsageLimit([/* ... */]); $promise = $client->deleteUsageLimitAsync([/* ... */]);
Deletes a usage limit from Amazon Redshift Serverless.
Parameter Syntax
$result = $client->deleteUsageLimit([
'usageLimitId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'usageLimit' => [
'amount' => <integer>,
'breachAction' => 'log|emit-metric|deactivate',
'period' => 'daily|weekly|monthly',
'resourceArn' => '<string>',
'usageLimitArn' => '<string>',
'usageLimitId' => '<string>',
'usageType' => 'serverless-compute|cross-region-datasharing',
],
]
Result Details
Members
- usageLimit
-
- Type: UsageLimit structure
The deleted usage limit object.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
DeleteWorkgroup
$result = $client->deleteWorkgroup([/* ... */]); $promise = $client->deleteWorkgroupAsync([/* ... */]);
Deletes a workgroup.
Parameter Syntax
$result = $client->deleteWorkgroup([
'workgroupName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'workgroup' => [
'baseCapacity' => <integer>,
'configParameters' => [
[
'parameterKey' => '<string>',
'parameterValue' => '<string>',
],
// ...
],
'creationDate' => <DateTime>,
'endpoint' => [
'address' => '<string>',
'port' => <integer>,
'vpcEndpoints' => [
[
'networkInterfaces' => [
[
'availabilityZone' => '<string>',
'networkInterfaceId' => '<string>',
'privateIpAddress' => '<string>',
'subnetId' => '<string>',
],
// ...
],
'vpcEndpointId' => '<string>',
'vpcId' => '<string>',
],
// ...
],
],
'enhancedVpcRouting' => true || false,
'namespaceName' => '<string>',
'port' => <integer>,
'publiclyAccessible' => true || false,
'securityGroupIds' => ['<string>', ...],
'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
'subnetIds' => ['<string>', ...],
'workgroupArn' => '<string>',
'workgroupId' => '<string>',
'workgroupName' => '<string>',
],
]
Result Details
Members
- workgroup
-
- Required: Yes
- Type: Workgroup structure
The deleted workgroup object.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
GetCredentials
$result = $client->getCredentials([/* ... */]); $promise = $client->getCredentialsAsync([/* ... */]);
Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).
<p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p> Parameter Syntax
$result = $client->getCredentials([
'dbName' => '<string>',
'durationSeconds' => <integer>,
'workgroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- 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
-
- Required: Yes
- 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
DbUserto log on to the databaseDbName. - dbUser
-
- Type: string
A database user name that is authorized to log on to the database
DbNameusing the passwordDbPassword. If the specifiedDbUserexists in the database, the new user name has the same database privileges as the the user named inDbUser. 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
DbPasswordexpires. - nextRefreshTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of when the
DbUserandDbPasswordauthorization refreshes.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The input failed to satisfy the constraints specified by an AWS service.
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
Result Syntax
[
'endpoint' => [
'address' => '<string>',
'endpointArn' => '<string>',
'endpointCreateTime' => <DateTime>,
'endpointName' => '<string>',
'endpointStatus' => '<string>',
'port' => <integer>,
'subnetIds' => ['<string>', ...],
'vpcEndpoint' => [
'networkInterfaces' => [
[
'availabilityZone' => '<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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[
'namespace' => [
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
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
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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[
'resourcePolicy' => [
'policy' => '<string>',
'resourceArn' => '<string>',
],
]
Result Details
Members
- resourcePolicy
-
- Type: ResourcePolicy structure
The returned resource policy.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
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
Result Syntax
[
'snapshot' => [
'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
'accountsWithRestoreAccess' => ['<string>', ...],
'actualIncrementalBackupSizeInMegaBytes' => <float>,
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
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
Result Syntax
[
'tableRestoreStatus' => [
'message' => '<string>',
'namespaceName' => '<string>',
'newTableName' => '<string>',
'progressInMegaBytes' => <integer>,
'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
TableRestoreStatusobject that contains information about the status of yourRestoreTableFromSnapshotrequest.
Errors
-
The resource could not be found.
-
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
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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[
'workgroup' => [
'baseCapacity' => <integer>,
'configParameters' => [
[
'parameterKey' => '<string>',
'parameterValue' => '<string>',
],
// ...
],
'creationDate' => <DateTime>,
'endpoint' => [
'address' => '<string>',
'port' => <integer>,
'vpcEndpoints' => [
[
'networkInterfaces' => [
[
'availabilityZone' => '<string>',
'networkInterfaceId' => '<string>',
'privateIpAddress' => '<string>',
'subnetId' => '<string>',
],
// ...
],
'vpcEndpointId' => '<string>',
'vpcId' => '<string>',
],
// ...
],
],
'enhancedVpcRouting' => true || false,
'namespaceName' => '<string>',
'port' => <integer>,
'publiclyAccessible' => true || false,
'securityGroupIds' => ['<string>', ...],
'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
'subnetIds' => ['<string>', ...],
'workgroupArn' => '<string>',
'workgroupId' => '<string>',
'workgroupName' => '<string>',
],
]
Result Details
Members
- workgroup
-
- Required: Yes
- Type: Workgroup structure
The returned workgroup object.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The input failed to satisfy the constraints specified by an AWS service.
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>',
'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
nextTokento display the next page of results. - nextToken
-
- Type: string
If your initial
ListEndpointAccessoperation returns anextToken, you can include the returnednextTokenin followingListEndpointAccessoperations, which returns results in the next page. - 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>',
'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
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
ListNamespaces
$result = $client->listNamespaces([/* ... */]); $promise = $client->listNamespacesAsync([/* ... */]);
Returns information about a list of specified namespaces.
Parameter Syntax
$result = $client->listNamespaces([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento display the next page of results. - nextToken
-
- Type: string
If your initial
ListNamespacesoperation returns anextToken, you can include the returnednextTokenin followingListNamespacesoperations, which returns results in the next page.
Result Syntax
[
'namespaces' => [
[
'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
nextTokenis returned, there are more results available. The value ofnextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
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
nextTokento 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
ListRecoveryPointsoperation returns anextToken, you can include the returnednextTokenin followingListRecoveryPointsoperations, 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
nextTokenis returned, there are more results available. The value ofnextTokenis 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
-
The request processing has failed because of an unknown error, exception or failure.
-
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
nextTokento 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
nextTokenis returned, there are more results available. The value ofnextTokenis 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>,
'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
nextTokenis returned, there are more results available. The value ofnextTokenis 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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
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
RestoreTableFromSnapshotoperations . - nextToken
-
- Type: string
If your initial
ListTableRestoreStatusoperation returns a nextToken, you can include the returnednextTokenin followingListTableRestoreStatusoperations. This will return results on the next page. - workgroupName
-
- Type: string
The workgroup from which to list all of the statuses of
RestoreTableFromSnapshotoperations.
Result Syntax
[
'nextToken' => '<string>',
'tableRestoreStatuses' => [
[
'message' => '<string>',
'namespaceName' => '<string>',
'newTableName' => '<string>',
'progressInMegaBytes' => <integer>,
'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
ListTableRestoreStatusoperation returns anextToken, you can include the returnednextTokenin followingListTableRestoreStatusoperations. This will returns results on the next page. - tableRestoreStatuses
-
- Type: Array of TableRestoreStatus structures
The array of returned
TableRestoreStatusobjects.
Errors
-
The provided pagination token is invalid.
-
The resource could not be found.
-
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
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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The input failed to satisfy the constraints specified by an AWS service.
-
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
nextTokento get the next page of results. The default is 100. - nextToken
-
- Type: string
If your initial
ListUsageLimitsoperation returns anextToken, you can include the returnednextTokenin followingListUsageLimitsoperations, 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
nextTokenis returned, there are more results available. The value ofnextTokenis 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
-
The request processing has failed because of an unknown error, exception or failure.
-
The provided pagination token is invalid.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento display the next page of results. - nextToken
-
- Type: string
If your initial ListWorkgroups operation returns a
nextToken, you can include the returnednextTokenin following ListNamespaces operations, which returns results in the next page.
Result Syntax
[
'nextToken' => '<string>',
'workgroups' => [
[
'baseCapacity' => <integer>,
'configParameters' => [
[
'parameterKey' => '<string>',
'parameterValue' => '<string>',
],
// ...
],
'creationDate' => <DateTime>,
'endpoint' => [
'address' => '<string>',
'port' => <integer>,
'vpcEndpoints' => [
[
'networkInterfaces' => [
[
'availabilityZone' => '<string>',
'networkInterfaceId' => '<string>',
'privateIpAddress' => '<string>',
'subnetId' => '<string>',
],
// ...
],
'vpcEndpointId' => '<string>',
'vpcId' => '<string>',
],
// ...
],
],
'enhancedVpcRouting' => true || false,
'namespaceName' => '<string>',
'port' => <integer>,
'publiclyAccessible' => true || false,
'securityGroupIds' => ['<string>', ...],
'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
'subnetIds' => ['<string>', ...],
'workgroupArn' => '<string>',
'workgroupId' => '<string>',
'workgroupName' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If
nextTokenis returned, there are more results available. The value ofnextTokenis 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
-
The request processing has failed because of an unknown error, exception or failure.
-
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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[
'namespace' => [
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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([
'namespaceName' => '<string>', // REQUIRED
'ownerAccount' => '<string>',
'snapshotArn' => '<string>',
'snapshotName' => '<string>',
'workgroupName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- 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' => [
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
ServiceQuotaExceededException:
The service limit was exceeded.
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>,
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The input failed to satisfy the constraints specified by an AWS service.
-
The request exceeded the number of tags allowed for a resource.
-
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
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The input failed to satisfy the constraints specified by an AWS service.
-
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
Result Syntax
[
'endpoint' => [
'address' => '<string>',
'endpointArn' => '<string>',
'endpointCreateTime' => <DateTime>,
'endpointName' => '<string>',
'endpointStatus' => '<string>',
'port' => <integer>,
'subnetIds' => ['<string>', ...],
'vpcEndpoint' => [
'networkInterfaces' => [
[
'availabilityZone' => '<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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
-
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([
'adminUserPassword' => '<string>',
'adminUsername' => '<string>',
'defaultIamRoleArn' => '<string>',
'iamRoles' => ['<string>', ...],
'kmsKeyId' => '<string>',
'logExports' => ['<string>', ...],
'namespaceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- adminUserPassword
-
- Type: string
The password of the administrator for the first database created in the namespace. This parameter must be updated together with
adminUsername. - 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, anduseractivitylog. - 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' => [
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
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
Result Syntax
[
'snapshot' => [
'accountsWithProvisionedRestoreAccess' => ['<string>', ...],
'accountsWithRestoreAccess' => ['<string>', ...],
'actualIncrementalBackupSizeInMegaBytes' => <float>,
'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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
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
-
The request processing has failed because of an unknown error, exception or failure.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
UpdateWorkgroup
$result = $client->updateWorkgroup([/* ... */]); $promise = $client->updateWorkgroupAsync([/* ... */]);
Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
Parameter Syntax
$result = $client->updateWorkgroup([
'baseCapacity' => <integer>,
'configParameters' => [
[
'parameterKey' => '<string>',
'parameterValue' => '<string>',
],
// ...
],
'enhancedVpcRouting' => true || false,
'port' => <integer>,
'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_sensitivity_identifier,enable_user_activity_logging,query_group,search_path, 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.
- 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.
- 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>,
'endpoint' => [
'address' => '<string>',
'port' => <integer>,
'vpcEndpoints' => [
[
'networkInterfaces' => [
[
'availabilityZone' => '<string>',
'networkInterfaceId' => '<string>',
'privateIpAddress' => '<string>',
'subnetId' => '<string>',
],
// ...
],
'vpcEndpointId' => '<string>',
'vpcId' => '<string>',
],
// ...
],
],
'enhancedVpcRouting' => true || false,
'namespaceName' => '<string>',
'port' => <integer>,
'publiclyAccessible' => true || false,
'securityGroupIds' => ['<string>', ...],
'status' => 'CREATING|AVAILABLE|MODIFYING|DELETING',
'subnetIds' => ['<string>', ...],
'workgroupArn' => '<string>',
'workgroupId' => '<string>',
'workgroupName' => '<string>',
],
]
Result Details
Members
- workgroup
-
- Required: Yes
- Type: Workgroup structure
The updated workgroup object.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
InsufficientCapacityException:
There is an insufficient capacity to perform the action.
-
The resource could not be found.
-
The submitted action has conflicts.
-
The input failed to satisfy the constraints specified by an AWS service.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
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_sensitivity_identifier,enable_user_activity_logging,query_group,search_path, 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
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
VpcEndpointobjects.
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
InternalServerException
Description
The request processing has failed because of an unknown error, exception or failure.
Members
InvalidPaginationException
Namespace
Description
A collection of database objects and users.
Members
- 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
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
ResourcePolicy
Description
The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
Members
ServiceQuotaExceededException
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.
- 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.
TableRestoreStatus
Description
Contains information about a table restore request.
Members
- message
-
- Type: string
A description of the status of the table restore request. Status values include
SUCCEEDED,FAILED,CANCELED,PENDING,IN_PROGRESS. - 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).
- 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 include
SUCCEEDED,FAILED,CANCELED,PENDING,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
ThrottlingException
Description
The request was denied due to request throttling.
Members
TooManyTagsException
Description
The request exceeded the number of tags allowed for a resource.
Members
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
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
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_sensitivity_identifier,enable_user_activity_logging,query_group, ,search_path, 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.
- 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.
- namespaceName
-
- Type: string
The namespace the workgroup is associated with.
- 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.
- 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.