redshiftserverless/aws.sdk.kotlin.services.redshiftserverless/RedshiftServerlessClient

RedshiftServerlessClient

interface RedshiftServerlessClient : SdkClient

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?.

Types

Builder

class Builder : AbstractSdkClientBuilder<RedshiftServerlessClient.Config, RedshiftServerlessClient.Config.Builder, RedshiftServerlessClient>

Companion

object Companion : AbstractAwsSdkClientFactory<RedshiftServerlessClient.Config, RedshiftServerlessClient.Config.Builder, RedshiftServerlessClient, RedshiftServerlessClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: RedshiftServerlessClient.Config

RedshiftServerlessClient's configuration

Functions

convertRecoveryPointToSnapshot

abstract suspend fun convertRecoveryPointToSnapshot(input: ConvertRecoveryPointToSnapshotRequest): ConvertRecoveryPointToSnapshotResponse

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

createCustomDomainAssociation

abstract suspend fun createCustomDomainAssociation(input: CreateCustomDomainAssociationRequest): CreateCustomDomainAssociationResponse

Creates a custom domain association for Amazon Redshift Serverless.

createEndpointAccess

abstract suspend fun createEndpointAccess(input: CreateEndpointAccessRequest): CreateEndpointAccessResponse

Creates an Amazon Redshift Serverless managed VPC endpoint.

createNamespace

abstract suspend fun createNamespace(input: CreateNamespaceRequest): CreateNamespaceResponse

Creates a namespace in Amazon Redshift Serverless.

createReservation

abstract suspend fun createReservation(input: CreateReservationRequest): CreateReservationResponse

Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.

createScheduledAction

abstract suspend fun createScheduledAction(input: CreateScheduledActionRequest): CreateScheduledActionResponse

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.

createSnapshot

abstract suspend fun createSnapshot(input: CreateSnapshotRequest): CreateSnapshotResponse

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

createSnapshotCopyConfiguration

abstract suspend fun createSnapshotCopyConfiguration(input: CreateSnapshotCopyConfigurationRequest): CreateSnapshotCopyConfigurationResponse

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

createUsageLimit

abstract suspend fun createUsageLimit(input: CreateUsageLimitRequest): CreateUsageLimitResponse

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

createWorkgroup

abstract suspend fun createWorkgroup(input: CreateWorkgroupRequest): CreateWorkgroupResponse

Creates an workgroup in Amazon Redshift Serverless.

deleteCustomDomainAssociation

abstract suspend fun deleteCustomDomainAssociation(input: DeleteCustomDomainAssociationRequest): DeleteCustomDomainAssociationResponse

Deletes a custom domain association for Amazon Redshift Serverless.

deleteEndpointAccess

abstract suspend fun deleteEndpointAccess(input: DeleteEndpointAccessRequest): DeleteEndpointAccessResponse

Deletes an Amazon Redshift Serverless managed VPC endpoint.

deleteNamespace

abstract suspend fun deleteNamespace(input: DeleteNamespaceRequest): DeleteNamespaceResponse

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.

deleteResourcePolicy

abstract suspend fun deleteResourcePolicy(input: DeleteResourcePolicyRequest): DeleteResourcePolicyResponse

Deletes the specified resource policy.

deleteScheduledAction

abstract suspend fun deleteScheduledAction(input: DeleteScheduledActionRequest): DeleteScheduledActionResponse

Deletes a scheduled action.

deleteSnapshot

abstract suspend fun deleteSnapshot(input: DeleteSnapshotRequest): DeleteSnapshotResponse

Deletes a snapshot from Amazon Redshift Serverless.

deleteSnapshotCopyConfiguration

abstract suspend fun deleteSnapshotCopyConfiguration(input: DeleteSnapshotCopyConfigurationRequest): DeleteSnapshotCopyConfigurationResponse

Deletes a snapshot copy configuration

deleteUsageLimit

abstract suspend fun deleteUsageLimit(input: DeleteUsageLimitRequest): DeleteUsageLimitResponse

Deletes a usage limit from Amazon Redshift Serverless.

deleteWorkgroup

abstract suspend fun deleteWorkgroup(input: DeleteWorkgroupRequest): DeleteWorkgroupResponse

