Interface OpsWorksCmAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface OpsWorksCmAsyncClient extends AwsClient
Service client for accessing OpsWorksCM asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. AWS OpsWorks CM

AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.

Glossary of terms

  • Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.

  • Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include ChefAutomate and Puppet.

  • Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.

  • Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.

  • Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.

Endpoints

AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.

  • opsworks-cm.us-east-1.amazonaws.com

  • opsworks-cm.us-east-2.amazonaws.com

  • opsworks-cm.us-west-1.amazonaws.com

  • opsworks-cm.us-west-2.amazonaws.com

  • opsworks-cm.ap-northeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-2.amazonaws.com

  • opsworks-cm.eu-central-1.amazonaws.com

  • opsworks-cm.eu-west-1.amazonaws.com

For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.

Throttling limits

All API operations allow for five requests per second with a burst of 10 requests per second.

  • Field Details

  • Method Details

    • associateNode

      default CompletableFuture<AssociateNodeResponse> associateNode(AssociateNodeRequest associateNodeRequest)

      Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

      On a Chef server: This command is an alternative to knife bootstrap.

      Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"

      On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

      Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"

      A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.

      Parameters:
      associateNodeRequest -
      Returns:
      A Java Future containing the result of the AssociateNode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateNode

      default CompletableFuture<AssociateNodeResponse> associateNode(Consumer<AssociateNodeRequest.Builder> associateNodeRequest)

      Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

      On a Chef server: This command is an alternative to knife bootstrap.

      Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem"

      On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

      Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem"

      A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.


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

      Parameters:
      associateNodeRequest - A Consumer that will call methods on AssociateNodeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateNode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackup

      default CompletableFuture<CreateBackupResponse> createBackup(CreateBackupRequest createBackupRequest)

      Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

      Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

      This operation is asynchronous.

      A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

      Parameters:
      createBackupRequest -
      Returns:
      A Java Future containing the result of the CreateBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • LimitExceededException The limit of servers or backups has been reached.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackup

      default CompletableFuture<CreateBackupResponse> createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)

      Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

      Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

      This operation is asynchronous.

      A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.


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

      Parameters:
      createBackupRequest - A Consumer that will call methods on CreateBackupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • LimitExceededException The limit of servers or backups has been reached.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createServer

      default CompletableFuture<CreateServerResponse> createServer(CreateServerRequest createServerRequest)

      Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

      This operation is asynchronous.

      A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

      If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

      Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

      Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

      By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

      To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.

      Parameters:
      createServerRequest -
      Returns:
      A Java Future containing the result of the CreateServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • LimitExceededException The limit of servers or backups has been reached.
      • ResourceAlreadyExistsException The requested resource cannot be created because it already exists.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createServer

      default CompletableFuture<CreateServerResponse> createServer(Consumer<CreateServerRequest.Builder> createServerRequest)

      Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

      This operation is asynchronous.

      A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

      If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

      Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

      Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

      By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

      To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.


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

      Parameters:
      createServerRequest - A Consumer that will call methods on CreateServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • LimitExceededException The limit of servers or backups has been reached.
      • ResourceAlreadyExistsException The requested resource cannot be created because it already exists.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackup

      default CompletableFuture<DeleteBackupResponse> deleteBackup(DeleteBackupRequest deleteBackupRequest)

      Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

      An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

      Parameters:
      deleteBackupRequest -
      Returns:
      A Java Future containing the result of the DeleteBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackup

      default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)

      Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

      An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.


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

      Parameters:
      deleteBackupRequest - A Consumer that will call methods on DeleteBackupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteServer

      default CompletableFuture<DeleteServerResponse> deleteServer(DeleteServerRequest deleteServerRequest)

      Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

      This operation is asynchronous.

      An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      deleteServerRequest -
      Returns:
      A Java Future containing the result of the DeleteServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteServer

      default CompletableFuture<DeleteServerResponse> deleteServer(Consumer<DeleteServerRequest.Builder> deleteServerRequest)

      Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

      This operation is asynchronous.

      An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      deleteServerRequest - A Consumer that will call methods on DeleteServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountAttributes

      default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)

      Describes your OpsWorks-CM account attributes.

      This operation is synchronous.

      Parameters:
      describeAccountAttributesRequest -
      Returns:
      A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountAttributes

      default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest)

      Describes your OpsWorks-CM account attributes.

      This operation is synchronous.


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

      Parameters:
      describeAccountAttributesRequest - A Consumer that will call methods on DescribeAccountAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountAttributes

      default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes()

      Describes your OpsWorks-CM account attributes.

      This operation is synchronous.

      Returns:
      A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackups

      default CompletableFuture<DescribeBackupsResponse> describeBackups(DescribeBackupsRequest describeBackupsRequest)

      Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      describeBackupsRequest -
      Returns:
      A Java Future containing the result of the DescribeBackups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackups

      default CompletableFuture<DescribeBackupsResponse> describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)

      Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBackups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackups

      default CompletableFuture<DescribeBackupsResponse> describeBackups()

      Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

      Returns:
      A Java Future containing the result of the DescribeBackups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupsPaginator

      default DescribeBackupsPublisher describeBackupsPaginator()

      This is a variant of describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupsPaginator

      default DescribeBackupsPublisher describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)

      This is a variant of describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest) operation.

      Parameters:
      describeBackupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupsPaginator

      default DescribeBackupsPublisher describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)

      This is a variant of describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeBackups(software.amazon.awssdk.services.opsworkscm.model.DescribeBackupsRequest) operation.


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

      Parameters:
      describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)

      Describes events for a specified server. Results are ordered by time, with newest events first.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      describeEventsRequest -
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)

      Describes events for a specified server. Results are ordered by time, with newest events first.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)

      This is a variant of describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest) operation.

      Parameters:
      describeEventsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)

      This is a variant of describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeEvents(software.amazon.awssdk.services.opsworkscm.model.DescribeEventsRequest) operation.


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

      Parameters:
      describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNodeAssociationStatus

      default CompletableFuture<DescribeNodeAssociationStatusResponse> describeNodeAssociationStatus(DescribeNodeAssociationStatusRequest describeNodeAssociationStatusRequest)

      Returns the current status of an existing association or disassociation request.

      A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      describeNodeAssociationStatusRequest -
      Returns:
      A Java Future containing the result of the DescribeNodeAssociationStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNodeAssociationStatus

      default CompletableFuture<DescribeNodeAssociationStatusResponse> describeNodeAssociationStatus(Consumer<DescribeNodeAssociationStatusRequest.Builder> describeNodeAssociationStatusRequest)

      Returns the current status of an existing association or disassociation request.

      A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      describeNodeAssociationStatusRequest - A Consumer that will call methods on DescribeNodeAssociationStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeNodeAssociationStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServers

      default CompletableFuture<DescribeServersResponse> describeServers(DescribeServersRequest describeServersRequest)

      Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      describeServersRequest -
      Returns:
      A Java Future containing the result of the DescribeServers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServers

      default CompletableFuture<DescribeServersResponse> describeServers(Consumer<DescribeServersRequest.Builder> describeServersRequest)

      Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      describeServersRequest - A Consumer that will call methods on DescribeServersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeServers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServers

      default CompletableFuture<DescribeServersResponse> describeServers()

      Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

      This operation is synchronous.

      A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Returns:
      A Java Future containing the result of the DescribeServers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServersPaginator

      default DescribeServersPublisher describeServersPaginator()

      This is a variant of describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersPublisher publisher = client.describeServersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersPublisher publisher = client.describeServersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServersPaginator

      default DescribeServersPublisher describeServersPaginator(DescribeServersRequest describeServersRequest)

      This is a variant of describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersPublisher publisher = client.describeServersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersPublisher publisher = client.describeServersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest) operation.

      Parameters:
      describeServersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServersPaginator

      default DescribeServersPublisher describeServersPaginator(Consumer<DescribeServersRequest.Builder> describeServersRequest)

      This is a variant of describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersPublisher publisher = client.describeServersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.DescribeServersPublisher publisher = client.describeServersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.DescribeServersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeServers(software.amazon.awssdk.services.opsworkscm.model.DescribeServersRequest) operation.


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

      Parameters:
      describeServersRequest - A Consumer that will call methods on DescribeServersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidNextTokenException This occurs when the provided nextToken is not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateNode

      default CompletableFuture<DisassociateNodeResponse> disassociateNode(DisassociateNodeRequest disassociateNodeRequest)

      Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

      A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      disassociateNodeRequest -
      Returns:
      A Java Future containing the result of the DisassociateNode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateNode

      default CompletableFuture<DisassociateNodeResponse> disassociateNode(Consumer<DisassociateNodeRequest.Builder> disassociateNodeRequest)

      Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

      A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      disassociateNodeRequest - A Consumer that will call methods on DisassociateNodeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateNode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportServerEngineAttribute

      default CompletableFuture<ExportServerEngineAttributeResponse> exportServerEngineAttribute(ExportServerEngineAttributeRequest exportServerEngineAttributeRequest)

      Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

      This operation is synchronous.

      A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.

      Parameters:
      exportServerEngineAttributeRequest -
      Returns:
      A Java Future containing the result of the ExportServerEngineAttribute operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportServerEngineAttribute

      default CompletableFuture<ExportServerEngineAttributeResponse> exportServerEngineAttribute(Consumer<ExportServerEngineAttributeRequest.Builder> exportServerEngineAttributeRequest)

      Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

      This operation is synchronous.

      A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.


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

      Parameters:
      exportServerEngineAttributeRequest - A Consumer that will call methods on ExportServerEngineAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportServerEngineAttribute operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException One or more of the provided request parameters are not valid.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.


      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opsworkscm.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listTagsForResource(software.amazon.awssdk.services.opsworkscm.model.ListTagsForResourceRequest) operation.


      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:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreServer

      default CompletableFuture<RestoreServerResponse> restoreServer(RestoreServerRequest restoreServerRequest)

      Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

      Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

      This operation is asynchronous.

      An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      restoreServerRequest -
      Returns:
      A Java Future containing the result of the RestoreServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreServer

      default CompletableFuture<RestoreServerResponse> restoreServer(Consumer<RestoreServerRequest.Builder> restoreServerRequest)

      Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

      Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a Running or Stopped state, but is eventually terminated.

      This operation is asynchronous.

      An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      restoreServerRequest - A Consumer that will call methods on RestoreServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestoreServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startMaintenance

      default CompletableFuture<StartMaintenanceResponse> startMaintenance(StartMaintenanceRequest startMaintenanceRequest)

      Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.

      Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      startMaintenanceRequest -
      Returns:
      A Java Future containing the result of the StartMaintenance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startMaintenance

      default CompletableFuture<StartMaintenanceResponse> startMaintenance(Consumer<StartMaintenanceRequest.Builder> startMaintenanceRequest)

      Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.

      Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      startMaintenanceRequest - A Consumer that will call methods on StartMaintenanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartMaintenance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.


      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes specified tags from an AWS OpsWorks-CM server or backup.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes specified tags from an AWS OpsWorks-CM server or backup.


      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateServer

      default CompletableFuture<UpdateServerResponse> updateServer(UpdateServerRequest updateServerRequest)

      Updates settings for a server.

      This operation is synchronous.

      Parameters:
      updateServerRequest -
      Returns:
      A Java Future containing the result of the UpdateServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateServer

      default CompletableFuture<UpdateServerResponse> updateServer(Consumer<UpdateServerRequest.Builder> updateServerRequest)

      Updates settings for a server.

      This operation is synchronous.


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

      Parameters:
      updateServerRequest - A Consumer that will call methods on UpdateServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateServerEngineAttributes

      default CompletableFuture<UpdateServerEngineAttributesResponse> updateServerEngineAttributes(UpdateServerEngineAttributesRequest updateServerEngineAttributesRequest)

      Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password ( PUPPET_ADMIN_PASSWORD).

      This operation is asynchronous.

      This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

      Parameters:
      updateServerEngineAttributesRequest -
      Returns:
      A Java Future containing the result of the UpdateServerEngineAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateServerEngineAttributes

      default CompletableFuture<UpdateServerEngineAttributesResponse> updateServerEngineAttributes(Consumer<UpdateServerEngineAttributesRequest.Builder> updateServerEngineAttributesRequest)

      Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password ( PUPPET_ADMIN_PASSWORD).

      This operation is asynchronous.

      This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.


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

      Parameters:
      updateServerEngineAttributesRequest - A Consumer that will call methods on UpdateServerEngineAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateServerEngineAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidStateException The resource is in a state that does not allow you to perform a specified action.
      • ResourceNotFoundException The requested resource does not exist, or access was denied.
      • ValidationException One or more of the provided request parameters are not valid.
      • 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.
      • OpsWorksCmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default OpsWorksCmAsyncWaiter waiter()
      Create an instance of OpsWorksCmAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of OpsWorksCmAsyncWaiter

    • serviceClientConfiguration

      default OpsWorksCmServiceClientConfiguration 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

    • create

      static OpsWorksCmAsyncClient create()
      Create a OpsWorksCmAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static OpsWorksCmAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a OpsWorksCmAsyncClient.