Backup / Client / list_report_jobs

list_report_jobs#

Backup.Client.list_report_jobs(**kwargs)#

Returns details about your report jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_report_jobs(
    ByReportPlanName='string',
    ByCreationBefore=datetime(2015, 1, 1),
    ByCreationAfter=datetime(2015, 1, 1),
    ByStatus='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ByReportPlanName (string) – Returns only report jobs with the specified report plan name.

  • ByCreationBefore (datetime) – Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

  • ByCreationAfter (datetime) – Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

  • ByStatus (string) –

    Returns only report jobs that are in the specified status. The statuses are:

    CREATED | RUNNING | COMPLETED | FAILED

  • 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

{
    'ReportJobs': [
        {
            'ReportJobId': 'string',
            'ReportPlanArn': 'string',
            'ReportTemplate': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'Status': 'string',
            'StatusMessage': 'string',
            'ReportDestination': {
                'S3BucketName': 'string',
                'S3Keys': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ReportJobs (list) –

      Details about your report jobs in JSON format.

      • (dict) –

        Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

        • ReportJobId (string) –

          The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

        • ReportPlanArn (string) –

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • 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

        • CreationTime (datetime) –

          The date and time that a report job 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.

        • CompletionTime (datetime) –

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

        • Status (string) –

          The status of a report job. The statuses are:

          CREATED | RUNNING | COMPLETED | FAILED

          COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

        • StatusMessage (string) –

          A message explaining the status of the report job.

        • ReportDestination (dict) –

          The S3 bucket name and S3 keys for the destination where the report job publishes the report.

          • S3BucketName (string) –

            The unique name of the Amazon S3 bucket that receives your reports.

          • S3Keys (list) –

            The object key that uniquely identifies your reports in your S3 bucket.

            • (string) –

    • 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

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.ServiceUnavailableException

  • Backup.Client.exceptions.ResourceNotFoundException