com.amazonaws.services.redshiftserverless

Class AWSRedshiftServerlessClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.redshiftserverless.AWSRedshiftServerlessClient

All Implemented Interfaces:

AWSRedshiftServerless

Direct Known Subclasses:

AWSRedshiftServerlessAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSRedshiftServerlessClient
extends AmazonWebServiceClient
implements AWSRedshiftServerless

Client for accessing Redshift Serverless. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.redshiftserverless.AWSRedshiftServerless

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSRedshiftServerlessClientBuilder	builder()
ConvertRecoveryPointToSnapshotResult	convertRecoveryPointToSnapshot(ConvertRecoveryPointToSnapshotRequest request) Converts a recovery point to a snapshot.
CreateCustomDomainAssociationResult	createCustomDomainAssociation(CreateCustomDomainAssociationRequest request) Creates a custom domain association for Amazon Redshift Serverless.
CreateEndpointAccessResult	createEndpointAccess(CreateEndpointAccessRequest request) Creates an Amazon Redshift Serverless managed VPC endpoint.
CreateNamespaceResult	createNamespace(CreateNamespaceRequest request) Creates a namespace in Amazon Redshift Serverless.
CreateScheduledActionResult	createScheduledAction(CreateScheduledActionRequest request) Creates a scheduled action.
CreateSnapshotResult	createSnapshot(CreateSnapshotRequest request) Creates a snapshot of all databases in a namespace.
CreateSnapshotCopyConfigurationResult	createSnapshotCopyConfiguration(CreateSnapshotCopyConfigurationRequest request) Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
CreateUsageLimitResult	createUsageLimit(CreateUsageLimitRequest request) Creates a usage limit for a specified Amazon Redshift Serverless usage type.
CreateWorkgroupResult	createWorkgroup(CreateWorkgroupRequest request) Creates an workgroup in Amazon Redshift Serverless.
DeleteCustomDomainAssociationResult	deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest request) Deletes a custom domain association for Amazon Redshift Serverless.
DeleteEndpointAccessResult	deleteEndpointAccess(DeleteEndpointAccessRequest request) Deletes an Amazon Redshift Serverless managed VPC endpoint.
DeleteNamespaceResult	deleteNamespace(DeleteNamespaceRequest request) Deletes a namespace from Amazon Redshift Serverless.
DeleteResourcePolicyResult	deleteResourcePolicy(DeleteResourcePolicyRequest request) Deletes the specified resource policy.
DeleteScheduledActionResult	deleteScheduledAction(DeleteScheduledActionRequest request) Deletes a scheduled action.
DeleteSnapshotResult	deleteSnapshot(DeleteSnapshotRequest request) Deletes a snapshot from Amazon Redshift Serverless.
DeleteSnapshotCopyConfigurationResult	deleteSnapshotCopyConfiguration(DeleteSnapshotCopyConfigurationRequest request) Deletes a snapshot copy configuration
DeleteUsageLimitResult	deleteUsageLimit(DeleteUsageLimitRequest request) Deletes a usage limit from Amazon Redshift Serverless.
DeleteWorkgroupResult	deleteWorkgroup(DeleteWorkgroupRequest request) 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 request) Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
GetCustomDomainAssociationResult	getCustomDomainAssociation(GetCustomDomainAssociationRequest request) Gets information about a specific custom domain association.
GetEndpointAccessResult	getEndpointAccess(GetEndpointAccessRequest request) Returns information, such as the name, about a VPC endpoint.
GetNamespaceResult	getNamespace(GetNamespaceRequest request) Returns information about a namespace in Amazon Redshift Serverless.
GetRecoveryPointResult	getRecoveryPoint(GetRecoveryPointRequest request) Returns information about a recovery point.
GetResourcePolicyResult	getResourcePolicy(GetResourcePolicyRequest request) Returns a resource policy.
GetScheduledActionResult	getScheduledAction(GetScheduledActionRequest request) Returns information about a scheduled action.
GetSnapshotResult	getSnapshot(GetSnapshotRequest request) Returns information about a specific snapshot.
GetTableRestoreStatusResult	getTableRestoreStatus(GetTableRestoreStatusRequest request) Returns information about a TableRestoreStatus object.
GetUsageLimitResult	getUsageLimit(GetUsageLimitRequest request) Returns information about a usage limit.
GetWorkgroupResult	getWorkgroup(GetWorkgroupRequest request) Returns information about a specific workgroup.
ListCustomDomainAssociationsResult	listCustomDomainAssociations(ListCustomDomainAssociationsRequest request) Lists custom domain associations for Amazon Redshift Serverless.
ListEndpointAccessResult	listEndpointAccess(ListEndpointAccessRequest request) Returns an array of EndpointAccess objects and relevant information.
ListNamespacesResult	listNamespaces(ListNamespacesRequest request) Returns information about a list of specified namespaces.
ListRecoveryPointsResult	listRecoveryPoints(ListRecoveryPointsRequest request) Returns an array of recovery points.
ListScheduledActionsResult	listScheduledActions(ListScheduledActionsRequest request) Returns a list of scheduled actions.
ListSnapshotCopyConfigurationsResult	listSnapshotCopyConfigurations(ListSnapshotCopyConfigurationsRequest request) Returns a list of snapshot copy configurations.
ListSnapshotsResult	listSnapshots(ListSnapshotsRequest request) Returns a list of snapshots.
ListTableRestoreStatusResult	listTableRestoreStatus(ListTableRestoreStatusRequest request) Returns information about an array of TableRestoreStatus objects.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags assigned to a resource.
ListUsageLimitsResult	listUsageLimits(ListUsageLimitsRequest request) Lists all usage limits within Amazon Redshift Serverless.
ListWorkgroupsResult	listWorkgroups(ListWorkgroupsRequest request) Returns information about a list of specified workgroups.
PutResourcePolicyResult	putResourcePolicy(PutResourcePolicyRequest request) Creates or updates a resource policy.
RestoreFromRecoveryPointResult	restoreFromRecoveryPoint(RestoreFromRecoveryPointRequest request) Restore the data from a recovery point.
RestoreFromSnapshotResult	restoreFromSnapshot(RestoreFromSnapshotRequest request) Restores a namespace from a snapshot.
RestoreTableFromRecoveryPointResult	restoreTableFromRecoveryPoint(RestoreTableFromRecoveryPointRequest request) Restores a table from a recovery point to your Amazon Redshift Serverless instance.
RestoreTableFromSnapshotResult	restoreTableFromSnapshot(RestoreTableFromSnapshotRequest request) Restores a table from a snapshot to your Amazon Redshift Serverless instance.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Assigns one or more tags to a resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag or set of tags from a resource.
UpdateCustomDomainAssociationResult	updateCustomDomainAssociation(UpdateCustomDomainAssociationRequest request) Updates an Amazon Redshift Serverless certificate associated with a custom domain.
UpdateEndpointAccessResult	updateEndpointAccess(UpdateEndpointAccessRequest request) Updates an Amazon Redshift Serverless managed endpoint.
UpdateNamespaceResult	updateNamespace(UpdateNamespaceRequest request) Updates a namespace with the specified settings.
UpdateScheduledActionResult	updateScheduledAction(UpdateScheduledActionRequest request) Updates a scheduled action.
UpdateSnapshotResult	updateSnapshot(UpdateSnapshotRequest request) Updates a snapshot.
UpdateSnapshotCopyConfigurationResult	updateSnapshotCopyConfiguration(UpdateSnapshotCopyConfigurationRequest request) Updates a snapshot copy configuration.
UpdateUsageLimitResult	updateUsageLimit(UpdateUsageLimitRequest request) Update a usage limit in Amazon Redshift Serverless.
UpdateWorkgroupResult	updateWorkgroup(UpdateWorkgroupRequest request) Updates a workgroup with the specified configuration settings.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSRedshiftServerlessClientBuilder builder()

