CostandUsageReportServiceClient

Index > CostandUsageReportService > CostandUsageReportServiceClient

Auto-generated documentation for CostandUsageReportService type annotations stubs module mypy-boto3-cur.

CostandUsageReportServiceClient

Type annotations and code completion for boto3.client("cur"). boto3 documentation

# CostandUsageReportServiceClient usage example

from boto3.session import Session
from mypy_boto3_cur.client import CostandUsageReportServiceClient

def get_cur_client() -> CostandUsageReportServiceClient:
    return Session().client("cur")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("cur")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DuplicateReportNameException,
    client.exceptions.InternalErrorException,
    client.exceptions.ReportLimitReachedException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_cur.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cur").can_paginate method. boto3 documentation

# can_paginate method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("cur").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_report_definition

Deletes the specified report.

Type annotations and code completion for boto3.client("cur").delete_report_definition method. boto3 documentation

# delete_report_definition method definition

def delete_report_definition(
    self,
    *,
    ReportName: str,
) -> DeleteReportDefinitionResponseTypeDef:  # (1)
    ...

1. See DeleteReportDefinitionResponseTypeDef

# delete_report_definition method usage example with argument unpacking

kwargs: DeleteReportDefinitionRequestRequestTypeDef = {  # (1)
    "ReportName": ...,
}

parent.delete_report_definition(**kwargs)

1. See DeleteReportDefinitionRequestRequestTypeDef

describe_report_definitions

Lists the Amazon Web Services Cost and Usage Report available to this account.

Type annotations and code completion for boto3.client("cur").describe_report_definitions method. boto3 documentation

# describe_report_definitions method definition

def describe_report_definitions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeReportDefinitionsResponseTypeDef:  # (1)
    ...

1. See DescribeReportDefinitionsResponseTypeDef

# describe_report_definitions method usage example with argument unpacking

kwargs: DescribeReportDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_report_definitions(**kwargs)

1. See DescribeReportDefinitionsRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cur").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:
    ...

list_tags_for_resource

Lists the tags associated with the specified report definition.

Type annotations and code completion for boto3.client("cur").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

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

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ReportName": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

modify_report_definition

Allows you to programmatically update your report preferences.

Type annotations and code completion for boto3.client("cur").modify_report_definition method. boto3 documentation

# modify_report_definition method definition

def modify_report_definition(
    self,
    *,
    ReportName: str,
    ReportDefinition: Union[ReportDefinitionTypeDef, ReportDefinitionExtraOutputTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See ReportDefinitionTypeDef ReportDefinitionExtraOutputTypeDef

# modify_report_definition method usage example with argument unpacking

kwargs: ModifyReportDefinitionRequestRequestTypeDef = {  # (1)
    "ReportName": ...,
    "ReportDefinition": ...,
}

parent.modify_report_definition(**kwargs)

1. See ModifyReportDefinitionRequestRequestTypeDef

put_report_definition

Creates a new report using the description that you provide.

Type annotations and code completion for boto3.client("cur").put_report_definition method. boto3 documentation

# put_report_definition method definition

def put_report_definition(
    self,
    *,
    ReportDefinition: Union[ReportDefinitionTypeDef, ReportDefinitionExtraOutputTypeDef],  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See ReportDefinitionTypeDef ReportDefinitionExtraOutputTypeDef
2. See TagTypeDef

# put_report_definition method usage example with argument unpacking

kwargs: PutReportDefinitionRequestRequestTypeDef = {  # (1)
    "ReportDefinition": ...,
}

parent.put_report_definition(**kwargs)

1. See PutReportDefinitionRequestRequestTypeDef

tag_resource

Associates a set of tags with a report definition.

Type annotations and code completion for boto3.client("cur").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ReportName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ReportName": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Disassociates a set of tags from a report definition.

Type annotations and code completion for boto3.client("cur").untag_resource method. boto3 documentation

# untag_resource method definition

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

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ReportName": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

get_paginator

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

• client.get_paginator("describe_report_definitions") -> DescribeReportDefinitionsPaginator