@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRedshiftServerless
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSRedshiftServerless
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
ConvertRecoveryPointToSnapshotResult |
convertRecoveryPointToSnapshot(ConvertRecoveryPointToSnapshotRequest convertRecoveryPointToSnapshotRequest)
Converts a recovery point to a snapshot.
|
CreateEndpointAccessResult |
createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest)
Creates an Amazon Redshift Serverless managed VPC endpoint.
|
CreateNamespaceResult |
createNamespace(CreateNamespaceRequest createNamespaceRequest)
Creates a namespace in Amazon Redshift Serverless.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of all databases in a namespace.
|
CreateUsageLimitResult |
createUsageLimit(CreateUsageLimitRequest createUsageLimitRequest)
Creates a usage limit for a specified Amazon Redshift Serverless usage type.
|
CreateWorkgroupResult |
createWorkgroup(CreateWorkgroupRequest createWorkgroupRequest)
Creates an workgroup in Amazon Redshift Serverless.
|
DeleteEndpointAccessResult |
deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest)
Deletes an Amazon Redshift Serverless managed VPC endpoint.
|
DeleteNamespaceResult |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace from Amazon Redshift Serverless.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the specified resource policy.
|
DeleteSnapshotResult |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a snapshot from Amazon Redshift Serverless.
|
DeleteUsageLimitResult |
deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest)
Deletes a usage limit from Amazon Redshift Serverless.
|
DeleteWorkgroupResult |
deleteWorkgroup(DeleteWorkgroupRequest deleteWorkgroupRequest)
Deletes a workgroup.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCredentialsResult |
getCredentials(GetCredentialsRequest getCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift
Serverless.
|
GetEndpointAccessResult |
getEndpointAccess(GetEndpointAccessRequest getEndpointAccessRequest)
Returns information, such as the name, about a VPC endpoint.
|
GetNamespaceResult |
getNamespace(GetNamespaceRequest getNamespaceRequest)
Returns information about a namespace in Amazon Redshift Serverless.
|
GetRecoveryPointResult |
getRecoveryPoint(GetRecoveryPointRequest getRecoveryPointRequest)
Returns information about a recovery point.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Returns a resource policy.
|
GetSnapshotResult |
getSnapshot(GetSnapshotRequest getSnapshotRequest)
Returns information about a specific snapshot.
|
GetUsageLimitResult |
getUsageLimit(GetUsageLimitRequest getUsageLimitRequest)
Returns information about a usage limit.
|
GetWorkgroupResult |
getWorkgroup(GetWorkgroupRequest getWorkgroupRequest)
Returns information about a specific workgroup.
|
ListEndpointAccessResult |
listEndpointAccess(ListEndpointAccessRequest listEndpointAccessRequest)
Returns an array of
EndpointAccess objects and relevant information. |
ListNamespacesResult |
listNamespaces(ListNamespacesRequest listNamespacesRequest)
Returns information about a list of specified namespaces.
|
ListRecoveryPointsResult |
listRecoveryPoints(ListRecoveryPointsRequest listRecoveryPointsRequest)
Returns an array of recovery points.
|
ListSnapshotsResult |
listSnapshots(ListSnapshotsRequest listSnapshotsRequest)
Returns a list of snapshots.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
ListUsageLimitsResult |
listUsageLimits(ListUsageLimitsRequest listUsageLimitsRequest)
Lists all usage limits within Amazon Redshift Serverless.
|
ListWorkgroupsResult |
listWorkgroups(ListWorkgroupsRequest listWorkgroupsRequest)
Returns information about a list of specified workgroups.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a resource policy.
|
RestoreFromRecoveryPointResult |
restoreFromRecoveryPoint(RestoreFromRecoveryPointRequest restoreFromRecoveryPointRequest)
Restore the data from a recovery point.
|
RestoreFromSnapshotResult |
restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a namespace from a snapshot.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or set of tags from a resource.
|
UpdateEndpointAccessResult |
updateEndpointAccess(UpdateEndpointAccessRequest updateEndpointAccessRequest)
Updates an Amazon Redshift Serverless managed endpoint.
|
UpdateNamespaceResult |
updateNamespace(UpdateNamespaceRequest updateNamespaceRequest)
Updates a namespace with the specified settings.
|
UpdateSnapshotResult |
updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates a snapshot.
|
UpdateUsageLimitResult |
updateUsageLimit(UpdateUsageLimitRequest updateUsageLimitRequest)
Update a usage limit in Amazon Redshift Serverless.
|
UpdateWorkgroupResult |
updateWorkgroup(UpdateWorkgroupRequest updateWorkgroupRequest)
Updates a workgroup with the specified configuration settings.
|
static final String ENDPOINT_PREFIX
ConvertRecoveryPointToSnapshotResult convertRecoveryPointToSnapshot(ConvertRecoveryPointToSnapshotRequest convertRecoveryPointToSnapshotRequest)
Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
convertRecoveryPointToSnapshotRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ServiceQuotaExceededException
- The service limit was exceeded.CreateEndpointAccessResult createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest)
Creates an Amazon Redshift Serverless managed VPC endpoint.
createEndpointAccessRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.ServiceQuotaExceededException
- The service limit was exceeded.CreateNamespaceResult createNamespace(CreateNamespaceRequest createNamespaceRequest)
Creates a namespace in Amazon Redshift Serverless.
createNamespaceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.TooManyTagsException
- The request exceeded the number of tags allowed for a resource.CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
createSnapshotRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ServiceQuotaExceededException
- The service limit was exceeded.CreateUsageLimitResult createUsageLimit(CreateUsageLimitRequest createUsageLimitRequest)
Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
createUsageLimitRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ServiceQuotaExceededException
- The service limit was exceeded.CreateWorkgroupResult createWorkgroup(CreateWorkgroupRequest createWorkgroupRequest)
Creates an workgroup in Amazon Redshift Serverless.
createWorkgroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.InsufficientCapacityException
- There is an insufficient capacity to perform the action.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.TooManyTagsException
- The request exceeded the number of tags allowed for a resource.DeleteEndpointAccessResult deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest)
Deletes an Amazon Redshift Serverless managed VPC endpoint.
deleteEndpointAccessRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
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.
deleteNamespaceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the specified resource policy.
deleteResourcePolicyRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a snapshot from Amazon Redshift Serverless.
deleteSnapshotRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.DeleteUsageLimitResult deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest)
Deletes a usage limit from Amazon Redshift Serverless.
deleteUsageLimitRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.DeleteWorkgroupResult deleteWorkgroup(DeleteWorkgroupRequest deleteWorkgroupRequest)
Deletes a workgroup.
deleteWorkgroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetCredentialsResult getCredentials(GetCredentialsRequest getCredentialsRequest)
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).
<p> 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. </p> <p> If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>
getCredentialsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetEndpointAccessResult getEndpointAccess(GetEndpointAccessRequest getEndpointAccessRequest)
Returns information, such as the name, about a VPC endpoint.
getEndpointAccessRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetNamespaceResult getNamespace(GetNamespaceRequest getNamespaceRequest)
Returns information about a namespace in Amazon Redshift Serverless.
getNamespaceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetRecoveryPointResult getRecoveryPoint(GetRecoveryPointRequest getRecoveryPointRequest)
Returns information about a recovery point.
getRecoveryPointRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Returns a resource policy.
getResourcePolicyRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetSnapshotResult getSnapshot(GetSnapshotRequest getSnapshotRequest)
Returns information about a specific snapshot.
getSnapshotRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetUsageLimitResult getUsageLimit(GetUsageLimitRequest getUsageLimitRequest)
Returns information about a usage limit.
getUsageLimitRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.GetWorkgroupResult getWorkgroup(GetWorkgroupRequest getWorkgroupRequest)
Returns information about a specific workgroup.
getWorkgroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ListEndpointAccessResult listEndpointAccess(ListEndpointAccessRequest listEndpointAccessRequest)
Returns an array of EndpointAccess
objects and relevant information.
listEndpointAccessRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ListNamespacesResult listNamespaces(ListNamespacesRequest listNamespacesRequest)
Returns information about a list of specified namespaces.
listNamespacesRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ListRecoveryPointsResult listRecoveryPoints(ListRecoveryPointsRequest listRecoveryPointsRequest)
Returns an array of recovery points.
listRecoveryPointsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ListSnapshotsResult listSnapshots(ListSnapshotsRequest listSnapshotsRequest)
Returns a list of snapshots.
listSnapshotsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
listTagsForResourceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.ListUsageLimitsResult listUsageLimits(ListUsageLimitsRequest listUsageLimitsRequest)
Lists all usage limits within Amazon Redshift Serverless.
listUsageLimitsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.InvalidPaginationException
- The provided pagination token is invalid.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ListWorkgroupsResult listWorkgroups(ListWorkgroupsRequest listWorkgroupsRequest)
Returns information about a list of specified workgroups.
listWorkgroupsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
putResourcePolicyRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ServiceQuotaExceededException
- The service limit was exceeded.RestoreFromRecoveryPointResult restoreFromRecoveryPoint(RestoreFromRecoveryPointRequest restoreFromRecoveryPointRequest)
Restore the data from a recovery point.
restoreFromRecoveryPointRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a namespace from a snapshot.
restoreFromSnapshotRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ServiceQuotaExceededException
- The service limit was exceeded.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags to a resource.
tagResourceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.TooManyTagsException
- The request exceeded the number of tags allowed for a resource.ThrottlingException
- The request was denied due to request throttling.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or set of tags from a resource.
untagResourceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.UpdateEndpointAccessResult updateEndpointAccess(UpdateEndpointAccessRequest updateEndpointAccessRequest)
Updates an Amazon Redshift Serverless managed endpoint.
updateEndpointAccessRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.UpdateNamespaceResult updateNamespace(UpdateNamespaceRequest updateNamespaceRequest)
Updates a namespace with the specified settings.
updateNamespaceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.UpdateSnapshotResult updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates a snapshot.
updateSnapshotRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.UpdateUsageLimitResult updateUsageLimit(UpdateUsageLimitRequest updateUsageLimitRequest)
Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
updateUsageLimitRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.UpdateWorkgroupResult updateWorkgroup(UpdateWorkgroupRequest updateWorkgroupRequest)
Updates a workgroup with the specified configuration settings.
updateWorkgroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.InsufficientCapacityException
- There is an insufficient capacity to perform the action.ResourceNotFoundException
- The resource could not be found.ConflictException
- The submitted action has conflicts.ValidationException
- The input failed to satisfy the constraints specified by an AWS service.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.