convertRecoveryPointToSnapshot

public ConvertRecoveryPointToSnapshotResult convertRecoveryPointToSnapshot(ConvertRecoveryPointToSnapshotRequest request)

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

Specified by:

convertRecoveryPointToSnapshot in interface AWSRedshiftServerless

Parameters:

convertRecoveryPointToSnapshotRequest -

Returns:

Result of the ConvertRecoveryPointToSnapshot operation returned by the service.

Throws:

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.

TooManyTagsException - The request exceeded the number of tags allowed for a resource.

ServiceQuotaExceededException - The service limit was exceeded.

See Also:

AWS API Documentation

createCustomDomainAssociation

public CreateCustomDomainAssociationResult createCustomDomainAssociation(CreateCustomDomainAssociationRequest request)

Creates a custom domain association for Amazon Redshift Serverless.

Specified by:

createCustomDomainAssociation in interface AWSRedshiftServerless

Parameters:

createCustomDomainAssociationRequest -

Returns:

Result of the CreateCustomDomainAssociation operation returned by the service.

Throws:

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.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createEndpointAccess

public CreateEndpointAccessResult createEndpointAccess(CreateEndpointAccessRequest request)

Creates an Amazon Redshift Serverless managed VPC endpoint.

Specified by:

createEndpointAccess in interface AWSRedshiftServerless

