Interface BcmDashboardsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BcmDashboardsAsyncClient extends AwsClient
Service client for accessing AWS Billing and Cost Management Dashboards 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 Billing and Cost Management Dashboards is a service that enables you to create, manage, and share dashboards that combine multiple visualizations of your Amazon Web Services cost and usage data. You can combine multiple data sources including Cost Explorer, Savings Plans, and Reserved Instance metrics into unified dashboards, helping you analyze spending patterns and share cost insights across your organization.

You can use the Amazon Web Services Billing and Cost Management Dashboards API to programmatically create, manage, and share dashboards. This includes creating custom dashboards, configuring widgets, managing dashboard permissions, and sharing dashboards across accounts in your organization.

  • Field Details

  • Method Details

    • createDashboard

      default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest)

      Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.

      Parameters:
      createDashboardRequest -
      Returns:
      A Java Future containing the result of the CreateDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ServiceQuotaExceededException The request would exceed service quotas. For example, attempting to create more than 20 widgets in a dashboard or exceeding the maximum number of dashboards per account.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDashboard

      default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)

      Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.


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

      Parameters:
      createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ServiceQuotaExceededException The request would exceed service quotas. For example, attempting to create more than 20 widgets in a dashboard or exceeding the maximum number of dashboards per account.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDashboard

      default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)

      Deletes a specified dashboard. This action cannot be undone.

      Parameters:
      deleteDashboardRequest -
      Returns:
      A Java Future containing the result of the DeleteDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDashboard

      default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)

      Deletes a specified dashboard. This action cannot be undone.


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

      Parameters:
      deleteDashboardRequest - A Consumer that will call methods on DeleteDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDashboard

      default CompletableFuture<GetDashboardResponse> getDashboard(GetDashboardRequest getDashboardRequest)

      Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.

      Parameters:
      getDashboardRequest -
      Returns:
      A Java Future containing the result of the GetDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDashboard

      default CompletableFuture<GetDashboardResponse> getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest)

      Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.


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

      Parameters:
      getDashboardRequest - A Consumer that will call methods on GetDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePolicy

      default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)

      Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.

      Parameters:
      getResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the GetResourcePolicy 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePolicy

      default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)

      Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.


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

      Parameters:
      getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetResourcePolicy 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboards

      default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest)

      Returns a list of all dashboards in your account.

      Parameters:
      listDashboardsRequest -
      Returns:
      A Java Future containing the result of the ListDashboards 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboards

      default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)

      Returns a list of all dashboards in your account.


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

      Parameters:
      listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDashboards 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboardsPaginator

      default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)

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

      Parameters:
      listDashboardsRequest -
      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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDashboardsPaginator

      default ListDashboardsPublisher listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)

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


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

      Parameters:
      listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns a list of all tags associated with a specified dashboard resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

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

      Returns a list of all tags associated with a specified dashboard resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds or updates tags for a specified dashboard resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

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

      Adds or updates tags for a specified dashboard resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes specified tags from a dashboard resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

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

      Removes specified tags from a dashboard resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDashboard

      default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest)

      Updates an existing dashboard's properties, including its name, description, and widget configurations.

      Parameters:
      updateDashboardRequest -
      Returns:
      A Java Future containing the result of the UpdateDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDashboard

      default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)

      Updates an existing dashboard's properties, including its name, description, and widget configurations.


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

      Parameters:
      updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDashboard 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.
      • ThrottlingException The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.
      • AccessDeniedException You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.
      • InternalServerException An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.
      • ValidationException The input parameters do not satisfy the requirements. Check the error message for specific validation details.
      • ResourceNotFoundException The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.
      • 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.
      • BcmDashboardsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static BcmDashboardsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BcmDashboardsAsyncClient.