Backup / Client / describe_report_job

describe_report_job

Backup.Client.describe_report_job(**kwargs)

Returns the details associated with creating a report as specified by its ReportJobId.

See also: AWS API Documentation

Request Syntax

response = client.describe_report_job(
    ReportJobId='string'
)

Parameters:

ReportJobId (string) –

[REQUIRED]

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Return type:

dict

Returns:

Response Syntax

{
    'ReportJob': {
        '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',
            ]
        }
    }
}

Response Structure

• (dict) –

  • ReportJob (dict) –

    A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

    • 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) –

Exceptions

• Backup.Client.exceptions.ServiceUnavailableException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ResourceNotFoundException