BillingandCostManagementDashboardsClient

Index > BillingandCostManagementDashboards > BillingandCostManagementDashboardsClient

Auto-generated documentation for BillingandCostManagementDashboards type annotations stubs module types-boto3-bcm-dashboards.

BillingandCostManagementDashboardsClient

Type annotations and code completion for boto3.client("bcm-dashboards"). boto3 documentation

# BillingandCostManagementDashboardsClient usage example

from boto3.session import Session
from types_boto3_bcm_dashboards.client import BillingandCostManagementDashboardsClient

def get_bcm-dashboards_client() -> BillingandCostManagementDashboardsClient:
    return Session().client("bcm-dashboards")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("bcm-dashboards").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("bcm-dashboards")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_bcm_dashboards.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("bcm-dashboards").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("bcm-dashboards").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_dashboard

Creates a new dashboard that can contain multiple widgets displaying cost and usage data.

Type annotations and code completion for boto3.client("bcm-dashboards").create_dashboard method. boto3 documentation

# create_dashboard method definition

def create_dashboard(
    self,
    *,
    name: str,
    widgets: Sequence[WidgetUnionTypeDef],  # (1)
    description: str = ...,
    resourceTags: Sequence[ResourceTagTypeDef] = ...,  # (2)
) -> CreateDashboardResponseTypeDef:  # (3)
    ...

1. See Sequence[WidgetUnionTypeDef]
2. See Sequence[ResourceTagTypeDef]
3. See CreateDashboardResponseTypeDef

# create_dashboard method usage example with argument unpacking

kwargs: CreateDashboardRequestTypeDef = {  # (1)
    "name": ...,
    "widgets": ...,
}

parent.create_dashboard(**kwargs)

1. See CreateDashboardRequestTypeDef

delete_dashboard

Deletes a specified dashboard.

Type annotations and code completion for boto3.client("bcm-dashboards").delete_dashboard method. boto3 documentation

# delete_dashboard method definition

def delete_dashboard(
    self,
    *,
    arn: str,
) -> DeleteDashboardResponseTypeDef:  # (1)
    ...

1. See DeleteDashboardResponseTypeDef

# delete_dashboard method usage example with argument unpacking

kwargs: DeleteDashboardRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_dashboard(**kwargs)

1. See DeleteDashboardRequestTypeDef

get_dashboard

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

Type annotations and code completion for boto3.client("bcm-dashboards").get_dashboard method. boto3 documentation

# get_dashboard method definition

def get_dashboard(
    self,
    *,
    arn: str,
) -> GetDashboardResponseTypeDef:  # (1)
    ...

1. See GetDashboardResponseTypeDef

# get_dashboard method usage example with argument unpacking

kwargs: GetDashboardRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_dashboard(**kwargs)

1. See GetDashboardRequestTypeDef

get_resource_policy

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

Type annotations and code completion for boto3.client("bcm-dashboards").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    resourceArn: str,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...

1. See GetResourcePolicyResponseTypeDef

# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyRequestTypeDef

list_dashboards

Returns a list of all dashboards in your account.

Type annotations and code completion for boto3.client("bcm-dashboards").list_dashboards method. boto3 documentation

# list_dashboards method definition

def list_dashboards(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDashboardsResponseTypeDef:  # (1)
    ...

1. See ListDashboardsResponseTypeDef

# list_dashboards method usage example with argument unpacking

kwargs: ListDashboardsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_dashboards(**kwargs)

1. See ListDashboardsRequestTypeDef

list_tags_for_resource

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

Type annotations and code completion for boto3.client("bcm-dashboards").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

tag_resource

Adds or updates tags for a specified dashboard resource.

Type annotations and code completion for boto3.client("bcm-dashboards").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    resourceTags: Sequence[ResourceTagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[ResourceTagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "resourceTags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes specified tags from a dashboard resource.

Type annotations and code completion for boto3.client("bcm-dashboards").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    resourceTagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "resourceTagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_dashboard

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

Type annotations and code completion for boto3.client("bcm-dashboards").update_dashboard method. boto3 documentation

# update_dashboard method definition

def update_dashboard(
    self,
    *,
    arn: str,
    name: str = ...,
    description: str = ...,
    widgets: Sequence[WidgetUnionTypeDef] = ...,  # (1)
) -> UpdateDashboardResponseTypeDef:  # (2)
    ...

1. See Sequence[WidgetUnionTypeDef]
2. See UpdateDashboardResponseTypeDef

# update_dashboard method usage example with argument unpacking

kwargs: UpdateDashboardRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_dashboard(**kwargs)

1. See UpdateDashboardRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("bcm-dashboards").get_paginator method with overloads.

• client.get_paginator("list_dashboards") -> ListDashboardsPaginator