com.amazonaws.services.finspace

Class AWSfinspaceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.finspace.AWSfinspaceClient

All Implemented Interfaces:

AWSfinspace

Direct Known Subclasses:

AWSfinspaceAsyncClient

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

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

The FinSpace management service provides the APIs for managing FinSpace environments.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.finspace.AWSfinspace

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSfinspaceClientBuilder	builder()
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest request) Create a new FinSpace environment.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) Delete an FinSpace environment.
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.
GetEnvironmentResult	getEnvironment(GetEnvironmentRequest request) Returns the FinSpace environment object.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest request) A list of all of your FinSpace environments.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) A list of all tags for a resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds metadata tags to a FinSpace resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes metadata tags from a FinSpace resource.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Update your FinSpace environment.

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 AWSfinspaceClientBuilder builder()

createEnvironment

public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)

Create a new FinSpace environment.

Specified by:

createEnvironment in interface AWSfinspace

Parameters:

createEnvironmentRequest -

Returns:

Result of the CreateEnvironment operation returned by the service.

Throws:

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

ValidationException - The input fails 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.

ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

LimitExceededException - A service limit or quota is exceeded.

See Also:

AWS API Documentation

deleteEnvironment

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

Delete an FinSpace environment.

Specified by:

deleteEnvironment in interface AWSfinspace

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

Throws:

ResourceNotFoundException - One or more resources can't be found.

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

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

ThrottlingException - The request was denied due to request throttling.

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

See Also:

AWS API Documentation

getEnvironment

public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)

Returns the FinSpace environment object.

Specified by:

getEnvironment in interface AWSfinspace

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

Throws:

ResourceNotFoundException - One or more resources can't be found.

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

ValidationException - The input fails 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

listEnvironments

public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

A list of all of your FinSpace environments.

Specified by:

listEnvironments in interface AWSfinspace

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

Throws:

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

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

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

A list of all tags for a resource.

Specified by:

listTagsForResource in interface AWSfinspace

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.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

ResourceNotFoundException - One or more resources can't be found.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds metadata tags to a FinSpace resource.

Specified by:

tagResource in interface AWSfinspace

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.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

ResourceNotFoundException - One or more resources can't be found.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes metadata tags from a FinSpace resource.

Specified by:

untagResource in interface AWSfinspace

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.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

ResourceNotFoundException - One or more resources can't be found.

See Also:

AWS API Documentation

updateEnvironment

public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)

Update your FinSpace environment.

Specified by:

updateEnvironment in interface AWSfinspace

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment operation returned by the service.

Throws:

ResourceNotFoundException - One or more resources can't be found.

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

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

ThrottlingException - The request was denied due to request throttling.

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

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 AWSfinspace

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 AWSfinspace

Overrides:

shutdown in class AmazonWebServiceClient