Parameters:

createEndpointAccessRequest -

Returns:

Result of the CreateEndpointAccess operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createNamespace

public CreateNamespaceResult createNamespace(CreateNamespaceRequest request)

Creates a namespace in Amazon Redshift Serverless.

Specified by:

createNamespace in interface AWSRedshiftServerless

Parameters:

createNamespaceRequest -

Returns:

Result of the CreateNamespace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createScheduledAction

public CreateScheduledActionResult createScheduledAction(CreateScheduledActionRequest request)

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.

Specified by:

createScheduledAction in interface AWSRedshiftServerless

Parameters:

createScheduledActionRequest -

Returns:

Result of the CreateScheduledAction operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createSnapshot

public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)

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

Specified by:

createSnapshot in interface AWSRedshiftServerless

Parameters:

createSnapshotRequest -

Returns:

Result of the CreateSnapshot operation returned by the service.

Throws:

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.

TooManyTagsException - The request exceeded the number of tags allowed for a resource.

ServiceQuotaExceededException - The service limit was exceeded.

See Also:

AWS API Documentation

createSnapshotCopyConfiguration

public CreateSnapshotCopyConfigurationResult createSnapshotCopyConfiguration(CreateSnapshotCopyConfigurationRequest request)

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

Specified by:

createSnapshotCopyConfiguration in interface AWSRedshiftServerless

Parameters:

createSnapshotCopyConfigurationRequest -

Returns:

Result of the CreateSnapshotCopyConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createUsageLimit

public CreateUsageLimitResult createUsageLimit(CreateUsageLimitRequest request)

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

Specified by:

createUsageLimit in interface AWSRedshiftServerless

Parameters:

createUsageLimitRequest -

Returns:

Result of the CreateUsageLimit operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createWorkgroup

public CreateWorkgroupResult createWorkgroup(CreateWorkgroupRequest request)

Creates an workgroup in Amazon Redshift Serverless.

Specified by:

createWorkgroup in interface AWSRedshiftServerless

Parameters:

createWorkgroupRequest -

Returns:

Result of the CreateWorkgroup operation returned by the service.

Throws:

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.

Ipv6CidrBlockNotFoundException - There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.

See Also:

AWS API Documentation

deleteCustomDomainAssociation

public DeleteCustomDomainAssociationResult deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest request)

Deletes a custom domain association for Amazon Redshift Serverless.

Specified by:

deleteCustomDomainAssociation in interface AWSRedshiftServerless

Parameters:

deleteCustomDomainAssociationRequest -

Returns:

Result of the DeleteCustomDomainAssociation operation returned by the service.

Throws:

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.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteEndpointAccess

public DeleteEndpointAccessResult deleteEndpointAccess(DeleteEndpointAccessRequest request)

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Specified by:

deleteEndpointAccess in interface AWSRedshiftServerless

Parameters:

deleteEndpointAccessRequest -

Returns:

Result of the DeleteEndpointAccess operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteNamespace

public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)

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.

Specified by:

deleteNamespace in interface AWSRedshiftServerless

Parameters:

deleteNamespaceRequest -

Returns:

Result of the DeleteNamespace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteResourcePolicy

public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)

Deletes the specified resource policy.

Specified by:

deleteResourcePolicy in interface AWSRedshiftServerless

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteScheduledAction

public DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)

Deletes a scheduled action.

Specified by:

deleteScheduledAction in interface AWSRedshiftServerless

Parameters:

deleteScheduledActionRequest -

Returns:

Result of the DeleteScheduledAction operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteSnapshot

public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)

Deletes a snapshot from Amazon Redshift Serverless.

Specified by:

deleteSnapshot in interface AWSRedshiftServerless

Parameters:

