software.amazon.awssdk.services.fis

Interface FisClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface FisClient
extends SdkClient

Service client for accessing FIS. This can be created using the static builder() method.

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

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static FisClientBuilder	builder() Create a builder that can be used to configure and create a FisClient.
static FisClient	create() Create a FisClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateExperimentTemplateResponse	createExperimentTemplate(Consumer<CreateExperimentTemplateRequest.Builder> createExperimentTemplateRequest) Creates an experiment template.
default CreateExperimentTemplateResponse	createExperimentTemplate(CreateExperimentTemplateRequest createExperimentTemplateRequest) Creates an experiment template.
default DeleteExperimentTemplateResponse	deleteExperimentTemplate(Consumer<DeleteExperimentTemplateRequest.Builder> deleteExperimentTemplateRequest) Deletes the specified experiment template.
default DeleteExperimentTemplateResponse	deleteExperimentTemplate(DeleteExperimentTemplateRequest deleteExperimentTemplateRequest) Deletes the specified experiment template.
default GetActionResponse	getAction(Consumer<GetActionRequest.Builder> getActionRequest) Gets information about the specified AWS FIS action.
default GetActionResponse	getAction(GetActionRequest getActionRequest) Gets information about the specified AWS FIS action.
default GetExperimentResponse	getExperiment(Consumer<GetExperimentRequest.Builder> getExperimentRequest) Gets information about the specified experiment.
default GetExperimentResponse	getExperiment(GetExperimentRequest getExperimentRequest) Gets information about the specified experiment.
default GetExperimentTemplateResponse	getExperimentTemplate(Consumer<GetExperimentTemplateRequest.Builder> getExperimentTemplateRequest) Gets information about the specified experiment template.
default GetExperimentTemplateResponse	getExperimentTemplate(GetExperimentTemplateRequest getExperimentTemplateRequest) Gets information about the specified experiment template.
default ListActionsResponse	listActions(Consumer<ListActionsRequest.Builder> listActionsRequest) Lists the available AWS FIS actions.
default ListActionsResponse	listActions(ListActionsRequest listActionsRequest) Lists the available AWS FIS actions.
default ListActionsIterable	listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest) Lists the available AWS FIS actions.
default ListActionsIterable	listActionsPaginator(ListActionsRequest listActionsRequest) Lists the available AWS FIS actions.
default ListExperimentsResponse	listExperiments(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest) Lists your experiments.
default ListExperimentsResponse	listExperiments(ListExperimentsRequest listExperimentsRequest) Lists your experiments.
default ListExperimentsIterable	listExperimentsPaginator(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest) Lists your experiments.
default ListExperimentsIterable	listExperimentsPaginator(ListExperimentsRequest listExperimentsRequest) Lists your experiments.
default ListExperimentTemplatesResponse	listExperimentTemplates(Consumer<ListExperimentTemplatesRequest.Builder> listExperimentTemplatesRequest) Lists your experiment templates.
default ListExperimentTemplatesResponse	listExperimentTemplates(ListExperimentTemplatesRequest listExperimentTemplatesRequest) Lists your experiment templates.
default ListExperimentTemplatesIterable	listExperimentTemplatesPaginator(Consumer<ListExperimentTemplatesRequest.Builder> listExperimentTemplatesRequest) Lists your experiment templates.
default ListExperimentTemplatesIterable	listExperimentTemplatesPaginator(ListExperimentTemplatesRequest listExperimentTemplatesRequest) Lists your experiment templates.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
static ServiceMetadata	serviceMetadata()
default StartExperimentResponse	startExperiment(Consumer<StartExperimentRequest.Builder> startExperimentRequest) Starts running an experiment from the specified experiment template.
default StartExperimentResponse	startExperiment(StartExperimentRequest startExperimentRequest) Starts running an experiment from the specified experiment template.
default StopExperimentResponse	stopExperiment(Consumer<StopExperimentRequest.Builder> stopExperimentRequest) Stops the specified experiment.
default StopExperimentResponse	stopExperiment(StopExperimentRequest stopExperimentRequest) Stops the specified experiment.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
default UpdateExperimentTemplateResponse	updateExperimentTemplate(Consumer<UpdateExperimentTemplateRequest.Builder> updateExperimentTemplateRequest) Updates the specified experiment template.
default UpdateExperimentTemplateResponse	updateExperimentTemplate(UpdateExperimentTemplateRequest updateExperimentTemplateRequest) Updates the specified experiment template.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static FisClient create()

