CostandUsageReportService / Client / put_report_definition

put_report_definition

CostandUsageReportService.Client.put_report_definition(**kwargs)

Creates a new report using the description that you provide.

See also: AWS API Documentation

Request Syntax

response = client.put_report_definition(
    ReportDefinition={
        'ReportName': 'string',
        'TimeUnit': 'HOURLY'|'DAILY'|'MONTHLY',
        'Format': 'textORcsv'|'Parquet',
        'Compression': 'ZIP'|'GZIP'|'Parquet',
        'AdditionalSchemaElements': [
            'RESOURCES'|'SPLIT_COST_ALLOCATION_DATA'|'MANUAL_DISCOUNT_COMPATIBILITY',
        ],
        'S3Bucket': 'string',
        'S3Prefix': 'string',
        'S3Region': 'af-south-1'|'ap-east-1'|'ap-south-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'ca-central-1'|'eu-central-1'|'eu-central-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-north-1'|'eu-south-1'|'eu-south-2'|'me-central-1'|'me-south-1'|'sa-east-1'|'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'cn-north-1'|'cn-northwest-1',
        'AdditionalArtifacts': [
            'REDSHIFT'|'QUICKSIGHT'|'ATHENA',
        ],
        'RefreshClosedReports': True|False,
        'ReportVersioning': 'CREATE_NEW_REPORT'|'OVERWRITE_REPORT',
        'BillingViewArn': 'string',
        'ReportStatus': {
            'lastDelivery': 'string',
            'lastStatus': 'SUCCESS'|'ERROR_PERMISSIONS'|'ERROR_NO_BUCKET'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ReportDefinition (dict) –

  [REQUIRED]

  Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

  • ReportName (string) – [REQUIRED]

    The name of the report that you want to create. The name must be unique, is case sensitive, and can’t include spaces.

  • TimeUnit (string) – [REQUIRED]

    The length of time covered by the report.

  • Format (string) – [REQUIRED]

    The format that Amazon Web Services saves the report in.

  • Compression (string) – [REQUIRED]

    The compression format that Amazon Web Services uses for the report.

  • AdditionalSchemaElements (list) – [REQUIRED]

    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

    • (string) –

      Whether or not Amazon Web Services includes resource IDs in the report.

  • S3Bucket (string) – [REQUIRED]

    The S3 bucket where Amazon Web Services delivers the report.

  • S3Prefix (string) – [REQUIRED]

    The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can’t include spaces.

  • S3Region (string) – [REQUIRED]

    The region of the S3 bucket that Amazon Web Services delivers the report into.

  • AdditionalArtifacts (list) –

    A list of manifests that you want Amazon Web Services to create for this report.

    • (string) –

      The types of manifest that you want Amazon Web Services to create for this report.

  • RefreshClosedReports (boolean) –

    Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

  • ReportVersioning (string) –

    Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

  • BillingViewArn (string) –

    The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

  • ReportStatus (dict) –

    The status of the report.

    • lastDelivery (string) –

      A timestamp that gives the date of a report delivery.

    • lastStatus (string) –

      An enum that gives the status of a report delivery.

• Tags (list) –

  The tags to be assigned to the report definition resource.

  • (dict) –

    Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a report definition.

    • Key (string) – [REQUIRED]

      The key of the tag. Tag keys are case sensitive. Each report definition can only have up to one tag with the same key. If you try to add an existing tag with the same key, the existing tag value will be updated to the new value.

    • Value (string) – [REQUIRED]

      The value of the tag. Tag values are case-sensitive. This can be an empty string.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Exceptions

• CostandUsageReportService.Client.exceptions.DuplicateReportNameException

• CostandUsageReportService.Client.exceptions.ReportLimitReachedException

• CostandUsageReportService.Client.exceptions.InternalErrorException

• CostandUsageReportService.Client.exceptions.ValidationException

• CostandUsageReportService.Client.exceptions.ResourceNotFoundException

Examples

The following example creates a AWS Cost and Usage report named ExampleReport.

response = client.put_report_definition(
    ReportDefinition={
        'AdditionalArtifacts': [
            'REDSHIFT',
            'QUICKSIGHT',
        ],
        'AdditionalSchemaElements': [
            'RESOURCES',
        ],
        'Compression': 'ZIP',
        'Format': 'textORcsv',
        'ReportName': 'ExampleReport',
        'S3Bucket': 'example-s3-bucket',
        'S3Prefix': 'exampleprefix',
        'S3Region': 'us-east-1',
        'TimeUnit': 'DAILY',
    },
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}