Deletes a workgroup.

getCredentials

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.

getCustomDomainAssociation

abstract suspend fun getCustomDomainAssociation(input: GetCustomDomainAssociationRequest): GetCustomDomainAssociationResponse

Gets information about a specific custom domain association.

getEndpointAccess

abstract suspend fun getEndpointAccess(input: GetEndpointAccessRequest): GetEndpointAccessResponse

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

getNamespace

abstract suspend fun getNamespace(input: GetNamespaceRequest): GetNamespaceResponse

Returns information about a namespace in Amazon Redshift Serverless.

getRecoveryPoint

abstract suspend fun getRecoveryPoint(input: GetRecoveryPointRequest): GetRecoveryPointResponse

Returns information about a recovery point.

getReservation

abstract suspend fun getReservation(input: GetReservationRequest): GetReservationResponse

Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.

getReservationOffering

abstract suspend fun getReservationOffering(input: GetReservationOfferingRequest): GetReservationOfferingResponse

Returns the reservation offering. The offering determines the payment schedule for the reservation.

getResourcePolicy

abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

Returns a resource policy.

getScheduledAction

abstract suspend fun getScheduledAction(input: GetScheduledActionRequest): GetScheduledActionResponse

Returns information about a scheduled action.

getSnapshot

abstract suspend fun getSnapshot(input: GetSnapshotRequest = GetSnapshotRequest { }): GetSnapshotResponse

Returns information about a specific snapshot.

getTableRestoreStatus

abstract suspend fun getTableRestoreStatus(input: GetTableRestoreStatusRequest): GetTableRestoreStatusResponse

Returns information about a TableRestoreStatus object.

getTrack

abstract suspend fun getTrack(input: GetTrackRequest): GetTrackResponse

Get the Redshift Serverless version for a specified track.

getUsageLimit

abstract suspend fun getUsageLimit(input: GetUsageLimitRequest): GetUsageLimitResponse

Returns information about a usage limit.

getWorkgroup

abstract suspend fun getWorkgroup(input: GetWorkgroupRequest): GetWorkgroupResponse

Returns information about a specific workgroup.

listCustomDomainAssociations

abstract suspend fun listCustomDomainAssociations(input: ListCustomDomainAssociationsRequest = ListCustomDomainAssociationsRequest { }): ListCustomDomainAssociationsResponse

Lists custom domain associations for Amazon Redshift Serverless.

listEndpointAccess

abstract suspend fun listEndpointAccess(input: ListEndpointAccessRequest = ListEndpointAccessRequest { }): ListEndpointAccessResponse

Returns an array of EndpointAccess objects and relevant information.

listManagedWorkgroups

abstract suspend fun listManagedWorkgroups(input: ListManagedWorkgroupsRequest = ListManagedWorkgroupsRequest { }): ListManagedWorkgroupsResponse

Returns information about a list of specified managed workgroups in your account.

listNamespaces

abstract suspend fun listNamespaces(input: ListNamespacesRequest = ListNamespacesRequest { }): ListNamespacesResponse

Returns information about a list of specified namespaces.

listRecoveryPoints

abstract suspend fun listRecoveryPoints(input: ListRecoveryPointsRequest = ListRecoveryPointsRequest { }): ListRecoveryPointsResponse

Returns an array of recovery points.

listReservationOfferings

abstract suspend fun listReservationOfferings(input: ListReservationOfferingsRequest = ListReservationOfferingsRequest { }): ListReservationOfferingsResponse

Returns the current reservation offerings in your account.

listReservations

abstract suspend fun listReservations(input: ListReservationsRequest = ListReservationsRequest { }): ListReservationsResponse

Returns a list of Reservation objects.

listScheduledActions

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.

listSnapshotCopyConfigurations

abstract suspend fun listSnapshotCopyConfigurations(input: ListSnapshotCopyConfigurationsRequest = ListSnapshotCopyConfigurationsRequest { }): ListSnapshotCopyConfigurationsResponse

Returns a list of snapshot copy configurations.

listSnapshots

abstract suspend fun listSnapshots(input: ListSnapshotsRequest = ListSnapshotsRequest { }): ListSnapshotsResponse

