View Source AWS.RedshiftServerless (aws-elixir v0.14.1)

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

Converts a recovery point to a snapshot.

Creates a custom domain association for Amazon Redshift Serverless.

Creates an Amazon Redshift Serverless managed VPC endpoint.

Creates a namespace in Amazon Redshift Serverless.

Creates a snapshot of all databases in a namespace.

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

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

Creates an workgroup in Amazon Redshift Serverless.

Deletes a custom domain association for Amazon Redshift Serverless.

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Deletes a namespace from Amazon Redshift Serverless.

Deletes the specified resource policy.

Deletes a snapshot from Amazon Redshift Serverless.

Deletes a usage limit from Amazon Redshift Serverless.

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

Gets information about a specific custom domain association.

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

Returns information about a namespace in Amazon Redshift Serverless.

Returns information about a recovery point.

Returns information about a scheduled action.

Returns information about a specific snapshot.

Returns information about a TableRestoreStatus object.

Returns information about a usage limit.

Returns information about a specific workgroup.

Lists custom domain associations for Amazon Redshift Serverless.

Returns an array of EndpointAccess objects and relevant information.

Returns information about a list of specified namespaces.

Returns an array of recovery points.

Returns a list of scheduled actions.

Returns a list of snapshot copy configurations.

Returns a list of snapshots.

Returns information about an array of TableRestoreStatus objects.

Lists the tags assigned to a resource.

Lists all usage limits within Amazon Redshift Serverless.

Returns information about a list of specified workgroups.

Creates or updates a resource policy.

Restore the data from a recovery point.

Restores a namespace from a snapshot.

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.

Assigns one or more tags to a resource.

Removes a tag or set of tags from a resource.

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

Updates an Amazon Redshift Serverless managed endpoint.

Updates a namespace with the specified settings.

Update a usage limit in Amazon Redshift Serverless.

Updates a workgroup with the specified configuration settings.

Functions

Link to this function

convert_recovery_point_to_snapshot(client, input, options \\ [])

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

create_custom_domain_association(client, input, options \\ [])

View Source

Creates a custom domain association for Amazon Redshift Serverless.

Link to this function

create_endpoint_access(client, input, options \\ [])

View Source

Creates an Amazon Redshift Serverless managed VPC endpoint.

Link to this function

create_namespace(client, input, options \\ [])

View Source

Creates a namespace in Amazon Redshift Serverless.

Link to this function

create_scheduled_action(client, input, options \\ [])

View Source

Creates a scheduled action.

A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.

Link to this function

create_snapshot(client, input, options \\ [])

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_copy_configuration(client, input, options \\ [])

View Source

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

Link to this function

create_usage_limit(client, input, options \\ [])

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_workgroup(client, input, options \\ [])

View Source

Creates an workgroup in Amazon Redshift Serverless.

Link to this function

delete_custom_domain_association(client, input, options \\ [])

View Source

Deletes a custom domain association for Amazon Redshift Serverless.

Link to this function

delete_endpoint_access(client, input, options \\ [])

View Source

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Link to this function

delete_namespace(client, input, options \\ [])

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_resource_policy(client, input, options \\ [])

View Source

Deletes the specified resource policy.

Link to this function

delete_scheduled_action(client, input, options \\ [])

View Source

Deletes a scheduled action.

Link to this function

delete_snapshot(client, input, options \\ [])

View Source

Deletes a snapshot from Amazon Redshift Serverless.

Link to this function

delete_snapshot_copy_configuration(client, input, options \\ [])

View Source

Deletes a snapshot copy configuration

Link to this function

delete_usage_limit(client, input, options \\ [])

View Source

Deletes a usage limit from Amazon Redshift Serverless.

Link to this function

delete_workgroup(client, input, options \\ [])

View Source

Deletes a workgroup.

Link to this function

get_credentials(client, input, options \\ [])

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 theDbNameparameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Link to this function

get_custom_domain_association(client, input, options \\ [])

View Source

Gets information about a specific custom domain association.

Link to this function

get_endpoint_access(client, input, options \\ [])

View Source

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

Link to this function

get_namespace(client, input, options \\ [])

View Source

Returns information about a namespace in Amazon Redshift Serverless.

Link to this function

get_recovery_point(client, input, options \\ [])

View Source

Returns information about a recovery point.

Link to this function

get_resource_policy(client, input, options \\ [])

View Source

Returns a resource policy.

Link to this function

get_scheduled_action(client, input, options \\ [])

View Source

Returns information about a scheduled action.

Link to this function

get_snapshot(client, input, options \\ [])

View Source

Returns information about a specific snapshot.

Link to this function

get_table_restore_status(client, input, options \\ [])

View Source

Returns information about a TableRestoreStatus object.

Link to this function

get_usage_limit(client, input, options \\ [])

View Source

Returns information about a usage limit.

Link to this function

get_workgroup(client, input, options \\ [])

View Source

Returns information about a specific workgroup.

Link to this function

list_custom_domain_associations(client, input, options \\ [])

View Source

Lists custom domain associations for Amazon Redshift Serverless.

Link to this function

list_endpoint_access(client, input, options \\ [])

View Source

Returns an array of EndpointAccess objects and relevant information.

Link to this function

list_namespaces(client, input, options \\ [])

View Source

Returns information about a list of specified namespaces.

Link to this function

list_recovery_points(client, input, options \\ [])

View Source

Returns an array of recovery points.

Link to this function

list_scheduled_actions(client, input, options \\ [])

View Source

Returns a list of scheduled actions.

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

Link to this function

list_snapshot_copy_configurations(client, input, options \\ [])

View Source

Returns a list of snapshot copy configurations.

Link to this function

list_snapshots(client, input, options \\ [])

View Source

Returns a list of snapshots.

Link to this function

list_table_restore_status(client, input, options \\ [])

View Source

Returns information about an array of TableRestoreStatus objects.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags assigned to a resource.

Link to this function

list_usage_limits(client, input, options \\ [])

View Source

Lists all usage limits within Amazon Redshift Serverless.

Link to this function

list_workgroups(client, input, options \\ [])

View Source

Returns information about a list of specified workgroups.

Link to this function

put_resource_policy(client, input, options \\ [])

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

restore_from_recovery_point(client, input, options \\ [])

View Source

Restore the data from a recovery point.

Link to this function

restore_from_snapshot(client, input, options \\ [])

View Source

Restores a namespace from a snapshot.

Link to this function

restore_table_from_recovery_point(client, input, options \\ [])

View Source

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.

Link to this function

restore_table_from_snapshot(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Assigns one or more tags to a resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes a tag or set of tags from a resource.

Link to this function

update_custom_domain_association(client, input, options \\ [])

View Source

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

Link to this function

update_endpoint_access(client, input, options \\ [])

View Source

Updates an Amazon Redshift Serverless managed endpoint.

Link to this function

update_namespace(client, input, options \\ [])

View Source

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.

Link to this function

update_scheduled_action(client, input, options \\ [])

View Source

Updates a scheduled action.

Link to this function

update_snapshot(client, input, options \\ [])

View Source

Updates a snapshot.

Link to this function

update_snapshot_copy_configuration(client, input, options \\ [])

View Source

Updates a snapshot copy configuration.

Link to this function

update_usage_limit(client, input, options \\ [])

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_workgroup(client, input, options \\ [])

View Source

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.