com.amazonaws.services.fis

Interface AWSFIS

All Known Subinterfaces:

AWSFISAsync

All Known Implementing Classes:

AbstractAWSFIS, AbstractAWSFISAsync, AWSFISAsyncClient, AWSFISClient

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

Interface for accessing FIS.

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

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

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
CreateExperimentTemplateResult	createExperimentTemplate(CreateExperimentTemplateRequest createExperimentTemplateRequest) Creates an experiment template.
CreateTargetAccountConfigurationResult	createTargetAccountConfiguration(CreateTargetAccountConfigurationRequest createTargetAccountConfigurationRequest) Creates a target account configuration for the experiment template.
DeleteExperimentTemplateResult	deleteExperimentTemplate(DeleteExperimentTemplateRequest deleteExperimentTemplateRequest) Deletes the specified experiment template.
DeleteTargetAccountConfigurationResult	deleteTargetAccountConfiguration(DeleteTargetAccountConfigurationRequest deleteTargetAccountConfigurationRequest) Deletes the specified target account configuration of the experiment template.
GetActionResult	getAction(GetActionRequest getActionRequest) Gets information about the specified 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 getExperimentRequest) Gets information about the specified experiment.
GetExperimentTargetAccountConfigurationResult	getExperimentTargetAccountConfiguration(GetExperimentTargetAccountConfigurationRequest getExperimentTargetAccountConfigurationRequest) Gets information about the specified target account configuration of the experiment.
GetExperimentTemplateResult	getExperimentTemplate(GetExperimentTemplateRequest getExperimentTemplateRequest) Gets information about the specified experiment template.
GetTargetAccountConfigurationResult	getTargetAccountConfiguration(GetTargetAccountConfigurationRequest getTargetAccountConfigurationRequest) Gets information about the specified target account configuration of the experiment template.
GetTargetResourceTypeResult	getTargetResourceType(GetTargetResourceTypeRequest getTargetResourceTypeRequest) Gets information about the specified resource type.
ListActionsResult	listActions(ListActionsRequest listActionsRequest) Lists the available FIS actions.
ListExperimentResolvedTargetsResult	listExperimentResolvedTargets(ListExperimentResolvedTargetsRequest listExperimentResolvedTargetsRequest) Lists the resolved targets information of the specified experiment.
ListExperimentsResult	listExperiments(ListExperimentsRequest listExperimentsRequest) Lists your experiments.
ListExperimentTargetAccountConfigurationsResult	listExperimentTargetAccountConfigurations(ListExperimentTargetAccountConfigurationsRequest listExperimentTargetAccountConfigurationsRequest) Lists the target account configurations of the specified experiment.
ListExperimentTemplatesResult	listExperimentTemplates(ListExperimentTemplatesRequest listExperimentTemplatesRequest) Lists your experiment templates.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
ListTargetAccountConfigurationsResult	listTargetAccountConfigurations(ListTargetAccountConfigurationsRequest listTargetAccountConfigurationsRequest) Lists the target account configurations of the specified experiment template.
ListTargetResourceTypesResult	listTargetResourceTypes(ListTargetResourceTypesRequest listTargetResourceTypesRequest) Lists the target resource types.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartExperimentResult	startExperiment(StartExperimentRequest startExperimentRequest) Starts running an experiment from the specified experiment template.
StopExperimentResult	stopExperiment(StopExperimentRequest stopExperimentRequest) Stops the specified experiment.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
UpdateExperimentTemplateResult	updateExperimentTemplate(UpdateExperimentTemplateRequest updateExperimentTemplateRequest) Updates the specified experiment template.
UpdateTargetAccountConfigurationResult	updateTargetAccountConfiguration(UpdateTargetAccountConfigurationRequest updateTargetAccountConfigurationRequest) Updates the target account configuration for the specified experiment template.

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

createExperimentTemplate

CreateExperimentTemplateResult createExperimentTemplate(CreateExperimentTemplateRequest createExperimentTemplateRequest)

Creates an experiment template.

An experiment template includes the following components:

• Targets: A target can be a specific resource in your Amazon Web Services 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 experiment templates in the Fault Injection Simulator User Guide.

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

createTargetAccountConfiguration

CreateTargetAccountConfigurationResult createTargetAccountConfiguration(CreateTargetAccountConfigurationRequest createTargetAccountConfigurationRequest)

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Simulator User Guide.

Parameters:

createTargetAccountConfigurationRequest -

Returns:

Result of the CreateTargetAccountConfiguration 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

DeleteExperimentTemplateResult deleteExperimentTemplate(DeleteExperimentTemplateRequest deleteExperimentTemplateRequest)

Deletes the specified experiment template.

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

deleteTargetAccountConfiguration