Returns a list of snapshots.

listTableRestoreStatus

abstract suspend fun listTableRestoreStatus(input: ListTableRestoreStatusRequest = ListTableRestoreStatusRequest { }): ListTableRestoreStatusResponse

Returns information about an array of TableRestoreStatus objects.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags assigned to a resource.

listTracks

abstract suspend fun listTracks(input: ListTracksRequest = ListTracksRequest { }): ListTracksResponse

List the Amazon Redshift Serverless versions.

listUsageLimits

abstract suspend fun listUsageLimits(input: ListUsageLimitsRequest = ListUsageLimitsRequest { }): ListUsageLimitsResponse

Lists all usage limits within Amazon Redshift Serverless.

listWorkgroups

abstract suspend fun listWorkgroups(input: ListWorkgroupsRequest = ListWorkgroupsRequest { }): ListWorkgroupsResponse

Returns information about a list of specified workgroups.

putResourcePolicy

abstract suspend fun putResourcePolicy(input: PutResourcePolicyRequest): PutResourcePolicyResponse

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

restoreFromRecoveryPoint

abstract suspend fun restoreFromRecoveryPoint(input: RestoreFromRecoveryPointRequest): RestoreFromRecoveryPointResponse

Restore the data from a recovery point.

restoreFromSnapshot

abstract suspend fun restoreFromSnapshot(input: RestoreFromSnapshotRequest): RestoreFromSnapshotResponse

Restores a namespace from a snapshot.

restoreTableFromRecoveryPoint

abstract suspend fun restoreTableFromRecoveryPoint(input: RestoreTableFromRecoveryPointRequest): RestoreTableFromRecoveryPointResponse

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.

restoreTableFromSnapshot

abstract suspend fun restoreTableFromSnapshot(input: RestoreTableFromSnapshotRequest): RestoreTableFromSnapshotResponse

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.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Assigns one or more tags to a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag or set of tags from a resource.

updateCustomDomainAssociation

abstract suspend fun updateCustomDomainAssociation(input: UpdateCustomDomainAssociationRequest): UpdateCustomDomainAssociationResponse

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

updateEndpointAccess

abstract suspend fun updateEndpointAccess(input: UpdateEndpointAccessRequest): UpdateEndpointAccessResponse

Updates an Amazon Redshift Serverless managed endpoint.

updateNamespace

abstract suspend fun updateNamespace(input: UpdateNamespaceRequest): UpdateNamespaceResponse

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.

updateScheduledAction

abstract suspend fun updateScheduledAction(input: UpdateScheduledActionRequest): UpdateScheduledActionResponse

Updates a scheduled action.

updateSnapshot

abstract suspend fun updateSnapshot(input: UpdateSnapshotRequest): UpdateSnapshotResponse

Updates a snapshot.

updateSnapshotCopyConfiguration

abstract suspend fun updateSnapshotCopyConfiguration(input: UpdateSnapshotCopyConfigurationRequest): UpdateSnapshotCopyConfigurationResponse

Updates a snapshot copy configuration.

updateUsageLimit

abstract suspend fun updateUsageLimit(input: UpdateUsageLimitRequest): UpdateUsageLimitResponse

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

updateWorkgroup

abstract suspend fun updateWorkgroup(input: UpdateWorkgroupRequest): UpdateWorkgroupResponse

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

expect abstract fun close()

convertRecoveryPointToSnapshot

inline suspend fun RedshiftServerlessClient.convertRecoveryPointToSnapshot(crossinline block: ConvertRecoveryPointToSnapshotRequest.Builder.() -> Unit): ConvertRecoveryPointToSnapshotResponse

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

createCustomDomainAssociation

inline suspend fun RedshiftServerlessClient.createCustomDomainAssociation(crossinline block: CreateCustomDomainAssociationRequest.Builder.() -> Unit): CreateCustomDomainAssociationResponse

Creates a custom domain association for Amazon Redshift Serverless.

createEndpointAccess

inline suspend fun RedshiftServerlessClient.createEndpointAccess(crossinline block: CreateEndpointAccessRequest.Builder.() -> Unit): CreateEndpointAccessResponse

