Interface BcmDashboardsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Billing and Cost Management Dashboards. This can be created using the static builder() method.

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 Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static BcmDashboardsClientBuilder	builder()	Create a builder that can be used to configure and create a BcmDashboardsClient.
static BcmDashboardsClient	create()	Create a BcmDashboardsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateDashboardResponse	createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)	Creates a new dashboard that can contain multiple widgets displaying cost and usage data.
default CreateDashboardResponse	createDashboard(CreateDashboardRequest createDashboardRequest)	Creates a new dashboard that can contain multiple widgets displaying cost and usage data.
default DeleteDashboardResponse	deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)	Deletes a specified dashboard.
default DeleteDashboardResponse	deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)	Deletes a specified dashboard.
default GetDashboardResponse	getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest)	Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.
default GetDashboardResponse	getDashboard(GetDashboardRequest getDashboardRequest)	Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.
default ListDashboardsResponse	listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)	Returns a list of all dashboards in your account.
default ListDashboardsResponse	listDashboards(ListDashboardsRequest listDashboardsRequest)	Returns a list of all dashboards in your account.
default ListDashboardsIterable	listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)	This is a variant of listDashboards(software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsRequest) operation.
default ListDashboardsIterable	listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)	This is a variant of listDashboards(software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of all tags associated with a specified dashboard resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of all tags associated with a specified dashboard resource.
default BcmDashboardsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or updates tags for a specified dashboard resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or updates tags for a specified dashboard resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes specified tags from a dashboard resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes specified tags from a dashboard resource.
default UpdateDashboardResponse	updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)	Updates an existing dashboard's properties, including its name, description, and widget configurations.
default UpdateDashboardResponse	updateDashboard(UpdateDashboardRequest updateDashboardRequest)	Updates an existing dashboard's properties, including its name, description, and widget configurations.

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createDashboard

default CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest)
                                         throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the CreateDashboard operation returned by the service.

See Also:

• AWS API Documentation

createDashboard

default CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
                                         throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the CreateDashboard operation returned by the service.

See Also:

• AWS API Documentation

deleteDashboard

default DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
                                         throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

Deletes a specified dashboard. This action cannot be undone.

Parameters:

deleteDashboardRequest -

Returns:

Result of the DeleteDashboard operation returned by the service.

See Also:

• AWS API Documentation

deleteDashboard

default DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
                                         throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the DeleteDashboard operation returned by the service.

See Also:

• AWS API Documentation

getDashboard

default GetDashboardResponse getDashboard(GetDashboardRequest getDashboardRequest)
                                   throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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

Parameters:

getDashboardRequest -

Returns:

Result of the GetDashboard operation returned by the service.

See Also:

• AWS API Documentation

getDashboard

default GetDashboardResponse getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest)
                                   throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the GetDashboard operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

listDashboards

default ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest)
                                       throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

Returns a list of all dashboards in your account.

Parameters:

listDashboardsRequest -

Returns:

Result of the ListDashboards operation returned by the service.

See Also:

• AWS API Documentation

listDashboards

default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
                                       throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the ListDashboards operation returned by the service.

See Also:

• AWS API Documentation

listDashboardsPaginator

default ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
                                                throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

This is a variant of listDashboards(software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bcmdashboards.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdashboards.paginators.ListDashboardsIterable responses = client
             .listDashboardsPaginator(request);
     for (software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdashboards.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDashboards(software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsRequest) operation.

Parameters:

listDashboardsRequest -

Returns:

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

See Also:

• AWS API Documentation

listDashboardsPaginator

default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
                                                throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

This is a variant of listDashboards(software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bcmdashboards.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bcmdashboards.paginators.ListDashboardsIterable responses = client
             .listDashboardsPaginator(request);
     for (software.amazon.awssdk.services.bcmdashboards.model.ListDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bcmdashboards.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ThrottlingException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ThrottlingException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ThrottlingException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

Adds or updates tags for a specified dashboard resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ThrottlingException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ThrottlingException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

Removes specified tags from a dashboard resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ThrottlingException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateDashboard

default UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest)
                                         throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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

Parameters:

updateDashboardRequest -

Returns:

Result of the UpdateDashboard operation returned by the service.

See Also:

• AWS API Documentation

updateDashboard

default UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
                                         throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BcmDashboardsException

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:

Result of the UpdateDashboard operation returned by the service.

See Also:

• AWS API Documentation

create

static BcmDashboardsClient create()

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

builder

static BcmDashboardsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

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