RedshiftServerlessClient

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.

Properties

Link copied to clipboard

RedshiftServerlessClient's configuration

Functions

Link copied to clipboard

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.

Link copied to clipboard

Creates a custom domain association for Amazon Redshift Serverless.

Link copied to clipboard

Creates an Amazon Redshift Serverless managed VPC endpoint.

Link copied to clipboard

Creates a namespace in Amazon Redshift Serverless.

Link copied to clipboard

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 copied to clipboard

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.

Link copied to clipboard

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

Link copied to clipboard

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Link copied to clipboard

Creates an workgroup in Amazon Redshift Serverless.

Link copied to clipboard

Deletes a custom domain association for Amazon Redshift Serverless.

Link copied to clipboard

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Link copied to clipboard

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 copied to clipboard

Deletes the specified resource policy.

Link copied to clipboard

Deletes a scheduled action.

Link copied to clipboard

Deletes a snapshot from Amazon Redshift Serverless.

Link copied to clipboard
Link copied to clipboard

Deletes a usage limit from Amazon Redshift Serverless.

Link copied to clipboard

Deletes a workgroup.

Link copied to clipboard
abstract suspend fun getCredentials(input: GetCredentialsRequest = GetCredentialsRequest { }): GetCredentialsResponse

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

Link copied to clipboard

Gets information about a specific custom domain association.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a namespace in Amazon Redshift Serverless.

Link copied to clipboard

Returns information about a recovery point.

Link copied to clipboard

Returns a resource policy.

Link copied to clipboard

Returns information about a scheduled action.

Link copied to clipboard
abstract suspend fun getSnapshot(input: GetSnapshotRequest = GetSnapshotRequest { }): GetSnapshotResponse

Returns information about a specific snapshot.

Link copied to clipboard

Returns information about a TableRestoreStatus object.

Link copied to clipboard

Returns information about a usage limit.

Link copied to clipboard

Returns information about a specific workgroup.

Link copied to clipboard
abstract suspend fun listCustomDomainAssociations(input: ListCustomDomainAssociationsRequest = ListCustomDomainAssociationsRequest { }): ListCustomDomainAssociationsResponse

Lists custom domain associations for Amazon Redshift Serverless.

Link copied to clipboard
abstract suspend fun listEndpointAccess(input: ListEndpointAccessRequest = ListEndpointAccessRequest { }): ListEndpointAccessResponse

Returns an array of EndpointAccess objects and relevant information.

Link copied to clipboard
abstract suspend fun listNamespaces(input: ListNamespacesRequest = ListNamespacesRequest { }): ListNamespacesResponse

Returns information about a list of specified namespaces.

Link copied to clipboard
abstract suspend fun listRecoveryPoints(input: ListRecoveryPointsRequest = ListRecoveryPointsRequest { }): ListRecoveryPointsResponse

Returns an array of recovery points.

Link copied to clipboard
abstract suspend fun listScheduledActions(input: ListScheduledActionsRequest = ListScheduledActionsRequest { }): ListScheduledActionsResponse

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

Link copied to clipboard
abstract suspend fun listSnapshotCopyConfigurations(input: ListSnapshotCopyConfigurationsRequest = ListSnapshotCopyConfigurationsRequest { }): ListSnapshotCopyConfigurationsResponse

Returns a list of snapshot copy configurations.

Link copied to clipboard
abstract suspend fun listSnapshots(input: ListSnapshotsRequest = ListSnapshotsRequest { }): ListSnapshotsResponse

Returns a list of snapshots.

Link copied to clipboard
abstract suspend fun listTableRestoreStatus(input: ListTableRestoreStatusRequest = ListTableRestoreStatusRequest { }): ListTableRestoreStatusResponse

Returns information about an array of TableRestoreStatus objects.

Link copied to clipboard

Lists the tags assigned to a resource.

Link copied to clipboard
abstract suspend fun listUsageLimits(input: ListUsageLimitsRequest = ListUsageLimitsRequest { }): ListUsageLimitsResponse

Lists all usage limits within Amazon Redshift Serverless.

Link copied to clipboard
abstract suspend fun listWorkgroups(input: ListWorkgroupsRequest = ListWorkgroupsRequest { }): ListWorkgroupsResponse

Returns information about a list of specified workgroups.

Link copied to clipboard

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

Link copied to clipboard

Restore the data from a recovery point.

Link copied to clipboard

Restores a namespace from a snapshot.

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Assigns one or more tags to a resource.

Link copied to clipboard

Removes a tag or set of tags from a resource.

Link copied to clipboard

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

Link copied to clipboard

Updates an Amazon Redshift Serverless managed endpoint.

Link copied to clipboard

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 copied to clipboard

Updates a scheduled action.

Link copied to clipboard

Updates a snapshot.

Link copied to clipboard
Link copied to clipboard

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

Link copied to clipboard

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.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.

Link copied to clipboard

Creates a custom domain association for Amazon Redshift Serverless.

Link copied to clipboard

Creates an Amazon Redshift Serverless managed VPC endpoint.

Link copied to clipboard

Creates a namespace in Amazon Redshift Serverless.

Link copied to clipboard

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 copied to clipboard

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.

Link copied to clipboard

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

Link copied to clipboard

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Link copied to clipboard

Creates an workgroup in Amazon Redshift Serverless.

Link copied to clipboard

Deletes a custom domain association for Amazon Redshift Serverless.

Link copied to clipboard

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Link copied to clipboard

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 copied to clipboard

Deletes the specified resource policy.

Link copied to clipboard

Deletes a scheduled action.

Link copied to clipboard

Deletes a snapshot from Amazon Redshift Serverless.

Link copied to clipboard

Deletes a usage limit from Amazon Redshift Serverless.

Link copied to clipboard

Deletes a workgroup.

Link copied to clipboard

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

Link copied to clipboard

Gets information about a specific custom domain association.

Link copied to clipboard

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

Link copied to clipboard

Returns information about a namespace in Amazon Redshift Serverless.

Link copied to clipboard

Returns information about a recovery point.

Link copied to clipboard

Returns a resource policy.

Link copied to clipboard

Returns information about a scheduled action.

Link copied to clipboard

Returns information about a specific snapshot.

Link copied to clipboard

Returns information about a TableRestoreStatus object.

Link copied to clipboard

Returns information about a usage limit.

Link copied to clipboard

Returns information about a specific workgroup.

Link copied to clipboard

Lists custom domain associations for Amazon Redshift Serverless.

Link copied to clipboard

Returns an array of EndpointAccess objects and relevant information.

Link copied to clipboard

Returns information about a list of specified namespaces.

Link copied to clipboard

Returns an array of recovery points.

Link copied to clipboard

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

Link copied to clipboard

Returns a list of snapshot copy configurations.

Link copied to clipboard

Returns a list of snapshots.

Link copied to clipboard

Returns information about an array of TableRestoreStatus objects.

Link copied to clipboard

Lists the tags assigned to a resource.

Link copied to clipboard

Lists all usage limits within Amazon Redshift Serverless.

Link copied to clipboard

Returns information about a list of specified workgroups.

Link copied to clipboard

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

Link copied to clipboard

Restore the data from a recovery point.

Link copied to clipboard

Restores a namespace from a snapshot.

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

Assigns one or more tags to a resource.

Link copied to clipboard

Removes a tag or set of tags from a resource.

Link copied to clipboard

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

Link copied to clipboard

Updates an Amazon Redshift Serverless managed endpoint.

Link copied to clipboard

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 copied to clipboard

Updates a scheduled action.

Link copied to clipboard

Updates a snapshot.

Link copied to clipboard

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.