Backup / Client / start_report_job

start_report_job#

Backup.Client.start_report_job(**kwargs)#

Starts an on-demand report job for the specified report plan.

Request Syntax

response = client.start_report_job(
    ReportPlanName='string',
    IdempotencyToken='string'
)

Parameters:

ReportPlanName (string) –
[REQUIRED]

The unique name of a report plan.
IdempotencyToken (string) –
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput . Retrying a successful request with the same idempotency token results in a success message with no action taken.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ReportJobId': 'string'
}

Response Structure

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

Exceptions