Package software.amazon.awssdk.services.support

Interface SupportAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SupportAsyncClient extends AwsClient
Service client for accessing AWS Support 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. Amazon Web Services Support

The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following Amazon Web Services Support API operations:

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.

For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

  • Field Details

  • Method Details

    • addAttachmentsToSet

      default CompletableFuture<AddAttachmentsToSetResponse> addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)

      Adds one or more attachments to an attachment set.

      An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      addAttachmentsToSetRequest -
      Returns:
      A Java Future containing the result of the AddAttachmentsToSet 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.
      • InternalServerErrorException An internal server error occurred.
      • AttachmentSetIdNotFoundException An attachment set with the specified ID could not be found.
      • AttachmentSetExpiredException The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • AttachmentSetSizeLimitExceededException A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
      • AttachmentLimitExceededException The limit for the number of attachment sets created in a short period of time has been exceeded.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addAttachmentsToSet

      default CompletableFuture<AddAttachmentsToSetResponse> addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest)

      Adds one or more attachments to an attachment set.

      An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      addAttachmentsToSetRequest - A Consumer that will call methods on AddAttachmentsToSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddAttachmentsToSet 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.
      • InternalServerErrorException An internal server error occurred.
      • AttachmentSetIdNotFoundException An attachment set with the specified ID could not be found.
      • AttachmentSetExpiredException The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • AttachmentSetSizeLimitExceededException A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
      • AttachmentLimitExceededException The limit for the number of attachment sets created in a short period of time has been exceeded.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addCommunicationToCase

      default CompletableFuture<AddCommunicationToCaseResponse> addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)

      Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      addCommunicationToCaseRequest -
      Returns:
      A Java Future containing the result of the AddCommunicationToCase 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • AttachmentSetIdNotFoundException An attachment set with the specified ID could not be found.
      • AttachmentSetExpiredException The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addCommunicationToCase

      default CompletableFuture<AddCommunicationToCaseResponse> addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest)

      Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      addCommunicationToCaseRequest - A Consumer that will call methods on AddCommunicationToCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddCommunicationToCase 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • AttachmentSetIdNotFoundException An attachment set with the specified ID could not be found.
      • AttachmentSetExpiredException The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCase

      default CompletableFuture<CreateCaseResponse> createCase(CreateCaseRequest createCaseRequest)

      Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.

      The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:

      A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.

      The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      createCaseRequest -
      Returns:
      A Java Future containing the result of the CreateCase 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseCreationLimitExceededException The case creation limit for the account has been exceeded.
      • AttachmentSetIdNotFoundException An attachment set with the specified ID could not be found.
      • AttachmentSetExpiredException The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCase

      default CompletableFuture<CreateCaseResponse> createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)

      Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.

      The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:

      A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.

      The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      createCaseRequest - A Consumer that will call methods on CreateCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCase 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseCreationLimitExceededException The case creation limit for the account has been exceeded.
      • AttachmentSetIdNotFoundException An attachment set with the specified ID could not be found.
      • AttachmentSetExpiredException The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAttachment

      default CompletableFuture<DescribeAttachmentResponse> describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)

      Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeAttachmentRequest -
      Returns:
      A Java Future containing the result of the DescribeAttachment 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.
      • InternalServerErrorException An internal server error occurred.
      • DescribeAttachmentLimitExceededException The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
      • AttachmentIdNotFoundException An attachment with the specified ID could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAttachment

      default CompletableFuture<DescribeAttachmentResponse> describeAttachment(Consumer<DescribeAttachmentRequest.Builder> describeAttachmentRequest)

      Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeAttachmentRequest - A Consumer that will call methods on DescribeAttachmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAttachment 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.
      • InternalServerErrorException An internal server error occurred.
      • DescribeAttachmentLimitExceededException The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
      • AttachmentIdNotFoundException An attachment with the specified ID could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCases

      default CompletableFuture<DescribeCasesResponse> describeCases(DescribeCasesRequest describeCasesRequest)

      Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

      The response returns the following in JSON format:

      • One or more CaseDetails data types.

      • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

      Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeCasesRequest -
      Returns:
      A Java Future containing the result of the DescribeCases 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCases

      default CompletableFuture<DescribeCasesResponse> describeCases(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)

      Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

      The response returns the following in JSON format:

      • One or more CaseDetails data types.

      • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

      Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeCasesRequest - A Consumer that will call methods on DescribeCasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCases 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCasesPaginator

      default DescribeCasesPublisher describeCasesPaginator(DescribeCasesRequest describeCasesRequest)

      This is a variant of describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest) 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.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.support.model.DescribeCasesResponse 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 describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest) operation.

      Parameters:
      describeCasesRequest -
      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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCasesPaginator

      default DescribeCasesPublisher describeCasesPaginator(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)

      This is a variant of describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest) 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.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.support.model.DescribeCasesResponse 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 describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest) operation.


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

      Parameters:
      describeCasesRequest - A Consumer that will call methods on DescribeCasesRequest.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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCommunications

      default CompletableFuture<DescribeCommunicationsResponse> describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)

      Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

      Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

      You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeCommunicationsRequest -
      Returns:
      A Java Future containing the result of the DescribeCommunications 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCommunications

      default CompletableFuture<DescribeCommunicationsResponse> describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)

      Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

      Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

      You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeCommunicationsRequest - A Consumer that will call methods on DescribeCommunicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCommunications 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCommunicationsPaginator

      default DescribeCommunicationsPublisher describeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest)

      This is a variant of describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest) 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.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse 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 describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest) operation.

      Parameters:
      describeCommunicationsRequest -
      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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCommunicationsPaginator

      default DescribeCommunicationsPublisher describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)

      This is a variant of describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest) 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.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse 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 describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest) operation.


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

      Parameters:
      describeCommunicationsRequest - A Consumer that will call methods on DescribeCommunicationsRequest.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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCreateCaseOptions

      default CompletableFuture<DescribeCreateCaseOptionsResponse> describeCreateCaseOptions(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest)

      Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeCreateCaseOptionsRequest -
      Returns:
      A Java Future containing the result of the DescribeCreateCaseOptions 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCreateCaseOptions

      default CompletableFuture<DescribeCreateCaseOptionsResponse> describeCreateCaseOptions(Consumer<DescribeCreateCaseOptionsRequest.Builder> describeCreateCaseOptionsRequest)

      Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeCreateCaseOptionsRequest - A Consumer that will call methods on DescribeCreateCaseOptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCreateCaseOptions 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServices

      default CompletableFuture<DescribeServicesResponse> describeServices(DescribeServicesRequest describeServicesRequest)

      Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

      The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeServicesRequest -
      Returns:
      A Java Future containing the result of the DescribeServices 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.
      • InternalServerErrorException An internal server error occurred.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeServices

      default CompletableFuture<DescribeServicesResponse> describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)

      Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.

      The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeServicesRequest - A Consumer that will call methods on DescribeServicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeServices 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.
      • InternalServerErrorException An internal server error occurred.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSeverityLevels

      default CompletableFuture<DescribeSeverityLevelsResponse> describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)

      Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeSeverityLevelsRequest -
      Returns:
      A Java Future containing the result of the DescribeSeverityLevels 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.
      • InternalServerErrorException An internal server error occurred.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSeverityLevels

      default CompletableFuture<DescribeSeverityLevelsResponse> describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest)

      Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeSeverityLevelsRequest - A Consumer that will call methods on DescribeSeverityLevelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSeverityLevels 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.
      • InternalServerErrorException An internal server error occurred.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSupportedLanguages

      default CompletableFuture<DescribeSupportedLanguagesResponse> describeSupportedLanguages(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest)

      Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      describeSupportedLanguagesRequest -
      Returns:
      A Java Future containing the result of the DescribeSupportedLanguages 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSupportedLanguages

      default CompletableFuture<DescribeSupportedLanguagesResponse> describeSupportedLanguages(Consumer<DescribeSupportedLanguagesRequest.Builder> describeSupportedLanguagesRequest)

      Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      describeSupportedLanguagesRequest - A Consumer that will call methods on DescribeSupportedLanguagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSupportedLanguages 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorCheckRefreshStatuses

      default CompletableFuture<DescribeTrustedAdvisorCheckRefreshStatusesResponse> describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)

      Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

      Parameters:
      describeTrustedAdvisorCheckRefreshStatusesRequest -
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorCheckRefreshStatuses 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorCheckRefreshStatuses

      default CompletableFuture<DescribeTrustedAdvisorCheckRefreshStatusesResponse> describeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest)

      Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.


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

      Parameters:
      describeTrustedAdvisorCheckRefreshStatusesRequest - A Consumer that will call methods on DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorCheckRefreshStatuses 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorCheckResult

      default CompletableFuture<DescribeTrustedAdvisorCheckResultResponse> describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)

      Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

      In addition, the response contains these fields:

      • status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.

      • timestamp - The time of the last refresh of the check.

      • checkId - The unique identifier for the check.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

      Parameters:
      describeTrustedAdvisorCheckResultRequest -
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorCheckResult 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorCheckResult

      default CompletableFuture<DescribeTrustedAdvisorCheckResultResponse> describeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest)

      Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

      In addition, the response contains these fields:

      • status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.

      • timestamp - The time of the last refresh of the check.

      • checkId - The unique identifier for the check.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.


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

      Parameters:
      describeTrustedAdvisorCheckResultRequest - A Consumer that will call methods on DescribeTrustedAdvisorCheckResultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorCheckResult 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorCheckSummaries

      default CompletableFuture<DescribeTrustedAdvisorCheckSummariesResponse> describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)

      Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      The response contains an array of TrustedAdvisorCheckSummary objects.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

      Parameters:
      describeTrustedAdvisorCheckSummariesRequest -
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorCheckSummaries 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorCheckSummaries

      default CompletableFuture<DescribeTrustedAdvisorCheckSummariesResponse> describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest)

      Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      The response contains an array of TrustedAdvisorCheckSummary objects.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.


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

      Parameters:
      describeTrustedAdvisorCheckSummariesRequest - A Consumer that will call methods on DescribeTrustedAdvisorCheckSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorCheckSummaries 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorChecks

      default CompletableFuture<DescribeTrustedAdvisorChecksResponse> describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)

      Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

      The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      • The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

      Parameters:
      describeTrustedAdvisorChecksRequest -
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorChecks 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrustedAdvisorChecks

      default CompletableFuture<DescribeTrustedAdvisorChecksResponse> describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest)

      Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

      The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      • The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.


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

      Parameters:
      describeTrustedAdvisorChecksRequest - A Consumer that will call methods on DescribeTrustedAdvisorChecksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrustedAdvisorChecks 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.
      • InternalServerErrorException An internal server error occurred.
      • ThrottlingException You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • refreshTrustedAdvisorCheck

      default CompletableFuture<RefreshTrustedAdvisorCheckResponse> refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)

      Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.

      The response contains a TrustedAdvisorCheckRefreshStatus object.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

      Parameters:
      refreshTrustedAdvisorCheckRequest -
      Returns:
      A Java Future containing the result of the RefreshTrustedAdvisorCheck 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.
      • InternalServerErrorException An internal server error occurred.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • refreshTrustedAdvisorCheck

      default CompletableFuture<RefreshTrustedAdvisorCheckResponse> refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest)

      Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

      Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.

      The response contains a TrustedAdvisorCheckRefreshStatus object.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.


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

      Parameters:
      refreshTrustedAdvisorCheckRequest - A Consumer that will call methods on RefreshTrustedAdvisorCheckRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RefreshTrustedAdvisorCheck 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.
      • InternalServerErrorException An internal server error occurred.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resolveCase

      default CompletableFuture<ResolveCaseResponse> resolveCase(ResolveCaseRequest resolveCaseRequest)

      Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

      Parameters:
      resolveCaseRequest -
      Returns:
      A Java Future containing the result of the ResolveCase 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resolveCase

      default CompletableFuture<ResolveCaseResponse> resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest)

      Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.

      • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

      • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.


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

      Parameters:
      resolveCaseRequest - A Consumer that will call methods on ResolveCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResolveCase 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.
      • InternalServerErrorException An internal server error occurred.
      • CaseIdNotFoundException The requested caseId couldn't be located.
      • 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.
      • SupportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SupportServiceClientConfiguration 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 SupportAsyncClient create()
      Create a SupportAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SupportAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SupportAsyncClient.