DeleteTargetAccountConfigurationResult deleteTargetAccountConfiguration(DeleteTargetAccountConfigurationRequest deleteTargetAccountConfigurationRequest)

Deletes the specified target account configuration of the experiment template.

Parameters:

deleteTargetAccountConfigurationRequest -

Returns:

Result of the DeleteTargetAccountConfiguration 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

GetActionResult getAction(GetActionRequest getActionRequest)

Gets information about the specified FIS action.

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

GetExperimentResult getExperiment(GetExperimentRequest getExperimentRequest)

Gets information about the specified experiment.

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

getExperimentTargetAccountConfiguration

GetExperimentTargetAccountConfigurationResult getExperimentTargetAccountConfiguration(GetExperimentTargetAccountConfigurationRequest getExperimentTargetAccountConfigurationRequest)

Gets information about the specified target account configuration of the experiment.

Parameters:

getExperimentTargetAccountConfigurationRequest -

Returns:

Result of the GetExperimentTargetAccountConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource cannot be found.

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

See Also:

AWS API Documentation

getExperimentTemplate

GetExperimentTemplateResult getExperimentTemplate(GetExperimentTemplateRequest getExperimentTemplateRequest)

Gets information about the specified experiment template.

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

getTargetAccountConfiguration

GetTargetAccountConfigurationResult getTargetAccountConfiguration(GetTargetAccountConfigurationRequest getTargetAccountConfigurationRequest)

Gets information about the specified target account configuration of the experiment template.

Parameters:

getTargetAccountConfigurationRequest -

Returns:

Result of the GetTargetAccountConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource cannot be found.

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

See Also:

AWS API Documentation

getTargetResourceType

GetTargetResourceTypeResult getTargetResourceType(GetTargetResourceTypeRequest getTargetResourceTypeRequest)

Gets information about the specified resource type.

Parameters:

getTargetResourceTypeRequest -

Returns:

Result of the GetTargetResourceType 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

ListActionsResult listActions(ListActionsRequest listActionsRequest)

Lists the available FIS actions.

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

listExperimentResolvedTargets

ListExperimentResolvedTargetsResult listExperimentResolvedTargets(ListExperimentResolvedTargetsRequest listExperimentResolvedTargetsRequest)

Lists the resolved targets information of the specified experiment.

Parameters:

listExperimentResolvedTargetsRequest -

Returns:

Result of the ListExperimentResolvedTargets 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

listExperimentTargetAccountConfigurations

ListExperimentTargetAccountConfigurationsResult listExperimentTargetAccountConfigurations(ListExperimentTargetAccountConfigurationsRequest listExperimentTargetAccountConfigurationsRequest)

Lists the target account configurations of the specified experiment.

Parameters:

listExperimentTargetAccountConfigurationsRequest -

Returns:

Result of the ListExperimentTargetAccountConfigurations 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

listExperimentTemplates

ListExperimentTemplatesResult listExperimentTemplates(ListExperimentTemplatesRequest listExperimentTemplatesRequest)

Lists your experiment templates.

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

ListExperimentsResult listExperiments(ListExperimentsRequest listExperimentsRequest)

Lists your experiments.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTargetAccountConfigurations

ListTargetAccountConfigurationsResult listTargetAccountConfigurations(ListTargetAccountConfigurationsRequest listTargetAccountConfigurationsRequest)

Lists the target account configurations of the specified experiment template.

Parameters:

listTargetAccountConfigurationsRequest -

Returns:

Result of the ListTargetAccountConfigurations 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

listTargetResourceTypes

ListTargetResourceTypesResult listTargetResourceTypes(ListTargetResourceTypesRequest listTargetResourceTypesRequest)

Lists the target resource types.

Parameters:

listTargetResourceTypesRequest -

Returns:

Result of the ListTargetResourceTypes 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

startExperiment

StartExperimentResult startExperiment(StartExperimentRequest startExperimentRequest)

Starts running an experiment from the specified experiment template.

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

StopExperimentResult stopExperiment(StopExperimentRequest stopExperimentRequest)

Stops the specified experiment.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Applies the specified tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateExperimentTemplate

UpdateExperimentTemplateResult updateExperimentTemplate(UpdateExperimentTemplateRequest updateExperimentTemplateRequest)

Updates the specified experiment template.

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

updateTargetAccountConfiguration

UpdateTargetAccountConfigurationResult updateTargetAccountConfiguration(UpdateTargetAccountConfigurationRequest updateTargetAccountConfigurationRequest)

Updates the target account configuration for the specified experiment template.

Parameters:

updateTargetAccountConfigurationRequest -

Returns:

Result of the UpdateTargetAccountConfiguration 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

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.