com.amazonaws.services.redshiftserverless

Interface AWSRedshiftServerless

All Known Subinterfaces:

AWSRedshiftServerlessAsync

All Known Implementing Classes:

AbstractAWSRedshiftServerless, AbstractAWSRedshiftServerlessAsync, AWSRedshiftServerlessAsyncClient, AWSRedshiftServerlessClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRedshiftServerless

Interface for accessing Redshift Serverless.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ConvertRecoveryPointToSnapshotResult	convertRecoveryPointToSnapshot(ConvertRecoveryPointToSnapshotRequest convertRecoveryPointToSnapshotRequest) Converts a recovery point to a snapshot.
CreateCustomDomainAssociationResult	createCustomDomainAssociation(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest) Creates a custom domain association for Amazon Redshift Serverless.
CreateEndpointAccessResult	createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest) Creates an Amazon Redshift Serverless managed VPC endpoint.
CreateNamespaceResult	createNamespace(CreateNamespaceRequest createNamespaceRequest) Creates a namespace in Amazon Redshift Serverless.
CreateScheduledActionResult	createScheduledAction(CreateScheduledActionRequest createScheduledActionRequest) Creates a scheduled action.
CreateSnapshotResult	createSnapshot(CreateSnapshotRequest createSnapshotRequest) Creates a snapshot of all databases in a namespace.
CreateSnapshotCopyConfigurationResult	createSnapshotCopyConfiguration(CreateSnapshotCopyConfigurationRequest createSnapshotCopyConfigurationRequest) Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
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.
DeleteCustomDomainAssociationResult	deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest) Deletes a custom domain association for 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.
DeleteScheduledActionResult	deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) Deletes a scheduled action.
DeleteSnapshotResult	deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) Deletes a snapshot from Amazon Redshift Serverless.
DeleteSnapshotCopyConfigurationResult	deleteSnapshotCopyConfiguration(DeleteSnapshotCopyConfigurationRequest deleteSnapshotCopyConfigurationRequest) Deletes a snapshot copy configuration
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.
GetCustomDomainAssociationResult	getCustomDomainAssociation(GetCustomDomainAssociationRequest getCustomDomainAssociationRequest) Gets information about a specific custom domain association.
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.
GetScheduledActionResult	getScheduledAction(GetScheduledActionRequest getScheduledActionRequest) Returns information about a scheduled action.
GetSnapshotResult	getSnapshot(GetSnapshotRequest getSnapshotRequest) Returns information about a specific snapshot.
GetTableRestoreStatusResult	getTableRestoreStatus(GetTableRestoreStatusRequest getTableRestoreStatusRequest) Returns information about a TableRestoreStatus object.
GetUsageLimitResult	getUsageLimit(GetUsageLimitRequest getUsageLimitRequest) Returns information about a usage limit.
GetWorkgroupResult	getWorkgroup(GetWorkgroupRequest getWorkgroupRequest) Returns information about a specific workgroup.
ListCustomDomainAssociationsResult	listCustomDomainAssociations(ListCustomDomainAssociationsRequest listCustomDomainAssociationsRequest) Lists custom domain associations for Amazon Redshift Serverless.
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.
ListScheduledActionsResult	listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest) Returns a list of scheduled actions.
ListSnapshotCopyConfigurationsResult	listSnapshotCopyConfigurations(ListSnapshotCopyConfigurationsRequest listSnapshotCopyConfigurationsRequest) Returns a list of snapshot copy configurations.
ListSnapshotsResult	listSnapshots(ListSnapshotsRequest listSnapshotsRequest) Returns a list of snapshots.
ListTableRestoreStatusResult	listTableRestoreStatus(ListTableRestoreStatusRequest listTableRestoreStatusRequest) Returns information about an array of TableRestoreStatus objects.
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.
RestoreTableFromRecoveryPointResult	restoreTableFromRecoveryPoint(RestoreTableFromRecoveryPointRequest restoreTableFromRecoveryPointRequest) Restores a table from a recovery point to your Amazon Redshift Serverless instance.
RestoreTableFromSnapshotResult	restoreTableFromSnapshot(RestoreTableFromSnapshotRequest restoreTableFromSnapshotRequest) 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 tagResourceRequest) Assigns one or more tags to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or set of tags from a resource.
UpdateCustomDomainAssociationResult	updateCustomDomainAssociation(UpdateCustomDomainAssociationRequest updateCustomDomainAssociationRequest) Updates an Amazon Redshift Serverless certificate associated with a custom domain.
UpdateEndpointAccessResult	updateEndpointAccess(UpdateEndpointAccessRequest updateEndpointAccessRequest) Updates an Amazon Redshift Serverless managed endpoint.
UpdateNamespaceResult	updateNamespace(UpdateNamespaceRequest updateNamespaceRequest) Updates a namespace with the specified settings.
UpdateScheduledActionResult	updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest) Updates a scheduled action.
UpdateSnapshotResult	updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest) Updates a snapshot.
UpdateSnapshotCopyConfigurationResult	updateSnapshotCopyConfiguration(UpdateSnapshotCopyConfigurationRequest updateSnapshotCopyConfigurationRequest) Updates a snapshot copy configuration.
UpdateUsageLimitResult	updateUsageLimit(UpdateUsageLimitRequest updateUsageLimitRequest) Update a usage limit in Amazon Redshift Serverless.
UpdateWorkgroupResult	updateWorkgroup(UpdateWorkgroupRequest updateWorkgroupRequest) Updates a workgroup with the specified configuration settings.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