Creates an Amazon Redshift Serverless managed VPC endpoint.

createNamespace

inline suspend fun RedshiftServerlessClient.createNamespace(crossinline block: CreateNamespaceRequest.Builder.() -> Unit): CreateNamespaceResponse

Creates a namespace in Amazon Redshift Serverless.

createReservation

inline suspend fun RedshiftServerlessClient.createReservation(crossinline block: CreateReservationRequest.Builder.() -> Unit): CreateReservationResponse

createScheduledAction

inline suspend fun RedshiftServerlessClient.createScheduledAction(crossinline block: CreateScheduledActionRequest.Builder.() -> Unit): CreateScheduledActionResponse

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.

createSnapshot

inline suspend fun RedshiftServerlessClient.createSnapshot(crossinline block: CreateSnapshotRequest.Builder.() -> Unit): CreateSnapshotResponse

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

createSnapshotCopyConfiguration

inline suspend fun RedshiftServerlessClient.createSnapshotCopyConfiguration(crossinline block: CreateSnapshotCopyConfigurationRequest.Builder.() -> Unit): CreateSnapshotCopyConfigurationResponse

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

createUsageLimit

inline suspend fun RedshiftServerlessClient.createUsageLimit(crossinline block: CreateUsageLimitRequest.Builder.() -> Unit): CreateUsageLimitResponse

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

createWorkgroup

inline suspend fun RedshiftServerlessClient.createWorkgroup(crossinline block: CreateWorkgroupRequest.Builder.() -> Unit): CreateWorkgroupResponse

Creates an workgroup in Amazon Redshift Serverless.

deleteCustomDomainAssociation

inline suspend fun RedshiftServerlessClient.deleteCustomDomainAssociation(crossinline block: DeleteCustomDomainAssociationRequest.Builder.() -> Unit): DeleteCustomDomainAssociationResponse

Deletes a custom domain association for Amazon Redshift Serverless.

deleteEndpointAccess

inline suspend fun RedshiftServerlessClient.deleteEndpointAccess(crossinline block: DeleteEndpointAccessRequest.Builder.() -> Unit): DeleteEndpointAccessResponse

Deletes an Amazon Redshift Serverless managed VPC endpoint.

deleteNamespace

inline suspend fun RedshiftServerlessClient.deleteNamespace(crossinline block: DeleteNamespaceRequest.Builder.() -> Unit): DeleteNamespaceResponse

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.

deleteResourcePolicy

inline suspend fun RedshiftServerlessClient.deleteResourcePolicy(crossinline block: DeleteResourcePolicyRequest.Builder.() -> Unit): DeleteResourcePolicyResponse

Deletes the specified resource policy.

deleteScheduledAction

inline suspend fun RedshiftServerlessClient.deleteScheduledAction(crossinline block: DeleteScheduledActionRequest.Builder.() -> Unit): DeleteScheduledActionResponse

Deletes a scheduled action.

deleteSnapshot

inline suspend fun RedshiftServerlessClient.deleteSnapshot(crossinline block: DeleteSnapshotRequest.Builder.() -> Unit): DeleteSnapshotResponse

Deletes a snapshot from Amazon Redshift Serverless.

deleteSnapshotCopyConfiguration

inline suspend fun RedshiftServerlessClient.deleteSnapshotCopyConfiguration(crossinline block: DeleteSnapshotCopyConfigurationRequest.Builder.() -> Unit): DeleteSnapshotCopyConfigurationResponse

Deletes a snapshot copy configuration

deleteUsageLimit

inline suspend fun RedshiftServerlessClient.deleteUsageLimit(crossinline block: DeleteUsageLimitRequest.Builder.() -> Unit): DeleteUsageLimitResponse

Deletes a usage limit from Amazon Redshift Serverless.

deleteWorkgroup

inline suspend fun RedshiftServerlessClient.deleteWorkgroup(crossinline block: DeleteWorkgroupRequest.Builder.() -> Unit): DeleteWorkgroupResponse

Deletes a workgroup.

getCredentials

inline suspend fun RedshiftServerlessClient.getCredentials(crossinline block: GetCredentialsRequest.Builder.() -> Unit): GetCredentialsResponse

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

