Interface EvsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface EvsClient
extends AwsClient

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

Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).

Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static EvsClientBuilder	builder()	Create a builder that can be used to configure and create a EvsClient.
static EvsClient	create()	Create a EvsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateEnvironmentResponse	createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)	Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.
default CreateEnvironmentResponse	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)	Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.
default CreateEnvironmentHostResponse	createEnvironmentHost(Consumer<CreateEnvironmentHostRequest.Builder> createEnvironmentHostRequest)	Creates an ESXi host and adds it to an Amazon EVS environment.
default CreateEnvironmentHostResponse	createEnvironmentHost(CreateEnvironmentHostRequest createEnvironmentHostRequest)	Creates an ESXi host and adds it to an Amazon EVS environment.
default DeleteEnvironmentResponse	deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)	Deletes an Amazon EVS environment.
default DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)	Deletes an Amazon EVS environment.
default DeleteEnvironmentHostResponse	deleteEnvironmentHost(Consumer<DeleteEnvironmentHostRequest.Builder> deleteEnvironmentHostRequest)	Deletes a host from an Amazon EVS environment.
default DeleteEnvironmentHostResponse	deleteEnvironmentHost(DeleteEnvironmentHostRequest deleteEnvironmentHostRequest)	Deletes a host from an Amazon EVS environment.
default GetEnvironmentResponse	getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)	Returns a description of the specified environment.
default GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest getEnvironmentRequest)	Returns a description of the specified environment.
default ListEnvironmentHostsResponse	listEnvironmentHosts(Consumer<ListEnvironmentHostsRequest.Builder> listEnvironmentHostsRequest)	List the hosts within an environment.
default ListEnvironmentHostsResponse	listEnvironmentHosts(ListEnvironmentHostsRequest listEnvironmentHostsRequest)	List the hosts within an environment.
default ListEnvironmentHostsIterable	listEnvironmentHostsPaginator(Consumer<ListEnvironmentHostsRequest.Builder> listEnvironmentHostsRequest)	This is a variant of listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) operation.
default ListEnvironmentHostsIterable	listEnvironmentHostsPaginator(ListEnvironmentHostsRequest listEnvironmentHostsRequest)	This is a variant of listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) operation.
default ListEnvironmentsResponse	listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
default ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)	Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
default ListEnvironmentsIterable	listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) operation.
default ListEnvironmentsIterable	listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) operation.
default ListEnvironmentVlansResponse	listEnvironmentVlans(Consumer<ListEnvironmentVlansRequest.Builder> listEnvironmentVlansRequest)	Lists environment VLANs that are associated with the specified environment.
default ListEnvironmentVlansResponse	listEnvironmentVlans(ListEnvironmentVlansRequest listEnvironmentVlansRequest)	Lists environment VLANs that are associated with the specified environment.
default ListEnvironmentVlansIterable	listEnvironmentVlansPaginator(Consumer<ListEnvironmentVlansRequest.Builder> listEnvironmentVlansRequest)	This is a variant of listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) operation.
default ListEnvironmentVlansIterable	listEnvironmentVlansPaginator(ListEnvironmentVlansRequest listEnvironmentVlansRequest)	This is a variant of listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags for an Amazon EVS resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags for an Amazon EVS resource.
default EvsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associates the specified tags to an Amazon EVS resource with the specified resourceArn.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associates the specified tags to an Amazon EVS resource with the specified resourceArn.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Deletes specified tags from an Amazon EVS resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Deletes specified tags from an Amazon EVS resource.

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

close

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

serviceName

Field Details

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 Details

createEnvironment

default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
                                             throws ValidationException,
AwsServiceException,
SdkClientException,
EvsException

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

Parameters:

createEnvironmentRequest -

Returns:

Result of the CreateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

createEnvironment

default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
                                             throws ValidationException,
AwsServiceException,
SdkClientException,
EvsException

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

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

Parameters:

createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentRequest.Builder to create a request.

Returns:

Result of the CreateEnvironment operation returned by the service.

