aws
v1.0.4

View Source aws_redshiftserverless (aws v1.0.4)

This is prerelease documentation for Amazon Redshift Serverless, which is in preview release.

The documentation and the feature are both subject to change. We recommend that you use this feature only in test environments, and not in production environments. For preview terms and conditions, see Beta Service Participation in Amazon Web Services Service Terms.

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.

Summary

Functions

convert_recovery_point_to_snapshot(Client, Input)

Converts a recovery point to a snapshot.

convert_recovery_point_to_snapshot(Client, Input, Options)
create_endpoint_access(Client, Input)
Creates an Amazon Redshift Serverless managed VPC endpoint.
create_endpoint_access(Client, Input, Options)
create_namespace(Client, Input)
Creates a namespace in Amazon Redshift Serverless.
create_namespace(Client, Input, Options)
create_snapshot(Client, Input)

Creates a snapshot of all databases in a namespace.

create_snapshot(Client, Input, Options)
create_usage_limit(Client, Input)

Creates a usage limit for a specified Amazon Redshift Serverless usage type.

create_usage_limit(Client, Input, Options)
create_workgroup(Client, Input)
Creates an workgroup in Amazon Redshift Serverless.
create_workgroup(Client, Input, Options)
delete_endpoint_access(Client, Input)
Deletes an Amazon Redshift Serverless managed VPC endpoint.
delete_endpoint_access(Client, Input, Options)
delete_namespace(Client, Input)

Deletes a namespace from Amazon Redshift Serverless.

delete_namespace(Client, Input, Options)
delete_resource_policy(Client, Input)
Deletes the specified resource policy.
delete_resource_policy(Client, Input, Options)
delete_snapshot(Client, Input)
Deletes a snapshot from Amazon Redshift Serverless.
delete_snapshot(Client, Input, Options)
delete_usage_limit(Client, Input)
Deletes a usage limit from Amazon Redshift Serverless.
delete_usage_limit(Client, Input, Options)
delete_workgroup(Client, Input)
Deletes a workgroup.
delete_workgroup(Client, Input, Options)
get_credentials(Client, Input)

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

get_credentials(Client, Input, Options)
get_endpoint_access(Client, Input)
Returns information, such as the name, about a VPC endpoint.
get_endpoint_access(Client, Input, Options)
get_namespace(Client, Input)
Returns information about a namespace in Amazon Redshift Serverless.
get_namespace(Client, Input, Options)
get_recovery_point(Client, Input)
Returns information about a recovery point.
get_recovery_point(Client, Input, Options)
get_resource_policy(Client, Input)
Returns a resource policy.
get_resource_policy(Client, Input, Options)
get_snapshot(Client, Input)
Returns information about a specific snapshot.
get_snapshot(Client, Input, Options)
get_usage_limit(Client, Input)
Returns information about a usage limit.
get_usage_limit(Client, Input, Options)
get_workgroup(Client, Input)
Returns information about a specific workgroup.
get_workgroup(Client, Input, Options)
list_endpoint_access(Client, Input)
Returns an array of EndpointAccess objects and relevant information.
list_endpoint_access(Client, Input, Options)
list_namespaces(Client, Input)
Returns information about a list of specified namespaces.
list_namespaces(Client, Input, Options)
list_recovery_points(Client, Input)
Returns an array of recovery points.
list_recovery_points(Client, Input, Options)
list_snapshots(Client, Input)
Returns a list of snapshots.
list_snapshots(Client, Input, Options)
list_tags_for_resource(Client, Input)
Lists the tags assigned to a resource.
list_tags_for_resource(Client, Input, Options)
list_usage_limits(Client, Input)
Lists all usage limits within Amazon Redshift Serverless.
list_usage_limits(Client, Input, Options)
list_workgroups(Client, Input)
Returns information about a list of specified workgroups.
list_workgroups(Client, Input, Options)
put_resource_policy(Client, Input)

Creates or updates a resource policy.