convertRecoveryPointToSnapshot

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.

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

CreateCustomDomainAssociationResult createCustomDomainAssociation(CreateCustomDomainAssociationRequest createCustomDomainAssociationRequest)

Creates a custom domain association for Amazon Redshift Serverless.

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

CreateEndpointAccessResult createEndpointAccess(CreateEndpointAccessRequest createEndpointAccessRequest)

Creates an Amazon Redshift Serverless managed VPC endpoint.

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

CreateNamespaceResult createNamespace(CreateNamespaceRequest createNamespaceRequest)

Creates a namespace in Amazon Redshift Serverless.

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

CreateScheduledActionResult createScheduledAction(CreateScheduledActionRequest createScheduledActionRequest)

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.

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

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.

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

CreateSnapshotCopyConfigurationResult createSnapshotCopyConfiguration(CreateSnapshotCopyConfigurationRequest createSnapshotCopyConfigurationRequest)

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

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

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.

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

CreateWorkgroupResult createWorkgroup(CreateWorkgroupRequest createWorkgroupRequest)

Creates an workgroup in Amazon Redshift Serverless.

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

DeleteCustomDomainAssociationResult deleteCustomDomainAssociation(DeleteCustomDomainAssociationRequest deleteCustomDomainAssociationRequest)

Deletes a custom domain association for Amazon Redshift Serverless.

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

DeleteEndpointAccessResult deleteEndpointAccess(DeleteEndpointAccessRequest deleteEndpointAccessRequest)

Deletes an Amazon Redshift Serverless managed VPC endpoint.

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

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.

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

DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

Deletes the specified resource policy.

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

DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)

Deletes a scheduled action.

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

DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)

Deletes a snapshot from Amazon Redshift Serverless.

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

DeleteSnapshotCopyConfigurationResult deleteSnapshotCopyConfiguration(DeleteSnapshotCopyConfigurationRequest deleteSnapshotCopyConfigurationRequest)

Deletes a snapshot copy configuration

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

DeleteUsageLimitResult deleteUsageLimit(DeleteUsageLimitRequest deleteUsageLimitRequest)

Deletes a usage limit from Amazon Redshift Serverless.

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

DeleteWorkgroupResult deleteWorkgroup(DeleteWorkgroupRequest deleteWorkgroupRequest)

Deletes a workgroup.

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

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> 
 

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

GetCustomDomainAssociationResult getCustomDomainAssociation(GetCustomDomainAssociationRequest getCustomDomainAssociationRequest)

Gets information about a specific custom domain association.

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

GetEndpointAccessResult getEndpointAccess(GetEndpointAccessRequest getEndpointAccessRequest)

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

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

GetNamespaceResult getNamespace(GetNamespaceRequest getNamespaceRequest)

Returns information about a namespace in Amazon Redshift Serverless.

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

GetRecoveryPointResult getRecoveryPoint(GetRecoveryPointRequest getRecoveryPointRequest)

