put-report-definition¶

Description¶

Creates a new report using the description that you provide.

Synopsis¶

  put-report-definition
--report-definition <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--report-definition (structure)

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

ReportName -> (string)

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)

The length of time covered by the report.

Format -> (string)

The format that AWS saves the report in.

Compression -> (string)

The compression format that AWS uses for the report.

AdditionalSchemaElements -> (list)

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 AWS includes resource IDs in the report.

S3Bucket -> (string)

The S3 bucket where AWS delivers the report.

S3Prefix -> (string)

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

S3Region -> (string)

The region of the S3 bucket that AWS 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 AWS 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.

Shorthand Syntax:

ReportName=string,TimeUnit=string,Format=string,Compression=string,AdditionalSchemaElements=string,string,S3Bucket=string,S3Prefix=string,S3Region=string,AdditionalArtifacts=string,string,RefreshClosedReports=boolean,ReportVersioning=string

JSON Syntax:

{
  "ReportName": "string",
  "TimeUnit": "HOURLY"|"DAILY"|"MONTHLY",
  "Format": "textORcsv"|"Parquet",
  "Compression": "ZIP"|"GZIP"|"Parquet",
  "AdditionalSchemaElements": ["RESOURCES", ...],
  "S3Bucket": "string",
  "S3Prefix": "string",
  "S3Region": "af-south-1"|"ap-east-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"ca-central-1"|"eu-central-1"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-north-1"|"eu-south-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"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create an AWS Cost and Usage Reports

The following put-report-definition example creates a daily AWS Cost and Usage Report that you can upload into Amazon Redshift or Amazon QuickSight.

aws cur put-report-definition --report-definition file://report-definition.json

Contents of report-definition.json:

{
    "ReportName": "ExampleReport",
    "TimeUnit": "DAILY",
    "Format": "textORcsv",
    "Compression": "ZIP",
    "AdditionalSchemaElements": [
        "RESOURCES"
    ],
    "S3Bucket": "example-s3-bucket",
    "S3Prefix": "exampleprefix",
    "S3Region": "us-east-1",
    "AdditionalArtifacts": [
        "REDSHIFT",
        "QUICKSIGHT"
    ]
}

Output¶

None

Table of Contents

Feedback

User Guide