Backup / Client / list_report_plans

list_report_plans#

Backup.Client.list_report_plans(**kwargs)#

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

See also: AWS API Documentation

Request Syntax

response = client.list_report_plans(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

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

Return type:

dict

Returns:

Response Syntax

{
    'ReportPlans': [
        {
            'ReportPlanArn': 'string',
            'ReportPlanName': 'string',
            'ReportPlanDescription': 'string',
            'ReportSetting': {
                'ReportTemplate': 'string',
                'FrameworkArns': [
                    'string',
                ],
                'NumberOfFrameworks': 123,
                'Accounts': [
                    'string',
                ],
                'OrganizationUnits': [
                    'string',
                ],
                'Regions': [
                    'string',
                ]
            },
            'ReportDeliveryChannel': {
                'S3BucketName': 'string',
                'S3KeyPrefix': 'string',
                'Formats': [
                    'string',
                ]
            },
            'DeploymentStatus': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastAttemptedExecutionTime': datetime(2015, 1, 1),
            'LastSuccessfulExecutionTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

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

      • (dict) –

        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 (dict) –

          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 or CONTROL_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 (dict) –

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

            • (string) –

        • DeploymentStatus (string) –

          The deployment status of a report plan. The statuses are:

          CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

        • CreationTime (datetime) –

          The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • LastAttemptedExecutionTime (datetime) –

          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 of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • LastSuccessfulExecutionTime (datetime) –

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

Exceptions