View Source aws_redshift_serverless (aws v1.0.4)
This is an interface reference for Amazon Redshift Serverless.
It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.
Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.
To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless: https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-whatis.html.Summary
Functions
Converts a recovery point to a snapshot.
Creates a scheduled action.
Creates a snapshot of all databases in a namespace.
Creates a usage limit for a specified Amazon Redshift Serverless usage type.
Deletes a namespace from Amazon Redshift Serverless.
Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
TableRestoreStatus
object.EndpointAccess
objects and relevant information.Returns a list of scheduled actions.
TableRestoreStatus
objects.Creates or updates a resource policy.
Restores a table from a recovery point to your Amazon Redshift Serverless instance.
Restores a table from a snapshot to your Amazon Redshift Serverless instance.
Updates a namespace with the specified settings.
Update a usage limit in Amazon Redshift Serverless.
Updates a workgroup with the specified configuration settings.
Functions
Converts a recovery point to a snapshot.
For more information about recovery points and snapshots, see Working with snapshots and recovery points: https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html.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 theCreateSnapshot
API operation.
Creates a snapshot of all databases in a namespace.
For more information about snapshots, see Working with snapshots and recovery points: https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html.Creates a usage limit for a specified Amazon Redshift Serverless usage type.
The usage limit is identified by the returned usage limit identifier.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.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>TableRestoreStatus
object.
EndpointAccess
objects and relevant information.
Returns a list of scheduled actions.
You can use the flags to filter the list of returned scheduled actions.TableRestoreStatus
objects.
Creates or updates a resource policy.
Currently, you can use policies to share snapshots across Amazon Web Services accounts.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.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: https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved.Updates a namespace with the specified settings.
Unless required, you can't update multiple parameters in one request. For example, you must specify bothadminUsername
and adminUserPassword
to update either field, but you can't update both kmsKeyId
and logExports
in a single request.
Update a usage limit in Amazon Redshift Serverless.
You can't update the usage type or period of a usage limit.Updates a workgroup with the specified configuration settings.
You can't update multiple parameters in one request. For example, you can updatebaseCapacity
or port
in a single request, but you can't update both in the same request.