Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cur ]

modify-report-definition

Description

Allows you to programatically update your report preferences.

See also: AWS API Documentation

Synopsis

  modify-report-definition
--report-name <value>
--report-definition <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--report-name (string)

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

--report-definition (structure)

The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

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.

BillingViewArn -> (string)

The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.

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,BillingViewArn=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-southeast-3"|"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"|"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"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None