See Also:

• AWS API Documentation

createEnvironmentHost

default CreateEnvironmentHostResponse createEnvironmentHost(CreateEnvironmentHostRequest createEnvironmentHostRequest)
                                                     throws ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
EvsException

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

Parameters:

createEnvironmentHostRequest -

Returns:

Result of the CreateEnvironmentHost operation returned by the service.

See Also:

• AWS API Documentation

createEnvironmentHost

default CreateEnvironmentHostResponse createEnvironmentHost(Consumer<CreateEnvironmentHostRequest.Builder> createEnvironmentHostRequest)
                                                     throws ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
EvsException

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

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

Parameters:

createEnvironmentHostRequest - A Consumer that will call methods on CreateEnvironmentHostRequest.Builder to create a request.

Returns:

Result of the CreateEnvironmentHost operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
                                             throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Deletes an Amazon EVS environment.

Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs.

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
                                             throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Deletes an Amazon EVS environment.

Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs.

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

Parameters:

deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentRequest.Builder to create a request.

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironmentHost

default DeleteEnvironmentHostResponse deleteEnvironmentHost(DeleteEnvironmentHostRequest deleteEnvironmentHostRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Deletes a host from an Amazon EVS environment.

Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.

Parameters:

deleteEnvironmentHostRequest -

Returns:

Result of the DeleteEnvironmentHost operation returned by the service.

See Also:

• AWS API Documentation

deleteEnvironmentHost

default DeleteEnvironmentHostResponse deleteEnvironmentHost(Consumer<DeleteEnvironmentHostRequest.Builder> deleteEnvironmentHostRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Deletes a host from an Amazon EVS environment.

Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.

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

Parameters:

deleteEnvironmentHostRequest - A Consumer that will call methods on DeleteEnvironmentHostRequest.Builder to create a request.

Returns:

Result of the DeleteEnvironmentHost operation returned by the service.

See Also:

• AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
                                       throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Returns a description of the specified environment.

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

• AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
                                       throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Returns a description of the specified environment.

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

Parameters:

getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentRequest.Builder to create a request.

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentHosts

default ListEnvironmentHostsResponse listEnvironmentHosts(ListEnvironmentHostsRequest listEnvironmentHostsRequest)
                                                   throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

List the hosts within an environment.

Parameters:

listEnvironmentHostsRequest -

Returns:

Result of the ListEnvironmentHosts operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentHosts

default ListEnvironmentHostsResponse listEnvironmentHosts(Consumer<ListEnvironmentHostsRequest.Builder> listEnvironmentHostsRequest)
                                                   throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

List the hosts within an environment.

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

Parameters:

listEnvironmentHostsRequest - A Consumer that will call methods on ListEnvironmentHostsRequest.Builder to create a request.

Returns:

Result of the ListEnvironmentHosts operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentHostsPaginator

default ListEnvironmentHostsIterable listEnvironmentHostsPaginator(ListEnvironmentHostsRequest listEnvironmentHostsRequest)
                                                            throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

This is a variant of listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) 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.evs.paginators.ListEnvironmentHostsIterable responses = client.listEnvironmentHostsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsIterable responses = client
             .listEnvironmentHostsPaginator(request);
     for (software.amazon.awssdk.services.evs.model.ListEnvironmentHostsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsIterable responses = client.listEnvironmentHostsPaginator(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 listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) operation.

Parameters:

listEnvironmentHostsRequest -

Returns:

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

See Also:

• AWS API Documentation

listEnvironmentHostsPaginator

default ListEnvironmentHostsIterable listEnvironmentHostsPaginator(Consumer<ListEnvironmentHostsRequest.Builder> listEnvironmentHostsRequest)
                                                            throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

This is a variant of listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) 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.evs.paginators.ListEnvironmentHostsIterable responses = client.listEnvironmentHostsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsIterable responses = client
             .listEnvironmentHostsPaginator(request);
     for (software.amazon.awssdk.services.evs.model.ListEnvironmentHostsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentHostsIterable responses = client.listEnvironmentHostsPaginator(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 listEnvironmentHosts(software.amazon.awssdk.services.evs.model.ListEnvironmentHostsRequest) operation.

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

Parameters:

listEnvironmentHostsRequest - A Consumer that will call methods on ListEnvironmentHostsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listEnvironmentVlans

default ListEnvironmentVlansResponse listEnvironmentVlans(ListEnvironmentVlansRequest listEnvironmentVlansRequest)
                                                   throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Lists environment VLANs that are associated with the specified environment.

Parameters:

listEnvironmentVlansRequest -

Returns:

Result of the ListEnvironmentVlans operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentVlans

default ListEnvironmentVlansResponse listEnvironmentVlans(Consumer<ListEnvironmentVlansRequest.Builder> listEnvironmentVlansRequest)
                                                   throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Lists environment VLANs that are associated with the specified environment.

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

Parameters:

listEnvironmentVlansRequest - A Consumer that will call methods on ListEnvironmentVlansRequest.Builder to create a request.

Returns:

Result of the ListEnvironmentVlans operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentVlansPaginator

default ListEnvironmentVlansIterable listEnvironmentVlansPaginator(ListEnvironmentVlansRequest listEnvironmentVlansRequest)
                                                            throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

This is a variant of listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) 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.evs.paginators.ListEnvironmentVlansIterable responses = client.listEnvironmentVlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansIterable responses = client
             .listEnvironmentVlansPaginator(request);
     for (software.amazon.awssdk.services.evs.model.ListEnvironmentVlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansIterable responses = client.listEnvironmentVlansPaginator(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 listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) operation.

Parameters:

listEnvironmentVlansRequest -

Returns:

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

See Also:

• AWS API Documentation

listEnvironmentVlansPaginator

default ListEnvironmentVlansIterable listEnvironmentVlansPaginator(Consumer<ListEnvironmentVlansRequest.Builder> listEnvironmentVlansRequest)
                                                            throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

This is a variant of listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) 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.evs.paginators.ListEnvironmentVlansIterable responses = client.listEnvironmentVlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansIterable responses = client
             .listEnvironmentVlansPaginator(request);
     for (software.amazon.awssdk.services.evs.model.ListEnvironmentVlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentVlansIterable responses = client.listEnvironmentVlansPaginator(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 listEnvironmentVlans(software.amazon.awssdk.services.evs.model.ListEnvironmentVlansRequest) operation.

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

Parameters:

listEnvironmentVlansRequest - A Consumer that will call methods on ListEnvironmentVlansRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
                                           throws ValidationException,
AwsServiceException,
SdkClientException,
EvsException

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                           throws ValidationException,
AwsServiceException,
SdkClientException,
EvsException

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

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

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
                                                    throws ValidationException,
AwsServiceException,
SdkClientException,
EvsException

This is a variant of listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) 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.evs.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evs.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.evs.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(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 listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) operation.

Parameters:

listEnvironmentsRequest -

Returns:

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

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                                    throws ValidationException,
AwsServiceException,
SdkClientException,
EvsException

This is a variant of listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) 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.evs.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evs.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.evs.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evs.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(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 listEnvironments(software.amazon.awssdk.services.evs.model.ListEnvironmentsRequest) operation.

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

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvsException

Lists the tags for an Amazon EVS resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

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

Lists the tags for an Amazon EVS 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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
TooManyTagsException,
TagPolicyException,
AwsServiceException,
SdkClientException,
EvsException

Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
TooManyTagsException,
TagPolicyException,
AwsServiceException,
SdkClientException,
EvsException

Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

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.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
TagPolicyException,
AwsServiceException,
SdkClientException,
EvsException

Deletes specified tags from an Amazon EVS resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

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

Deletes specified tags from an Amazon EVS 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.

See Also:

• AWS API Documentation

create

static EvsClient create()

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

builder

static EvsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default EvsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration