[ aws . resourcegroupstaggingapi ]

describe-report-creation

Description

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization’s master account and from the us-east-1 Region.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-report-creation
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Status -> (string)

Reports the status of the operation.

The operation status can be one of the following:

• RUNNING - Report creation is in progress.

• SUCCEEDED - Report creation is complete. You can open the report from the Amazon S3 bucket that you specified when you ran StartReportCreation .

• FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.

• NO REPORT - No report was generated in the last 90 days.

S3Location -> (string)

The path to the Amazon S3 bucket where the report was stored on creation.

ErrorMessage -> (string)

Details of the common errors that all operations return.