com.amazonaws.services.finspace

Interface AWSfinspace

All Known Subinterfaces:

AWSfinspaceAsync

All Known Implementing Classes:

AbstractAWSfinspace, AbstractAWSfinspaceAsync, AWSfinspaceAsyncClient, AWSfinspaceClient

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

Interface for accessing finspace.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSfinspace instead.

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

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
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Create a new FinSpace environment.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) 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 getEnvironmentRequest) Returns the FinSpace environment object.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) A list of all of your FinSpace environments.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 tagResourceRequest) Adds metadata tags to a FinSpace resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a FinSpace resource.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Update your FinSpace environment.

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

createEnvironment

CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

Create a new FinSpace environment.

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

DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)

Delete an FinSpace environment.

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

GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)

Returns the FinSpace environment object.

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

ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)

A list of all of your FinSpace environments.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

A list of all tags for 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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds metadata tags to a FinSpace 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.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes metadata tags from a FinSpace 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.

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

UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)

Update your FinSpace environment.

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

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.