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.
redshiftserverless(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- redshiftserverless(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| convert_recovery_point_to_snapshot | Converts a recovery point to a snapshot |
| create_custom_domain_association | Creates a custom domain association for Amazon Redshift Serverless |
| create_endpoint_access | Creates an Amazon Redshift Serverless managed VPC endpoint |
| create_namespace | Creates a namespace in Amazon Redshift Serverless |
| create_scheduled_action | Creates a scheduled action |
| create_snapshot | Creates a snapshot of all databases in a namespace |
| create_snapshot_copy_configuration | Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region |
| create_usage_limit | Creates a usage limit for a specified Amazon Redshift Serverless usage type |
| create_workgroup | Creates an workgroup in Amazon Redshift Serverless |
| delete_custom_domain_association | Deletes a custom domain association for Amazon Redshift Serverless |
| delete_endpoint_access | Deletes an Amazon Redshift Serverless managed VPC endpoint |
| delete_namespace | Deletes a namespace from Amazon Redshift Serverless |
| delete_resource_policy | Deletes the specified resource policy |
| delete_scheduled_action | Deletes a scheduled action |
| delete_snapshot | Deletes a snapshot from Amazon Redshift Serverless |
| delete_snapshot_copy_configuration | Deletes a snapshot copy configuration |
| delete_usage_limit | Deletes a usage limit from Amazon Redshift Serverless |
| delete_workgroup | Deletes a workgroup |
| get_credentials | Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless |
| get_custom_domain_association | Gets information about a specific custom domain association |
| get_endpoint_access | Returns information, such as the name, about a VPC endpoint |
| get_namespace | Returns information about a namespace in Amazon Redshift Serverless |
| get_recovery_point | Returns information about a recovery point |
| get_resource_policy | Returns a resource policy |
| get_scheduled_action | Returns information about a scheduled action |
| get_snapshot | Returns information about a specific snapshot |
| get_table_restore_status | Returns information about a TableRestoreStatus object |
| get_usage_limit | Returns information about a usage limit |
| get_workgroup | Returns information about a specific workgroup |
| list_custom_domain_associations | Lists custom domain associations for Amazon Redshift Serverless |
| list_endpoint_access | Returns an array of EndpointAccess objects and relevant information |
| list_namespaces | Returns information about a list of specified namespaces |
| list_recovery_points | Returns an array of recovery points |
| list_scheduled_actions | Returns a list of scheduled actions |
| list_snapshot_copy_configurations | Returns a list of snapshot copy configurations |
| list_snapshots | Returns a list of snapshots |
| list_table_restore_status | Returns information about an array of TableRestoreStatus objects |
| list_tags_for_resource | Lists the tags assigned to a resource |
| list_usage_limits | Lists all usage limits within Amazon Redshift Serverless |
| list_workgroups | Returns information about a list of specified workgroups |
| put_resource_policy | Creates or updates a resource policy |
| restore_from_recovery_point | Restore the data from a recovery point |
| restore_from_snapshot | Restores a namespace from a snapshot |
| restore_table_from_recovery_point | Restores a table from a recovery point to your Amazon Redshift Serverless instance |
| restore_table_from_snapshot | Restores a table from a snapshot to your Amazon Redshift Serverless instance |
| tag_resource | Assigns one or more tags to a resource |
| untag_resource | Removes a tag or set of tags from a resource |
| update_custom_domain_association | Updates an Amazon Redshift Serverless certificate associated with a custom domain |
| update_endpoint_access | Updates an Amazon Redshift Serverless managed endpoint |
| update_namespace | Updates a namespace with the specified settings |
| update_scheduled_action | Updates a scheduled action |
| update_snapshot | Updates a snapshot |
| update_snapshot_copy_configuration | Updates a snapshot copy configuration |
| update_usage_limit | Update a usage limit in Amazon Redshift Serverless |
| update_workgroup | Updates a workgroup with the specified configuration settings |
if (FALSE) {
svc <- redshiftserverless()
svc$convert_recovery_point_to_snapshot(
Foo = 123
)
}
Run the code above in your browser using DataLab