deleteSnapshotRequest -

Returns:

Result of the DeleteSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteSnapshotCopyConfiguration

public DeleteSnapshotCopyConfigurationResult deleteSnapshotCopyConfiguration(DeleteSnapshotCopyConfigurationRequest request)

Deletes a snapshot copy configuration

Specified by:

deleteSnapshotCopyConfiguration in interface AWSRedshiftServerless

Parameters:

deleteSnapshotCopyConfigurationRequest -

Returns:

Result of the DeleteSnapshotCopyConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteUsageLimit

public DeleteUsageLimitResult deleteUsageLimit(DeleteUsageLimitRequest request)

Deletes a usage limit from Amazon Redshift Serverless.

Specified by:

deleteUsageLimit in interface AWSRedshiftServerless

Parameters:

deleteUsageLimitRequest -

Returns:

Result of the DeleteUsageLimit operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteWorkgroup

public DeleteWorkgroupResult deleteWorkgroup(DeleteWorkgroupRequest request)

Deletes a workgroup.

Specified by:

deleteWorkgroup in interface AWSRedshiftServerless

Parameters:

deleteWorkgroupRequest -

Returns:

Result of the DeleteWorkgroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCredentials

public GetCredentialsResult getCredentials(GetCredentialsRequest request)

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> 
 

Specified by:

getCredentials in interface AWSRedshiftServerless

Parameters:

getCredentialsRequest -

Returns:

Result of the GetCredentials operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCustomDomainAssociation

public GetCustomDomainAssociationResult getCustomDomainAssociation(GetCustomDomainAssociationRequest request)

Gets information about a specific custom domain association.

Specified by:

getCustomDomainAssociation in interface AWSRedshiftServerless

Parameters:

getCustomDomainAssociationRequest -

Returns:

Result of the GetCustomDomainAssociation operation returned by the service.

Throws:

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.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getEndpointAccess

public GetEndpointAccessResult getEndpointAccess(GetEndpointAccessRequest request)

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

Specified by:

getEndpointAccess in interface AWSRedshiftServerless

Parameters:

getEndpointAccessRequest -

Returns:

Result of the GetEndpointAccess operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getNamespace

public GetNamespaceResult getNamespace(GetNamespaceRequest request)

Returns information about a namespace in Amazon Redshift Serverless.

Specified by:

getNamespace in interface AWSRedshiftServerless

Parameters:

getNamespaceRequest -

Returns:

Result of the GetNamespace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRecoveryPoint

public GetRecoveryPointResult getRecoveryPoint(GetRecoveryPointRequest request)

Returns information about a recovery point.

Specified by:

getRecoveryPoint in interface AWSRedshiftServerless

Parameters:

getRecoveryPointRequest -

Returns:

Result of the GetRecoveryPoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getResourcePolicy

public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)

Returns a resource policy.

Specified by:

getResourcePolicy in interface AWSRedshiftServerless

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getScheduledAction

public GetScheduledActionResult getScheduledAction(GetScheduledActionRequest request)

Returns information about a scheduled action.

Specified by:

getScheduledAction in interface AWSRedshiftServerless

Parameters:

getScheduledActionRequest -

Returns:

Result of the GetScheduledAction operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSnapshot

public GetSnapshotResult getSnapshot(GetSnapshotRequest request)

Returns information about a specific snapshot.

Specified by:

getSnapshot in interface AWSRedshiftServerless

Parameters:

getSnapshotRequest -

Returns:

Result of the GetSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTableRestoreStatus

public GetTableRestoreStatusResult getTableRestoreStatus(GetTableRestoreStatusRequest request)

Returns information about a TableRestoreStatus object.

Specified by:

getTableRestoreStatus in interface AWSRedshiftServerless

Parameters:

getTableRestoreStatusRequest -

Returns:

Result of the GetTableRestoreStatus operation returned by the service.

Throws:

ResourceNotFoundException - The resource could not be found.

ValidationException - The input failed to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getUsageLimit

public GetUsageLimitResult getUsageLimit(GetUsageLimitRequest request)

Returns information about a usage limit.

Specified by:

getUsageLimit in interface AWSRedshiftServerless

Parameters:

getUsageLimitRequest -

Returns:

Result of the GetUsageLimit operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkgroup

public GetWorkgroupResult getWorkgroup(GetWorkgroupRequest request)