getCustomDomainAssociation

inline suspend fun RedshiftServerlessClient.getCustomDomainAssociation(crossinline block: GetCustomDomainAssociationRequest.Builder.() -> Unit): GetCustomDomainAssociationResponse

Gets information about a specific custom domain association.

getEndpointAccess

inline suspend fun RedshiftServerlessClient.getEndpointAccess(crossinline block: GetEndpointAccessRequest.Builder.() -> Unit): GetEndpointAccessResponse

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

getNamespace

inline suspend fun RedshiftServerlessClient.getNamespace(crossinline block: GetNamespaceRequest.Builder.() -> Unit): GetNamespaceResponse

Returns information about a namespace in Amazon Redshift Serverless.

getRecoveryPoint

inline suspend fun RedshiftServerlessClient.getRecoveryPoint(crossinline block: GetRecoveryPointRequest.Builder.() -> Unit): GetRecoveryPointResponse

Returns information about a recovery point.

getReservation

inline suspend fun RedshiftServerlessClient.getReservation(crossinline block: GetReservationRequest.Builder.() -> Unit): GetReservationResponse

getReservationOffering

inline suspend fun RedshiftServerlessClient.getReservationOffering(crossinline block: GetReservationOfferingRequest.Builder.() -> Unit): GetReservationOfferingResponse

Returns the reservation offering. The offering determines the payment schedule for the reservation.

getResourcePolicy

inline suspend fun RedshiftServerlessClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Returns a resource policy.

getScheduledAction

inline suspend fun RedshiftServerlessClient.getScheduledAction(crossinline block: GetScheduledActionRequest.Builder.() -> Unit): GetScheduledActionResponse

Returns information about a scheduled action.

getSnapshot

inline suspend fun RedshiftServerlessClient.getSnapshot(crossinline block: GetSnapshotRequest.Builder.() -> Unit): GetSnapshotResponse

Returns information about a specific snapshot.

getTableRestoreStatus

inline suspend fun RedshiftServerlessClient.getTableRestoreStatus(crossinline block: GetTableRestoreStatusRequest.Builder.() -> Unit): GetTableRestoreStatusResponse

Returns information about a TableRestoreStatus object.

getTrack

inline suspend fun RedshiftServerlessClient.getTrack(crossinline block: GetTrackRequest.Builder.() -> Unit): GetTrackResponse

Get the Redshift Serverless version for a specified track.

getUsageLimit

inline suspend fun RedshiftServerlessClient.getUsageLimit(crossinline block: GetUsageLimitRequest.Builder.() -> Unit): GetUsageLimitResponse

Returns information about a usage limit.

getWorkgroup

inline suspend fun RedshiftServerlessClient.getWorkgroup(crossinline block: GetWorkgroupRequest.Builder.() -> Unit): GetWorkgroupResponse

Returns information about a specific workgroup.

listCustomDomainAssociations

inline suspend fun RedshiftServerlessClient.listCustomDomainAssociations(crossinline block: ListCustomDomainAssociationsRequest.Builder.() -> Unit): ListCustomDomainAssociationsResponse

Lists custom domain associations for Amazon Redshift Serverless.

listCustomDomainAssociationsPaginated

fun RedshiftServerlessClient.listCustomDomainAssociationsPaginated(initialRequest: ListCustomDomainAssociationsRequest = ListCustomDomainAssociationsRequest { }): Flow<ListCustomDomainAssociationsResponse>

fun RedshiftServerlessClient.listCustomDomainAssociationsPaginated(block: ListCustomDomainAssociationsRequest.Builder.() -> Unit): Flow<ListCustomDomainAssociationsResponse>

Paginate over ListCustomDomainAssociationsResponse results.

listEndpointAccess

inline suspend fun RedshiftServerlessClient.listEndpointAccess(crossinline block: ListEndpointAccessRequest.Builder.() -> Unit): ListEndpointAccessResponse

Returns an array of EndpointAccess objects and relevant information.

listEndpointAccessPaginated

fun RedshiftServerlessClient.listEndpointAccessPaginated(initialRequest: ListEndpointAccessRequest = ListEndpointAccessRequest { }): Flow<ListEndpointAccessResponse>

