AWS CLI Command Reference

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

get-declarative-policies-report-summary

Description

Retrieves a summary of the account status report.

To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses (running , cancelled , or error ) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide .

For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide .

See also: AWS API Documentation

Synopsis

  get-declarative-policies-report-summary
[--dry-run | --no-dry-run]
--report-id <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

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--report-id (string)

The ID of the report.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

ReportId -> (string)

The ID of the report.

S3Bucket -> (string)

The name of the Amazon S3 bucket where the report is located.

S3Prefix -> (string)

The prefix for your S3 object.

TargetId -> (string)

The root ID, organizational unit ID, or account ID.

Format:

  • For root: r-ab12
  • For OU: ou-ab12-cdef1234
  • For account: 123456789012

StartTime -> (timestamp)

The time when the report generation started.

EndTime -> (timestamp)

The time when the report generation ended.

NumberOfAccounts -> (integer)

The total number of accounts associated with the specified targetId .

NumberOfFailedAccounts -> (integer)

The number of accounts where attributes could not be retrieved in any Region.

AttributeSummaries -> (list)

The attributes described in the report.

(structure)

A summary report for the attribute across all Regions.

AttributeName -> (string)

The name of the attribute.

MostFrequentValue -> (string)

The configuration value that is most frequently observed for the attribute.

NumberOfMatchedAccounts -> (integer)

The number of accounts with the same configuration value for the attribute that is most frequently observed.

NumberOfUnmatchedAccounts -> (integer)

The number of accounts with a configuration value different from the most frequently observed value for the attribute.

RegionalSummaries -> (list)

The summary report for each Region for the attribute.

(structure)

A summary report for the attribute for a Region.

RegionName -> (string)

The Amazon Web Services Region.

NumberOfMatchedAccounts -> (integer)

The number of accounts in the Region with the same configuration value for the attribute that is most frequently observed.

NumberOfUnmatchedAccounts -> (integer)

The number of accounts in the Region with a configuration value different from the most frequently observed value for the attribute.