Returns information about a recovery point.

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

GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)

Returns a resource policy.

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

GetScheduledActionResult getScheduledAction(GetScheduledActionRequest getScheduledActionRequest)

Returns information about a scheduled action.

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

GetSnapshotResult getSnapshot(GetSnapshotRequest getSnapshotRequest)

Returns information about a specific snapshot.

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

GetTableRestoreStatusResult getTableRestoreStatus(GetTableRestoreStatusRequest getTableRestoreStatusRequest)

Returns information about a TableRestoreStatus object.

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

GetUsageLimitResult getUsageLimit(GetUsageLimitRequest getUsageLimitRequest)

Returns information about a usage limit.

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

GetWorkgroupResult getWorkgroup(GetWorkgroupRequest getWorkgroupRequest)

Returns information about a specific workgroup.

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

ListCustomDomainAssociationsResult listCustomDomainAssociations(ListCustomDomainAssociationsRequest listCustomDomainAssociationsRequest)

Lists custom domain associations for Amazon Redshift Serverless.

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

ListEndpointAccessResult listEndpointAccess(ListEndpointAccessRequest listEndpointAccessRequest)

Returns an array of EndpointAccess objects and relevant information.

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

ListNamespacesResult listNamespaces(ListNamespacesRequest listNamespacesRequest)

Returns information about a list of specified namespaces.

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

ListRecoveryPointsResult listRecoveryPoints(ListRecoveryPointsRequest listRecoveryPointsRequest)

Returns an array of recovery points.

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

ListScheduledActionsResult listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest)

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

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

ListSnapshotCopyConfigurationsResult listSnapshotCopyConfigurations(ListSnapshotCopyConfigurationsRequest listSnapshotCopyConfigurationsRequest)

Returns a list of snapshot copy configurations.

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

ListSnapshotsResult listSnapshots(ListSnapshotsRequest listSnapshotsRequest)

Returns a list of snapshots.

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

ListTableRestoreStatusResult listTableRestoreStatus(ListTableRestoreStatusRequest listTableRestoreStatusRequest)

Returns information about an array of TableRestoreStatus objects.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags assigned to a resource.

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

ListUsageLimitsResult listUsageLimits(ListUsageLimitsRequest listUsageLimitsRequest)

Lists all usage limits within Amazon Redshift Serverless.

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

ListWorkgroupsResult listWorkgroups(ListWorkgroupsRequest listWorkgroupsRequest)

Returns information about a list of specified workgroups.

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

PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

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

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

RestoreFromRecoveryPointResult restoreFromRecoveryPoint(RestoreFromRecoveryPointRequest restoreFromRecoveryPointRequest)

Restore the data from a recovery point.

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

RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)

Restores a namespace from a snapshot.

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

RestoreTableFromRecoveryPointResult restoreTableFromRecoveryPoint(RestoreTableFromRecoveryPointRequest restoreTableFromRecoveryPointRequest)

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.

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

RestoreTableFromSnapshotResult restoreTableFromSnapshot(RestoreTableFromSnapshotRequest restoreTableFromSnapshotRequest)

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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Assigns one or more tags to a resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag or set of tags from a resource.

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

UpdateCustomDomainAssociationResult updateCustomDomainAssociation(UpdateCustomDomainAssociationRequest updateCustomDomainAssociationRequest)

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

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

UpdateEndpointAccessResult updateEndpointAccess(UpdateEndpointAccessRequest updateEndpointAccessRequest)

Updates an Amazon Redshift Serverless managed endpoint.

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

UpdateNamespaceResult updateNamespace(UpdateNamespaceRequest updateNamespaceRequest)

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.

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

UpdateScheduledActionResult updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest)

Updates a scheduled action.

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

UpdateSnapshotResult updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)

Updates a snapshot.

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

UpdateSnapshotCopyConfigurationResult updateSnapshotCopyConfiguration(UpdateSnapshotCopyConfigurationRequest updateSnapshotCopyConfigurationRequest)

Updates a snapshot copy configuration.

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

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.

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

UpdateWorkgroupResult updateWorkgroup(UpdateWorkgroupRequest updateWorkgroupRequest)

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.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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