fun RedshiftServerlessClient.listEndpointAccessPaginated(block: ListEndpointAccessRequest.Builder.() -> Unit): Flow<ListEndpointAccessResponse>

Paginate over ListEndpointAccessResponse results.

listManagedWorkgroups

inline suspend fun RedshiftServerlessClient.listManagedWorkgroups(crossinline block: ListManagedWorkgroupsRequest.Builder.() -> Unit): ListManagedWorkgroupsResponse

Returns information about a list of specified managed workgroups in your account.

listManagedWorkgroupsPaginated

fun RedshiftServerlessClient.listManagedWorkgroupsPaginated(initialRequest: ListManagedWorkgroupsRequest = ListManagedWorkgroupsRequest { }): Flow<ListManagedWorkgroupsResponse>

fun RedshiftServerlessClient.listManagedWorkgroupsPaginated(block: ListManagedWorkgroupsRequest.Builder.() -> Unit): Flow<ListManagedWorkgroupsResponse>

Paginate over ListManagedWorkgroupsResponse results.

listNamespaces

inline suspend fun RedshiftServerlessClient.listNamespaces(crossinline block: ListNamespacesRequest.Builder.() -> Unit): ListNamespacesResponse

Returns information about a list of specified namespaces.

listNamespacesPaginated

fun RedshiftServerlessClient.listNamespacesPaginated(initialRequest: ListNamespacesRequest = ListNamespacesRequest { }): Flow<ListNamespacesResponse>

fun RedshiftServerlessClient.listNamespacesPaginated(block: ListNamespacesRequest.Builder.() -> Unit): Flow<ListNamespacesResponse>

Paginate over ListNamespacesResponse results.

listRecoveryPoints

inline suspend fun RedshiftServerlessClient.listRecoveryPoints(crossinline block: ListRecoveryPointsRequest.Builder.() -> Unit): ListRecoveryPointsResponse

Returns an array of recovery points.

listRecoveryPointsPaginated

fun RedshiftServerlessClient.listRecoveryPointsPaginated(initialRequest: ListRecoveryPointsRequest = ListRecoveryPointsRequest { }): Flow<ListRecoveryPointsResponse>

fun RedshiftServerlessClient.listRecoveryPointsPaginated(block: ListRecoveryPointsRequest.Builder.() -> Unit): Flow<ListRecoveryPointsResponse>

Paginate over ListRecoveryPointsResponse results.

listReservationOfferings

inline suspend fun RedshiftServerlessClient.listReservationOfferings(crossinline block: ListReservationOfferingsRequest.Builder.() -> Unit): ListReservationOfferingsResponse

Returns the current reservation offerings in your account.

listReservationOfferingsPaginated

fun RedshiftServerlessClient.listReservationOfferingsPaginated(initialRequest: ListReservationOfferingsRequest = ListReservationOfferingsRequest { }): Flow<ListReservationOfferingsResponse>

fun RedshiftServerlessClient.listReservationOfferingsPaginated(block: ListReservationOfferingsRequest.Builder.() -> Unit): Flow<ListReservationOfferingsResponse>

Paginate over ListReservationOfferingsResponse results.

listReservations

inline suspend fun RedshiftServerlessClient.listReservations(crossinline block: ListReservationsRequest.Builder.() -> Unit): ListReservationsResponse

Returns a list of Reservation objects.

listReservationsPaginated

fun RedshiftServerlessClient.listReservationsPaginated(initialRequest: ListReservationsRequest = ListReservationsRequest { }): Flow<ListReservationsResponse>

fun RedshiftServerlessClient.listReservationsPaginated(block: ListReservationsRequest.Builder.() -> Unit): Flow<ListReservationsResponse>

Paginate over ListReservationsResponse results.

listScheduledActions

inline suspend fun RedshiftServerlessClient.listScheduledActions(crossinline block: ListScheduledActionsRequest.Builder.() -> Unit): ListScheduledActionsResponse

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

listScheduledActionsPaginated

fun RedshiftServerlessClient.listScheduledActionsPaginated(initialRequest: ListScheduledActionsRequest = ListScheduledActionsRequest { }): Flow<ListScheduledActionsResponse>

