Interface PricingPlanManagerAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface PricingPlanManagerAsyncClient extends AwsClient
Service client for accessing PricingPlanManager 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.

Manages flat-rate pricing subscriptions for supported AWS services. Use this API to create, approve, update, and cancel subscriptions; associate and disassociate resources; and retrieve subscription details. With a flat-rate pricing subscription, you pay a fixed recurring fee for eligible resources instead of usage-based pricing.

  • Field Details

  • Method Details

    • approvePaidSubscription

      default CompletableFuture<ApprovePaidSubscriptionResponse> approvePaidSubscription(ApprovePaidSubscriptionRequest approvePaidSubscriptionRequest)

      Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

      This operation requires the current ETag value for concurrency control. Retrieve it from a previous GetSubscription or ListSubscriptions response.

      Parameters:
      approvePaidSubscriptionRequest -
      Returns:
      A Java Future containing the result of the ApprovePaidSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • approvePaidSubscription

      default CompletableFuture<ApprovePaidSubscriptionResponse> approvePaidSubscription(Consumer<ApprovePaidSubscriptionRequest.Builder> approvePaidSubscriptionRequest)

      Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

      This operation requires the current ETag value for concurrency control. Retrieve it from a previous GetSubscription or ListSubscriptions response.


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

      Parameters:
      approvePaidSubscriptionRequest - A Consumer that will call methods on ApprovePaidSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ApprovePaidSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateResourcesToSubscription

      default CompletableFuture<AssociateResourcesToSubscriptionResponse> associateResourcesToSubscription(AssociateResourcesToSubscriptionRequest associateResourcesToSubscriptionRequest)

      Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

      For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.

      Parameters:
      associateResourcesToSubscriptionRequest -
      Returns:
      A Java Future containing the result of the AssociateResourcesToSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateResourcesToSubscription

      default CompletableFuture<AssociateResourcesToSubscriptionResponse> associateResourcesToSubscription(Consumer<AssociateResourcesToSubscriptionRequest.Builder> associateResourcesToSubscriptionRequest)

      Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

      For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.


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

      Parameters:
      associateResourcesToSubscriptionRequest - A Consumer that will call methods on AssociateResourcesToSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateResourcesToSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelSubscription

      default CompletableFuture<CancelSubscriptionResponse> cancelSubscription(CancelSubscriptionRequest cancelSubscriptionRequest)

      Cancels a flat-rate pricing subscription.

      For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use CancelSubscriptionChange.

      For subscriptions in PENDING_APPROVAL status, the subscription is deleted immediately without scheduling.

      Parameters:
      cancelSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CancelSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelSubscription

      default CompletableFuture<CancelSubscriptionResponse> cancelSubscription(Consumer<CancelSubscriptionRequest.Builder> cancelSubscriptionRequest)

      Cancels a flat-rate pricing subscription.

      For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use CancelSubscriptionChange.

      For subscriptions in PENDING_APPROVAL status, the subscription is deleted immediately without scheduling.


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

      Parameters:
      cancelSubscriptionRequest - A Consumer that will call methods on CancelSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelSubscriptionChange

      default CompletableFuture<CancelSubscriptionChangeResponse> cancelSubscriptionChange(CancelSubscriptionChangeRequest cancelSubscriptionChangeRequest)

      Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

      You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error.

      Parameters:
      cancelSubscriptionChangeRequest -
      Returns:
      A Java Future containing the result of the CancelSubscriptionChange 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelSubscriptionChange

      default CompletableFuture<CancelSubscriptionChangeResponse> cancelSubscriptionChange(Consumer<CancelSubscriptionChangeRequest.Builder> cancelSubscriptionChangeRequest)

      Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

      You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error.


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

      Parameters:
      cancelSubscriptionChangeRequest - A Consumer that will call methods on CancelSubscriptionChangeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelSubscriptionChange 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSubscription

      default CompletableFuture<CreateSubscriptionResponse> createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

      Creates a flat-rate pricing subscription for the specified resources.

      When approvalMode is set to MANUAL, paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.

      When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately.

      Parameters:
      createSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CreateSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ServiceQuotaExceededException The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSubscription

      default CompletableFuture<CreateSubscriptionResponse> createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)

      Creates a flat-rate pricing subscription for the specified resources.

      When approvalMode is set to MANUAL, paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.

      When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately.


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

      Parameters:
      createSubscriptionRequest - A Consumer that will call methods on CreateSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ServiceQuotaExceededException The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateResourcesFromSubscription

      default CompletableFuture<DisassociateResourcesFromSubscriptionResponse> disassociateResourcesFromSubscription(DisassociateResourcesFromSubscriptionRequest disassociateResourcesFromSubscriptionRequest)

      Removes one or more resources from an existing subscription.

      For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources.

      Parameters:
      disassociateResourcesFromSubscriptionRequest -
      Returns:
      A Java Future containing the result of the DisassociateResourcesFromSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateResourcesFromSubscription

      default CompletableFuture<DisassociateResourcesFromSubscriptionResponse> disassociateResourcesFromSubscription(Consumer<DisassociateResourcesFromSubscriptionRequest.Builder> disassociateResourcesFromSubscriptionRequest)

      Removes one or more resources from an existing subscription.

      For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources.


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

      Parameters:
      disassociateResourcesFromSubscriptionRequest - A Consumer that will call methods on DisassociateResourcesFromSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateResourcesFromSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSubscription

      default CompletableFuture<GetSubscriptionResponse> getSubscription(GetSubscriptionRequest getSubscriptionRequest)

      Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

      Parameters:
      getSubscriptionRequest -
      Returns:
      A Java Future containing the result of the GetSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSubscription

      default CompletableFuture<GetSubscriptionResponse> getSubscription(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest)

      Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.


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

      Parameters:
      getSubscriptionRequest - A Consumer that will call methods on GetSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptions

      default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)

      Returns a summary of all flat-rate pricing subscriptions in the calling account.

      Parameters:
      listSubscriptionsRequest -
      Returns:
      A Java Future containing the result of the ListSubscriptions 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptions

      default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)

      Returns a summary of all flat-rate pricing subscriptions in the calling account.


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

      Parameters:
      listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSubscriptions 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)

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

      Parameters:
      listSubscriptionsRequest -
      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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)

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


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

      Parameters:
      listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSubscription

      default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest)

      Changes the plan tier of an existing subscription.

      Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using CancelSubscriptionChange.

      This operation replaces the plan tier value. If you omit the optional usageLevel field, it is reset to the default.

      Parameters:
      updateSubscriptionRequest -
      Returns:
      A Java Future containing the result of the UpdateSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ServiceQuotaExceededException The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSubscription

      default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest)

      Changes the plan tier of an existing subscription.

      Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using CancelSubscriptionChange.

      This operation replaces the plan tier value. If you omit the optional usageLevel field, it is reset to the default.


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

      Parameters:
      updateSubscriptionRequest - A Consumer that will call methods on UpdateSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSubscription 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.
      • AccessDeniedException You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.
      • InternalServerException An unexpected error occurred on the server. Retry the request.
      • ValidationException The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.
      • ConflictException The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.
      • ServiceQuotaExceededException The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.
      • ResourceNotFoundException The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.
      • ThrottlingException The request rate exceeds the allowed limit. Wait briefly and retry the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PricingPlanManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static PricingPlanManagerAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PricingPlanManagerAsyncClient.