Create a FisClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static FisClientBuilder builder()

Create a builder that can be used to configure and create a FisClient.

createExperimentTemplate

default CreateExperimentTemplateResponse createExperimentTemplate(CreateExperimentTemplateRequest createExperimentTemplateRequest)
                                                           throws ValidationException,
                                                                  ConflictException,
                                                                  ResourceNotFoundException,
                                                                  ServiceQuotaExceededException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FisException

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.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createExperimentTemplate

default CreateExperimentTemplateResponse createExperimentTemplate(Consumer<CreateExperimentTemplateRequest.Builder> createExperimentTemplateRequest)
                                                           throws ValidationException,
                                                                  ConflictException,
                                                                  ResourceNotFoundException,
                                                                  ServiceQuotaExceededException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FisException

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.

This is a convenience which creates an instance of the CreateExperimentTemplateRequest.Builder avoiding the need to create one manually via CreateExperimentTemplateRequest.builder()

Parameters:

createExperimentTemplateRequest - A Consumer that will call methods on CreateExperimentTemplateRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteExperimentTemplate

default DeleteExperimentTemplateResponse deleteExperimentTemplate(DeleteExperimentTemplateRequest deleteExperimentTemplateRequest)
                                                           throws ValidationException,
                                                                  ResourceNotFoundException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteExperimentTemplate

default DeleteExperimentTemplateResponse deleteExperimentTemplate(Consumer<DeleteExperimentTemplateRequest.Builder> deleteExperimentTemplateRequest)
                                                           throws ValidationException,
                                                                  ResourceNotFoundException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FisException

Deletes the specified experiment template.

This is a convenience which creates an instance of the DeleteExperimentTemplateRequest.Builder avoiding the need to create one manually via DeleteExperimentTemplateRequest.builder()

Parameters:

deleteExperimentTemplateRequest - A Consumer that will call methods on DeleteExperimentTemplateRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAction

default GetActionResponse getAction(GetActionRequest getActionRequest)
                             throws ValidationException,
                                    ResourceNotFoundException,
                                    AwsServiceException,
                                    SdkClientException,
                                    FisException

Gets information about the specified AWS 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getAction

default GetActionResponse getAction(Consumer<GetActionRequest.Builder> getActionRequest)
                             throws ValidationException,
                                    ResourceNotFoundException,
                                    AwsServiceException,
                                    SdkClientException,
                                    FisException

Gets information about the specified AWS FIS action.

This is a convenience which creates an instance of the GetActionRequest.Builder avoiding the need to create one manually via GetActionRequest.builder()

Parameters:

getActionRequest - A Consumer that will call methods on GetActionRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getExperiment

default GetExperimentResponse getExperiment(GetExperimentRequest getExperimentRequest)
                                     throws ValidationException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getExperiment

default GetExperimentResponse getExperiment(Consumer<GetExperimentRequest.Builder> getExperimentRequest)
                                     throws ValidationException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            FisException

Gets information about the specified experiment.

This is a convenience which creates an instance of the GetExperimentRequest.Builder avoiding the need to create one manually via GetExperimentRequest.builder()

Parameters:

getExperimentRequest - A Consumer that will call methods on GetExperimentRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getExperimentTemplate

default GetExperimentTemplateResponse getExperimentTemplate(GetExperimentTemplateRequest getExperimentTemplateRequest)
                                                     throws ValidationException,
                                                            ResourceNotFoundException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getExperimentTemplate

default GetExperimentTemplateResponse getExperimentTemplate(Consumer<GetExperimentTemplateRequest.Builder> getExperimentTemplateRequest)
                                                     throws ValidationException,
                                                            ResourceNotFoundException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            FisException

Gets information about the specified experiment template.

This is a convenience which creates an instance of the GetExperimentTemplateRequest.Builder avoiding the need to create one manually via GetExperimentTemplateRequest.builder()

Parameters:

getExperimentTemplateRequest - A Consumer that will call methods on GetExperimentTemplateRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listActions

