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.
Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan
.
See also: AWS API Documentation
list-report-plans
[--max-results <value>]
[--next-token <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>]
--max-results
(integer)
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
--next-token
(string)
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
--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.
--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.
--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.
--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.
ReportPlans -> (list)
The report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
(structure)
Contains detailed information about a report plan.
ReportPlanArn -> (string)
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.ReportPlanName -> (string)
The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).ReportPlanDescription -> (string)
An optional description of the report plan with a maximum 1,024 characters.ReportSetting -> (structure)
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is
RESOURCE_COMPLIANCE_REPORT
orCONTROL_COMPLIANCE_REPORT
, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.ReportTemplate -> (string)
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
FrameworkArns -> (list)
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string)
NumberOfFrameworks -> (integer)
The number of frameworks a report covers.Accounts -> (list)
These are the accounts to be included in the report.
Use string value of
ROOT
to include all organizational units.(string)
OrganizationUnits -> (list)
These are the Organizational Units to be included in the report.
(string)
Regions -> (list)
These are the Regions to be included in the report.
Use the wildcard as the string value to include all Regions.
(string)
ReportDeliveryChannel -> (structure)
Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
S3BucketName -> (string)
The unique name of the S3 bucket that receives your reports.S3KeyPrefix -> (string)
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix
/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.Formats -> (list)
The format of your reports:
CSV
,JSON
, or both. If not specified, the default format isCSV
.(string)
DeploymentStatus -> (string)
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
CreationTime -> (timestamp)
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value ofCreationTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.LastAttemptedExecutionTime -> (timestamp)
The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value ofLastAttemptedExecutionTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.LastSuccessfulExecutionTime -> (timestamp)
The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value ofLastSuccessfulExecutionTime
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
NextToken -> (string)
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.