fun RedshiftServerlessClient.listScheduledActionsPaginated(block: ListScheduledActionsRequest.Builder.() -> Unit): Flow<ListScheduledActionsResponse>

Paginate over ListScheduledActionsResponse results.

listSnapshotCopyConfigurations

inline suspend fun RedshiftServerlessClient.listSnapshotCopyConfigurations(crossinline block: ListSnapshotCopyConfigurationsRequest.Builder.() -> Unit): ListSnapshotCopyConfigurationsResponse

Returns a list of snapshot copy configurations.

listSnapshotCopyConfigurationsPaginated

fun RedshiftServerlessClient.listSnapshotCopyConfigurationsPaginated(initialRequest: ListSnapshotCopyConfigurationsRequest = ListSnapshotCopyConfigurationsRequest { }): Flow<ListSnapshotCopyConfigurationsResponse>

fun RedshiftServerlessClient.listSnapshotCopyConfigurationsPaginated(block: ListSnapshotCopyConfigurationsRequest.Builder.() -> Unit): Flow<ListSnapshotCopyConfigurationsResponse>

Paginate over ListSnapshotCopyConfigurationsResponse results.

listSnapshots

inline suspend fun RedshiftServerlessClient.listSnapshots(crossinline block: ListSnapshotsRequest.Builder.() -> Unit): ListSnapshotsResponse

Returns a list of snapshots.

listSnapshotsPaginated

fun RedshiftServerlessClient.listSnapshotsPaginated(initialRequest: ListSnapshotsRequest = ListSnapshotsRequest { }): Flow<ListSnapshotsResponse>

fun RedshiftServerlessClient.listSnapshotsPaginated(block: ListSnapshotsRequest.Builder.() -> Unit): Flow<ListSnapshotsResponse>

Paginate over ListSnapshotsResponse results.

listTableRestoreStatus

inline suspend fun RedshiftServerlessClient.listTableRestoreStatus(crossinline block: ListTableRestoreStatusRequest.Builder.() -> Unit): ListTableRestoreStatusResponse

Returns information about an array of TableRestoreStatus objects.

listTableRestoreStatusPaginated

fun RedshiftServerlessClient.listTableRestoreStatusPaginated(initialRequest: ListTableRestoreStatusRequest = ListTableRestoreStatusRequest { }): Flow<ListTableRestoreStatusResponse>

fun RedshiftServerlessClient.listTableRestoreStatusPaginated(block: ListTableRestoreStatusRequest.Builder.() -> Unit): Flow<ListTableRestoreStatusResponse>

Paginate over ListTableRestoreStatusResponse results.

listTagsForResource

inline suspend fun RedshiftServerlessClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags assigned to a resource.

listTracks

inline suspend fun RedshiftServerlessClient.listTracks(crossinline block: ListTracksRequest.Builder.() -> Unit): ListTracksResponse

List the Amazon Redshift Serverless versions.

listTracksPaginated

fun RedshiftServerlessClient.listTracksPaginated(initialRequest: ListTracksRequest = ListTracksRequest { }): Flow<ListTracksResponse>

fun RedshiftServerlessClient.listTracksPaginated(block: ListTracksRequest.Builder.() -> Unit): Flow<ListTracksResponse>

Paginate over ListTracksResponse results.

listUsageLimits

inline suspend fun RedshiftServerlessClient.listUsageLimits(crossinline block: ListUsageLimitsRequest.Builder.() -> Unit): ListUsageLimitsResponse

Lists all usage limits within Amazon Redshift Serverless.

listUsageLimitsPaginated

fun RedshiftServerlessClient.listUsageLimitsPaginated(initialRequest: ListUsageLimitsRequest = ListUsageLimitsRequest { }): Flow<ListUsageLimitsResponse>

fun RedshiftServerlessClient.listUsageLimitsPaginated(block: ListUsageLimitsRequest.Builder.() -> Unit): Flow<ListUsageLimitsResponse>

Paginate over ListUsageLimitsResponse results.

listWorkgroups