Returns information about a specific workgroup.

Specified by:

getWorkgroup in interface AWSRedshiftServerless

Parameters:

getWorkgroupRequest -

Returns:

Result of the GetWorkgroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listCustomDomainAssociations

public ListCustomDomainAssociationsResult listCustomDomainAssociations(ListCustomDomainAssociationsRequest request)

Lists custom domain associations for Amazon Redshift Serverless.

Specified by:

listCustomDomainAssociations in interface AWSRedshiftServerless

Parameters:

listCustomDomainAssociationsRequest -

Returns:

Result of the ListCustomDomainAssociations operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidPaginationException - The provided pagination token is invalid.

ValidationException - The input failed to satisfy the constraints specified by an AWS service.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listEndpointAccess

public ListEndpointAccessResult listEndpointAccess(ListEndpointAccessRequest request)

Returns an array of EndpointAccess objects and relevant information.

Specified by:

listEndpointAccess in interface AWSRedshiftServerless

Parameters:

listEndpointAccessRequest -

Returns:

Result of the ListEndpointAccess operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listNamespaces

public ListNamespacesResult listNamespaces(ListNamespacesRequest request)

Returns information about a list of specified namespaces.

Specified by:

listNamespaces in interface AWSRedshiftServerless

Parameters:

listNamespacesRequest -

Returns:

Result of the ListNamespaces operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listRecoveryPoints

public ListRecoveryPointsResult listRecoveryPoints(ListRecoveryPointsRequest request)

Returns an array of recovery points.

Specified by:

listRecoveryPoints in interface AWSRedshiftServerless

Parameters:

listRecoveryPointsRequest -

Returns:

Result of the ListRecoveryPoints operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listScheduledActions

public ListScheduledActionsResult listScheduledActions(ListScheduledActionsRequest request)

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

Specified by:

listScheduledActions in interface AWSRedshiftServerless

Parameters:

listScheduledActionsRequest -

Returns:

Result of the ListScheduledActions operation returned by the service.

Throws:

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.

ValidationException - The input failed to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

listSnapshotCopyConfigurations

public ListSnapshotCopyConfigurationsResult listSnapshotCopyConfigurations(ListSnapshotCopyConfigurationsRequest request)

Returns a list of snapshot copy configurations.

Specified by:

listSnapshotCopyConfigurations in interface AWSRedshiftServerless

Parameters:

listSnapshotCopyConfigurationsRequest -

Returns:

Result of the ListSnapshotCopyConfigurations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSnapshots

public ListSnapshotsResult listSnapshots(ListSnapshotsRequest request)

Returns a list of snapshots.

Specified by:

listSnapshots in interface AWSRedshiftServerless

Parameters:

listSnapshotsRequest -

Returns:

Result of the ListSnapshots operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTableRestoreStatus

public ListTableRestoreStatusResult listTableRestoreStatus(ListTableRestoreStatusRequest request)

Returns information about an array of TableRestoreStatus objects.

Specified by:

listTableRestoreStatus in interface AWSRedshiftServerless

Parameters:

listTableRestoreStatusRequest -

Returns:

Result of the ListTableRestoreStatus operation returned by the service.

Throws:

InvalidPaginationException - The provided pagination token is invalid.

ResourceNotFoundException - The resource could not be found.

ValidationException - The input failed to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags assigned to a resource.

Specified by:

listTagsForResource in interface AWSRedshiftServerless

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listUsageLimits

public ListUsageLimitsResult listUsageLimits(ListUsageLimitsRequest request)

Lists all usage limits within Amazon Redshift Serverless.

Specified by:

listUsageLimits in interface AWSRedshiftServerless

Parameters:

listUsageLimitsRequest -

Returns:

Result of the ListUsageLimits operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listWorkgroups

public ListWorkgroupsResult listWorkgroups(ListWorkgroupsRequest request)

Returns information about a list of specified workgroups.

Specified by:

listWorkgroups in interface AWSRedshiftServerless

Parameters:

listWorkgroupsRequest -

Returns:

Result of the ListWorkgroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putResourcePolicy

public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)

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

Specified by:

putResourcePolicy in interface AWSRedshiftServerless

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

restoreFromRecoveryPoint

public RestoreFromRecoveryPointResult restoreFromRecoveryPoint(RestoreFromRecoveryPointRequest request)

