com.amazonaws.services.fis

Class AWSFISClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.fis.AWSFISClient

All Implemented Interfaces:

AWSFIS

Direct Known Subclasses:

AWSFISAsyncClient

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

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

AWS Fault Injection Simulator is a managed service that enables you to perform fault injection experiments on your AWS workloads. For more information, see the AWS Fault Injection Simulator User Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.fis.AWSFIS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSFISClientBuilder	builder()
CreateExperimentTemplateResult	createExperimentTemplate(CreateExperimentTemplateRequest request) Creates an experiment template.
DeleteExperimentTemplateResult	deleteExperimentTemplate(DeleteExperimentTemplateRequest request) Deletes the specified experiment template.
GetActionResult	getAction(GetActionRequest request) Gets information about the specified AWS FIS action.
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.
GetExperimentResult	getExperiment(GetExperimentRequest request) Gets information about the specified experiment.
GetExperimentTemplateResult	getExperimentTemplate(GetExperimentTemplateRequest request) Gets information about the specified experiment template.
ListActionsResult	listActions(ListActionsRequest request) Lists the available AWS FIS actions.
ListExperimentsResult	listExperiments(ListExperimentsRequest request) Lists your experiments.
ListExperimentTemplatesResult	listExperimentTemplates(ListExperimentTemplatesRequest request) Lists your experiment templates.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartExperimentResult	startExperiment(StartExperimentRequest request) Starts running an experiment from the specified experiment template.
StopExperimentResult	stopExperiment(StopExperimentRequest request) Stops the specified experiment.
TagResourceResult	tagResource(TagResourceRequest request) Applies the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified resource.
UpdateExperimentTemplateResult	updateExperimentTemplate(UpdateExperimentTemplateRequest request) Updates the specified experiment template.

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

createExperimentTemplate

public CreateExperimentTemplateResult createExperimentTemplate(CreateExperimentTemplateRequest request)

Creates an experiment template.

To create a template, specify the following information:

• Targets: A target can be a specific resource in your AWS environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.

• Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.

• Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see the AWS Fault Injection Simulator User Guide.

Specified by:

createExperimentTemplate in interface AWSFIS

Parameters:

createExperimentTemplateRequest -

Returns:

Result of the CreateExperimentTemplate operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ConflictException - The request could not be processed because of a conflict.

ResourceNotFoundException - The specified resource cannot be found.

ServiceQuotaExceededException - You have exceeded your service quota.

See Also:

AWS API Documentation

deleteExperimentTemplate

public DeleteExperimentTemplateResult deleteExperimentTemplate(DeleteExperimentTemplateRequest request)

Deletes the specified experiment template.

Specified by:

deleteExperimentTemplate in interface AWSFIS

Parameters:

deleteExperimentTemplateRequest -

Returns:

Result of the DeleteExperimentTemplate operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException - The specified resource cannot be found.

See Also:

AWS API Documentation

getAction

public GetActionResult getAction(GetActionRequest request)

Gets information about the specified AWS FIS action.

Specified by:

getAction in interface AWSFIS

Parameters:

getActionRequest -

Returns:

Result of the GetAction operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException - The specified resource cannot be found.

See Also:

AWS API Documentation

getExperiment

public GetExperimentResult getExperiment(GetExperimentRequest request)

Gets information about the specified experiment.

Specified by:

getExperiment in interface AWSFIS

Parameters:

getExperimentRequest -

Returns:

Result of the GetExperiment operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException - The specified resource cannot be found.

See Also:

AWS API Documentation

getExperimentTemplate

public GetExperimentTemplateResult getExperimentTemplate(GetExperimentTemplateRequest request)

Gets information about the specified experiment template.

Specified by:

getExperimentTemplate in interface AWSFIS

Parameters:

getExperimentTemplateRequest -

Returns:

Result of the GetExperimentTemplate operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException - The specified resource cannot be found.

See Also:

AWS API Documentation

listActions

public ListActionsResult listActions(ListActionsRequest request)

Lists the available AWS FIS actions.

Specified by:

listActions in interface AWSFIS

Parameters:

listActionsRequest -

Returns:

Result of the ListActions operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

See Also:

AWS API Documentation

listExperimentTemplates

public ListExperimentTemplatesResult listExperimentTemplates(ListExperimentTemplatesRequest request)

Lists your experiment templates.

Specified by:

listExperimentTemplates in interface AWSFIS

Parameters:

listExperimentTemplatesRequest -

Returns:

Result of the ListExperimentTemplates operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

See Also:

AWS API Documentation

listExperiments

public ListExperimentsResult listExperiments(ListExperimentsRequest request)

Lists your experiments.

Specified by:

listExperiments in interface AWSFIS

Parameters:

listExperimentsRequest -

Returns:

Result of the ListExperiments operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AWSFIS

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

startExperiment

public StartExperimentResult startExperiment(StartExperimentRequest request)

Starts running an experiment from the specified experiment template.

Specified by:

startExperiment in interface AWSFIS

Parameters:

startExperimentRequest -

Returns:

Result of the StartExperiment operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ConflictException - The request could not be processed because of a conflict.

ResourceNotFoundException - The specified resource cannot be found.

ServiceQuotaExceededException - You have exceeded your service quota.

See Also:

AWS API Documentation

stopExperiment

public StopExperimentResult stopExperiment(StopExperimentRequest request)

Stops the specified experiment.

Specified by:

stopExperiment in interface AWSFIS

Parameters:

stopExperimentRequest -

Returns:

Result of the StopExperiment operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException - The specified resource cannot be found.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Applies the specified tags to the specified resource.

Specified by:

tagResource in interface AWSFIS

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags from the specified resource.

Specified by:

untagResource in interface AWSFIS

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateExperimentTemplate

public UpdateExperimentTemplateResult updateExperimentTemplate(UpdateExperimentTemplateRequest request)

Updates the specified experiment template.

Specified by:

updateExperimentTemplate in interface AWSFIS

Parameters:

updateExperimentTemplateRequest -

Returns:

Result of the UpdateExperimentTemplate operation returned by the service.

Throws:

ValidationException - The specified input is not valid, or fails to satisfy the constraints for the request.

ResourceNotFoundException - The specified resource cannot be found.

ServiceQuotaExceededException - You have exceeded your service quota.

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 AWSFIS

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 AWSFIS

Overrides:

shutdown in class AmazonWebServiceClient