inline suspend fun RedshiftServerlessClient.listWorkgroups(crossinline block: ListWorkgroupsRequest.Builder.() -> Unit): ListWorkgroupsResponse

Returns information about a list of specified workgroups.

listWorkgroupsPaginated

fun RedshiftServerlessClient.listWorkgroupsPaginated(initialRequest: ListWorkgroupsRequest = ListWorkgroupsRequest { }): Flow<ListWorkgroupsResponse>

fun RedshiftServerlessClient.listWorkgroupsPaginated(block: ListWorkgroupsRequest.Builder.() -> Unit): Flow<ListWorkgroupsResponse>

Paginate over ListWorkgroupsResponse results.

putResourcePolicy

inline suspend fun RedshiftServerlessClient.putResourcePolicy(crossinline block: PutResourcePolicyRequest.Builder.() -> Unit): PutResourcePolicyResponse

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

restoreFromRecoveryPoint

inline suspend fun RedshiftServerlessClient.restoreFromRecoveryPoint(crossinline block: RestoreFromRecoveryPointRequest.Builder.() -> Unit): RestoreFromRecoveryPointResponse

Restore the data from a recovery point.

restoreFromSnapshot

inline suspend fun RedshiftServerlessClient.restoreFromSnapshot(crossinline block: RestoreFromSnapshotRequest.Builder.() -> Unit): RestoreFromSnapshotResponse

Restores a namespace from a snapshot.

restoreTableFromRecoveryPoint

inline suspend fun RedshiftServerlessClient.restoreTableFromRecoveryPoint(crossinline block: RestoreTableFromRecoveryPointRequest.Builder.() -> Unit): RestoreTableFromRecoveryPointResponse

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.

restoreTableFromSnapshot

inline suspend fun RedshiftServerlessClient.restoreTableFromSnapshot(crossinline block: RestoreTableFromSnapshotRequest.Builder.() -> Unit): RestoreTableFromSnapshotResponse

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.

tagResource

inline suspend fun RedshiftServerlessClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns one or more tags to a resource.

untagResource

inline suspend fun RedshiftServerlessClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag or set of tags from a resource.

updateCustomDomainAssociation

inline suspend fun RedshiftServerlessClient.updateCustomDomainAssociation(crossinline block: UpdateCustomDomainAssociationRequest.Builder.() -> Unit): UpdateCustomDomainAssociationResponse

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

updateEndpointAccess

inline suspend fun RedshiftServerlessClient.updateEndpointAccess(crossinline block: UpdateEndpointAccessRequest.Builder.() -> Unit): UpdateEndpointAccessResponse

Updates an Amazon Redshift Serverless managed endpoint.

updateNamespace

inline suspend fun RedshiftServerlessClient.updateNamespace(crossinline block: UpdateNamespaceRequest.Builder.() -> Unit): UpdateNamespaceResponse

updateScheduledAction

inline suspend fun RedshiftServerlessClient.updateScheduledAction(crossinline block: UpdateScheduledActionRequest.Builder.() -> Unit): UpdateScheduledActionResponse

Updates a scheduled action.

updateSnapshot

inline suspend fun RedshiftServerlessClient.updateSnapshot(crossinline block: UpdateSnapshotRequest.Builder.() -> Unit): UpdateSnapshotResponse

Updates a snapshot.

updateSnapshotCopyConfiguration

inline suspend fun RedshiftServerlessClient.updateSnapshotCopyConfiguration(crossinline block: UpdateSnapshotCopyConfigurationRequest.Builder.() -> Unit): UpdateSnapshotCopyConfigurationResponse

Updates a snapshot copy configuration.

updateUsageLimit

inline suspend fun RedshiftServerlessClient.updateUsageLimit(crossinline block: UpdateUsageLimitRequest.Builder.() -> Unit): UpdateUsageLimitResponse

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

updateWorkgroup

inline suspend fun RedshiftServerlessClient.updateWorkgroup(crossinline block: UpdateWorkgroupRequest.Builder.() -> Unit): UpdateWorkgroupResponse

withConfig

fun RedshiftServerlessClient.withConfig(block: RedshiftServerlessClient.Config.Builder.() -> Unit): RedshiftServerlessClient

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.