put_resource_policy(Client, Input, Options)
restore_from_recovery_point(Client, Input)
Restore the data from a recovery point.
restore_from_recovery_point(Client, Input, Options)
restore_from_snapshot(Client, Input)
Restores a namespace from a snapshot.
restore_from_snapshot(Client, Input, Options)
tag_resource(Client, Input)
Assigns one or more tags to a resource.
tag_resource(Client, Input, Options)
untag_resource(Client, Input)
Removes a tag or set of tags from a resource.
untag_resource(Client, Input, Options)
update_endpoint_access(Client, Input)
Updates an Amazon Redshift Serverless managed endpoint.
update_endpoint_access(Client, Input, Options)
update_namespace(Client, Input)
Updates a namespace with the specified settings.
update_namespace(Client, Input, Options)
update_snapshot(Client, Input)
Updates a snapshot.
update_snapshot(Client, Input, Options)
update_usage_limit(Client, Input)

Update a usage limit in Amazon Redshift Serverless.

update_usage_limit(Client, Input, Options)
update_workgroup(Client, Input)
Updates a workgroup with the specified configuration settings.
update_workgroup(Client, Input, Options)

Functions

Link to this function

convert_recovery_point_to_snapshot(Client, Input)

View Source

Converts a recovery point to a snapshot.

For more information about recovery points and snapshots, see Working with snapshots and recovery points.
Link to this function

convert_recovery_point_to_snapshot(Client, Input, Options)

View Source
Link to this function

create_endpoint_access(Client, Input)

View Source
Creates an Amazon Redshift Serverless managed VPC endpoint.
Link to this function

create_endpoint_access(Client, Input, Options)

View Source
Link to this function

create_namespace(Client, Input)

View Source
Creates a namespace in Amazon Redshift Serverless.
Link to this function

create_namespace(Client, Input, Options)

View Source
Link to this function

create_snapshot(Client, Input)

View Source

Creates a snapshot of all databases in a namespace.

For more information about snapshots, see Working with snapshots and recovery points.
Link to this function

create_snapshot(Client, Input, Options)

View Source
Link to this function

create_usage_limit(Client, Input)

View Source

Creates a usage limit for a specified Amazon Redshift Serverless usage type.

The usage limit is identified by the returned usage limit identifier.
Link to this function

create_usage_limit(Client, Input, Options)

View Source
Link to this function

create_workgroup(Client, Input)

View Source
Creates an workgroup in Amazon Redshift Serverless.
Link to this function

create_workgroup(Client, Input, Options)

View Source
Link to this function

delete_endpoint_access(Client, Input)

View Source
Deletes an Amazon Redshift Serverless managed VPC endpoint.
Link to this function

delete_endpoint_access(Client, Input, Options)

View Source
Link to this function

delete_namespace(Client, Input)

View Source

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.
Link to this function

delete_namespace(Client, Input, Options)

View Source
Link to this function

delete_resource_policy(Client, Input)

View Source
Deletes the specified resource policy.
Link to this function

delete_resource_policy(Client, Input, Options)

View Source
Link to this function

delete_snapshot(Client, Input)

View Source
Deletes a snapshot from Amazon Redshift Serverless.
Link to this function

delete_snapshot(Client, Input, Options)

View Source
Link to this function

delete_usage_limit(Client, Input)

View Source
Deletes a usage limit from Amazon Redshift Serverless.
Link to this function

delete_usage_limit(Client, Input, Options)

View Source
Link to this function

delete_workgroup(Client, Input)

View Source
Deletes a workgroup.
Link to this function

delete_workgroup(Client, Input, Options)

View Source
Link to this function

get_credentials(Client, Input)

View Source

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.

Link to this function

get_credentials(Client, Input, Options)

View Source
Link to this function

get_endpoint_access(Client, Input)

View Source
Returns information, such as the name, about a VPC endpoint.
Link to this function

get_endpoint_access(Client, Input, Options)

View Source
Link to this function

get_namespace(Client, Input)