Restore the data from a recovery point.

Specified by:

restoreFromRecoveryPoint in interface AWSRedshiftServerless

Parameters:

restoreFromRecoveryPointRequest -

Returns:

Result of the RestoreFromRecoveryPoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

restoreFromSnapshot

public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)

Restores a namespace from a snapshot.

Specified by:

restoreFromSnapshot in interface AWSRedshiftServerless

Parameters:

restoreFromSnapshotRequest -

Returns:

Result of the RestoreFromSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

restoreTableFromRecoveryPoint

public RestoreTableFromRecoveryPointResult restoreTableFromRecoveryPoint(RestoreTableFromRecoveryPointRequest request)

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.

Specified by:

restoreTableFromRecoveryPoint in interface AWSRedshiftServerless

Parameters:

restoreTableFromRecoveryPointRequest -

Returns:

Result of the RestoreTableFromRecoveryPoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

restoreTableFromSnapshot

public RestoreTableFromSnapshotResult restoreTableFromSnapshot(RestoreTableFromSnapshotRequest request)

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.

Specified by:

restoreTableFromSnapshot in interface AWSRedshiftServerless

Parameters:

restoreTableFromSnapshotRequest -

Returns:

Result of the RestoreTableFromSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Assigns one or more tags to a resource.

Specified by:

tagResource in interface AWSRedshiftServerless

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag or set of tags from a resource.

Specified by:

untagResource in interface AWSRedshiftServerless

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateCustomDomainAssociation

public UpdateCustomDomainAssociationResult updateCustomDomainAssociation(UpdateCustomDomainAssociationRequest request)

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

Specified by:

updateCustomDomainAssociation in interface AWSRedshiftServerless

Parameters:

updateCustomDomainAssociationRequest -

Returns:

Result of the UpdateCustomDomainAssociation operation returned by the service.

Throws:

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.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateEndpointAccess

public UpdateEndpointAccessResult updateEndpointAccess(UpdateEndpointAccessRequest request)

Updates an Amazon Redshift Serverless managed endpoint.

Specified by:

updateEndpointAccess in interface AWSRedshiftServerless

Parameters:

updateEndpointAccessRequest -

Returns:

Result of the UpdateEndpointAccess operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateNamespace

public UpdateNamespaceResult updateNamespace(UpdateNamespaceRequest request)

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.

Specified by:

updateNamespace in interface AWSRedshiftServerless

Parameters:

updateNamespaceRequest -

Returns:

Result of the UpdateNamespace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateScheduledAction

public UpdateScheduledActionResult updateScheduledAction(UpdateScheduledActionRequest request)

Updates a scheduled action.

Specified by:

updateScheduledAction in interface AWSRedshiftServerless

Parameters:

updateScheduledActionRequest -

Returns:

Result of the UpdateScheduledAction operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateSnapshot

public UpdateSnapshotResult updateSnapshot(UpdateSnapshotRequest request)

Updates a snapshot.

Specified by:

updateSnapshot in interface AWSRedshiftServerless

Parameters:

updateSnapshotRequest -

Returns:

Result of the UpdateSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateSnapshotCopyConfiguration

public UpdateSnapshotCopyConfigurationResult updateSnapshotCopyConfiguration(UpdateSnapshotCopyConfigurationRequest request)

Updates a snapshot copy configuration.

Specified by:

updateSnapshotCopyConfiguration in interface AWSRedshiftServerless

Parameters:

updateSnapshotCopyConfigurationRequest -

Returns:

Result of the UpdateSnapshotCopyConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateUsageLimit

public UpdateUsageLimitResult updateUsageLimit(UpdateUsageLimitRequest request)

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

Specified by:

updateUsageLimit in interface AWSRedshiftServerless

Parameters:

updateUsageLimitRequest -

Returns:

Result of the UpdateUsageLimit operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateWorkgroup

public UpdateWorkgroupResult updateWorkgroup(UpdateWorkgroupRequest request)

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.

Specified by:

updateWorkgroup in interface AWSRedshiftServerless

Parameters:

updateWorkgroupRequest -

Returns:

Result of the UpdateWorkgroup operation returned by the service.

Throws:

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.

Ipv6CidrBlockNotFoundException - There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSRedshiftServerless

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSRedshiftServerless

Overrides:

shutdown in class AmazonWebServiceClient