default ListActionsResponse listActions(ListActionsRequest listActionsRequest)
                                 throws ValidationException,
                                        AwsServiceException,
                                        SdkClientException,
                                        FisException

Lists the available AWS 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listActions

default ListActionsResponse listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)
                                 throws ValidationException,
                                        AwsServiceException,
                                        SdkClientException,
                                        FisException

Lists the available AWS FIS actions.

This is a convenience which creates an instance of the ListActionsRequest.Builder avoiding the need to create one manually via ListActionsRequest.builder()

Parameters:

listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listActionsPaginator

default ListActionsIterable listActionsPaginator(ListActionsRequest listActionsRequest)
                                          throws ValidationException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 FisException

Lists the available AWS FIS actions.

This is a variant of listActions(software.amazon.awssdk.services.fis.model.ListActionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.fis.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.fis.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
     for (software.amazon.awssdk.services.fis.model.ListActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.fis.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.fis.model.ListActionsRequest) operation.

Parameters:

listActionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listActionsPaginator

default ListActionsIterable listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)
                                          throws ValidationException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 FisException

Lists the available AWS FIS actions.

This is a variant of listActions(software.amazon.awssdk.services.fis.model.ListActionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.fis.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.fis.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
     for (software.amazon.awssdk.services.fis.model.ListActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.fis.paginators.ListActionsIterable responses = client.listActionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.fis.model.ListActionsRequest) operation.

This is a convenience which creates an instance of the ListActionsRequest.Builder avoiding the need to create one manually via ListActionsRequest.builder()

Parameters:

listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperimentTemplates

default ListExperimentTemplatesResponse listExperimentTemplates(ListExperimentTemplatesRequest listExperimentTemplatesRequest)
                                                         throws ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperimentTemplates

default ListExperimentTemplatesResponse listExperimentTemplates(Consumer<ListExperimentTemplatesRequest.Builder> listExperimentTemplatesRequest)
                                                         throws ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                FisException

Lists your experiment templates.

This is a convenience which creates an instance of the ListExperimentTemplatesRequest.Builder avoiding the need to create one manually via ListExperimentTemplatesRequest.builder()

Parameters:

listExperimentTemplatesRequest - A Consumer that will call methods on ListExperimentTemplatesRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperimentTemplatesPaginator

default ListExperimentTemplatesIterable listExperimentTemplatesPaginator(ListExperimentTemplatesRequest listExperimentTemplatesRequest)
                                                                  throws ValidationException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         FisException

Lists your experiment templates.

This is a variant of listExperimentTemplates(software.amazon.awssdk.services.fis.model.ListExperimentTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentTemplatesIterable responses = client.listExperimentTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.fis.paginators.ListExperimentTemplatesIterable responses = client
             .listExperimentTemplatesPaginator(request);
     for (software.amazon.awssdk.services.fis.model.ListExperimentTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentTemplatesIterable responses = client.listExperimentTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExperimentTemplates(software.amazon.awssdk.services.fis.model.ListExperimentTemplatesRequest) operation.

Parameters:

listExperimentTemplatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperimentTemplatesPaginator

default ListExperimentTemplatesIterable listExperimentTemplatesPaginator(Consumer<ListExperimentTemplatesRequest.Builder> listExperimentTemplatesRequest)
                                                                  throws ValidationException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         FisException

Lists your experiment templates.

This is a variant of listExperimentTemplates(software.amazon.awssdk.services.fis.model.ListExperimentTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentTemplatesIterable responses = client.listExperimentTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.fis.paginators.ListExperimentTemplatesIterable responses = client
             .listExperimentTemplatesPaginator(request);
     for (software.amazon.awssdk.services.fis.model.ListExperimentTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentTemplatesIterable responses = client.listExperimentTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExperimentTemplates(software.amazon.awssdk.services.fis.model.ListExperimentTemplatesRequest) operation.

This is a convenience which creates an instance of the ListExperimentTemplatesRequest.Builder avoiding the need to create one manually via ListExperimentTemplatesRequest.builder()

Parameters:

listExperimentTemplatesRequest - A Consumer that will call methods on ListExperimentTemplatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperiments

default ListExperimentsResponse listExperiments(ListExperimentsRequest listExperimentsRequest)
                                         throws ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperiments

default ListExperimentsResponse listExperiments(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)
                                         throws ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FisException

Lists your experiments.

This is a convenience which creates an instance of the ListExperimentsRequest.Builder avoiding the need to create one manually via ListExperimentsRequest.builder()

Parameters:

listExperimentsRequest - A Consumer that will call methods on ListExperimentsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperimentsPaginator

default ListExperimentsIterable listExperimentsPaginator(ListExperimentsRequest listExperimentsRequest)
                                                  throws ValidationException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         FisException

Lists your experiments.

This is a variant of listExperiments(software.amazon.awssdk.services.fis.model.ListExperimentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.fis.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
     for (software.amazon.awssdk.services.fis.model.ListExperimentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExperiments(software.amazon.awssdk.services.fis.model.ListExperimentsRequest) operation.

Parameters:

listExperimentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listExperimentsPaginator

default ListExperimentsIterable listExperimentsPaginator(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)
                                                  throws ValidationException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         FisException

Lists your experiments.

This is a variant of listExperiments(software.amazon.awssdk.services.fis.model.ListExperimentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.fis.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
     for (software.amazon.awssdk.services.fis.model.ListExperimentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.fis.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExperiments(software.amazon.awssdk.services.fis.model.ListExperimentsRequest) operation.

This is a convenience which creates an instance of the ListExperimentsRequest.Builder avoiding the need to create one manually via ListExperimentsRequest.builder()

Parameters:

listExperimentsRequest - A Consumer that will call methods on ListExperimentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AwsServiceException,
                                                        SdkClientException,
                                                        FisException

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AwsServiceException,
                                                        SdkClientException,
                                                        FisException

Lists the tags for the specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startExperiment

default StartExperimentResponse startExperiment(StartExperimentRequest startExperimentRequest)
                                         throws ValidationException,
                                                ConflictException,
                                                ResourceNotFoundException,
                                                ServiceQuotaExceededException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

startExperiment

default StartExperimentResponse startExperiment(Consumer<StartExperimentRequest.Builder> startExperimentRequest)
                                         throws ValidationException,
                                                ConflictException,
                                                ResourceNotFoundException,
                                                ServiceQuotaExceededException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FisException

Starts running an experiment from the specified experiment template.

This is a convenience which creates an instance of the StartExperimentRequest.Builder avoiding the need to create one manually via StartExperimentRequest.builder()

Parameters:

startExperimentRequest - A Consumer that will call methods on StartExperimentRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopExperiment

default StopExperimentResponse stopExperiment(StopExperimentRequest stopExperimentRequest)
                                       throws ValidationException,
                                              ResourceNotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

stopExperiment

default StopExperimentResponse stopExperiment(Consumer<StopExperimentRequest.Builder> stopExperimentRequest)
                                       throws ValidationException,
                                              ResourceNotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              FisException

Stops the specified experiment.

This is a convenience which creates an instance of the StopExperimentRequest.Builder avoiding the need to create one manually via StopExperimentRequest.builder()

Parameters:

stopExperimentRequest - A Consumer that will call methods on StopExperimentRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws AwsServiceException,
                                        SdkClientException,
                                        FisException

Applies the specified tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws AwsServiceException,
                                        SdkClientException,
                                        FisException

Applies the specified tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AwsServiceException,
                                            SdkClientException,
                                            FisException

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AwsServiceException,
                                            SdkClientException,
                                            FisException

Removes the specified tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateExperimentTemplate

default UpdateExperimentTemplateResponse updateExperimentTemplate(UpdateExperimentTemplateRequest updateExperimentTemplateRequest)
                                                           throws ValidationException,
                                                                  ResourceNotFoundException,
                                                                  ServiceQuotaExceededException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FisException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateExperimentTemplate

default UpdateExperimentTemplateResponse updateExperimentTemplate(Consumer<UpdateExperimentTemplateRequest.Builder> updateExperimentTemplateRequest)
                                                           throws ValidationException,
                                                                  ResourceNotFoundException,
                                                                  ServiceQuotaExceededException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FisException

Updates the specified experiment template.

This is a convenience which creates an instance of the UpdateExperimentTemplateRequest.Builder avoiding the need to create one manually via UpdateExperimentTemplateRequest.builder()

Parameters:

updateExperimentTemplateRequest - A Consumer that will call methods on UpdateExperimentTemplateRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FisException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()