View Source
Returns information about a namespace in Amazon Redshift Serverless.
Link to this function

get_namespace(Client, Input, Options)

View Source
Link to this function

get_recovery_point(Client, Input)

View Source
Returns information about a recovery point.
Link to this function

get_recovery_point(Client, Input, Options)

View Source
Link to this function

get_resource_policy(Client, Input)

View Source
Returns a resource policy.
Link to this function

get_resource_policy(Client, Input, Options)

View Source
Link to this function

get_snapshot(Client, Input)

View Source
Returns information about a specific snapshot.
Link to this function

get_snapshot(Client, Input, Options)

View Source
Link to this function

get_usage_limit(Client, Input)

View Source
Returns information about a usage limit.
Link to this function

get_usage_limit(Client, Input, Options)

View Source
Link to this function

get_workgroup(Client, Input)

View Source
Returns information about a specific workgroup.
Link to this function

get_workgroup(Client, Input, Options)

View Source
Link to this function

list_endpoint_access(Client, Input)

View Source
Returns an array of EndpointAccess objects and relevant information.
Link to this function

list_endpoint_access(Client, Input, Options)

View Source
Link to this function

list_namespaces(Client, Input)

View Source
Returns information about a list of specified namespaces.
Link to this function

list_namespaces(Client, Input, Options)

View Source
Link to this function

list_recovery_points(Client, Input)

View Source
Returns an array of recovery points.
Link to this function

list_recovery_points(Client, Input, Options)

View Source
Link to this function

list_snapshots(Client, Input)

View Source
Returns a list of snapshots.
Link to this function

list_snapshots(Client, Input, Options)

View Source
Link to this function

list_tags_for_resource(Client, Input)

View Source
Lists the tags assigned to a resource.
Link to this function

list_tags_for_resource(Client, Input, Options)

View Source
Link to this function

list_usage_limits(Client, Input)

View Source
Lists all usage limits within Amazon Redshift Serverless.
Link to this function

list_usage_limits(Client, Input, Options)

View Source
Link to this function

list_workgroups(Client, Input)

View Source
Returns information about a list of specified workgroups.
Link to this function

list_workgroups(Client, Input, Options)

View Source
Link to this function

put_resource_policy(Client, Input)

View Source

Creates or updates a resource policy.

Currently, you can use policies to share snapshots across Amazon Web Services accounts.
Link to this function

put_resource_policy(Client, Input, Options)

View Source
Link to this function

restore_from_recovery_point(Client, Input)

View Source
Restore the data from a recovery point.
Link to this function

restore_from_recovery_point(Client, Input, Options)

View Source
Link to this function

restore_from_snapshot(Client, Input)

View Source
Restores a namespace from a snapshot.
Link to this function

restore_from_snapshot(Client, Input, Options)

View Source
Link to this function

tag_resource(Client, Input)

View Source
Assigns one or more tags to a resource.
Link to this function

tag_resource(Client, Input, Options)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Removes a tag or set of tags from a resource.
Link to this function

untag_resource(Client, Input, Options)

View Source
Link to this function

update_endpoint_access(Client, Input)

View Source
Updates an Amazon Redshift Serverless managed endpoint.
Link to this function

update_endpoint_access(Client, Input, Options)

View Source
Link to this function

update_namespace(Client, Input)

View Source
Updates a namespace with the specified settings.
Link to this function

update_namespace(Client, Input, Options)

View Source
Link to this function

update_snapshot(Client, Input)

View Source
Updates a snapshot.
Link to this function

update_snapshot(Client, Input, Options)

View Source
Link to this function

update_usage_limit(Client, Input)

View Source

Update a usage limit in Amazon Redshift Serverless.

You can't update the usage type or period of a usage limit.
Link to this function

update_usage_limit(Client, Input, Options)

View Source
Link to this function

update_workgroup(Client, Input)

View Source
Updates a workgroup with the specified configuration settings.
Link to this function

update_workgroup(Client, Input, Options)

View Source