drs / Client / describe_jobs

describe_jobs

drs.Client.describe_jobs(**kwargs)

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

See also: AWS API Documentation

Request Syntax

response = client.describe_jobs(
    filters={
        'fromDate': 'string',
        'jobIDs': [
            'string',
        ],
        'toDate': 'string'
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• filters (dict) –

  A set of filters by which to return Jobs.

  • fromDate (string) –

    The start date in a date range query.

  • jobIDs (list) –

    An array of Job IDs that should be returned. An empty array means all jobs.

    • (string) –

  • toDate (string) –

    The end date in a date range query.

• maxResults (integer) – Maximum number of Jobs to retrieve.

• nextToken (string) – The token of the next Job to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'creationDateTime': 'string',
            'endDateTime': 'string',
            'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT',
            'jobID': 'string',
            'participatingServers': [
                {
                    'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
                    'recoveryInstanceID': 'string',
                    'sourceServerID': 'string'
                },
            ],
            'status': 'PENDING'|'STARTED'|'COMPLETED',
            'tags': {
                'string': 'string'
            },
            'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    An array of Jobs.

    • (dict) –

      A job is an asynchronous workflow.

      • arn (string) –

        The ARN of a Job.

      • creationDateTime (string) –

        The date and time of when the Job was created.

      • endDateTime (string) –

        The date and time of when the Job ended.

      • initiatedBy (string) –

        A string representing who initiated the Job.

      • jobID (string) –

        The ID of the Job.

      • participatingServers (list) –

        A list of servers that the Job is acting upon.

        • (dict) –

          Represents a server participating in an asynchronous Job.

          • launchStatus (string) –

            The launch status of a participating server.

          • recoveryInstanceID (string) –

            The Recovery Instance ID of a participating server.

          • sourceServerID (string) –

            The Source Server ID of a participating server.

      • status (string) –

        The status of the Job.

      • tags (dict) –

        A list of tags associated with the Job.

        • (string) –

          • (string) –

      • type (string) –

        The type of the Job.

  • nextToken (string) –

    The token of the next Job to retrieve.

Exceptions

• drs.Client.exceptions.InternalServerException

• drs.Client.exceptions.ThrottlingException

• drs.Client.exceptions.ValidationException

• drs.Client.exceptions.UninitializedAccountException