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={
        'jobIDs': [
            'string',
        ],
        'fromDate': 'string',
        'toDate': 'string'
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• filters (dict) –

  A set of filters by which to return Jobs.

  • jobIDs (list) –

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

    • (string) –

  • fromDate (string) –

    The start date in a date range query.

  • 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': [
        {
            'jobID': 'string',
            'arn': 'string',
            'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT',
            'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT'|'CREATE_NETWORK_RECOVERY'|'UPDATE_NETWORK_RECOVERY'|'ASSOCIATE_NETWORK_RECOVERY',
            'creationDateTime': 'string',
            'endDateTime': 'string',
            'status': 'PENDING'|'STARTED'|'COMPLETED',
            'participatingServers': [
                {
                    'sourceServerID': 'string',
                    'recoveryInstanceID': 'string',
                    'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
                    'launchActionsStatus': {
                        'ssmAgentDiscoveryDatetime': 'string',
                        'runs': [
                            {
                                'action': {
                                    'actionId': 'string',
                                    'actionCode': 'string',
                                    'type': 'SSM_AUTOMATION'|'SSM_COMMAND',
                                    'name': 'string',
                                    'active': True|False,
                                    'order': 123,
                                    'actionVersion': 'string',
                                    'optional': True|False,
                                    'parameters': {
                                        'string': {
                                            'value': 'string',
                                            'type': 'SSM_STORE'|'DYNAMIC'
                                        }
                                    },
                                    'description': 'string',
                                    'category': 'MONITORING'|'VALIDATION'|'CONFIGURATION'|'SECURITY'|'OTHER'
                                },
                                'runId': 'string',
                                'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
                                'failureReason': 'string'
                            },
                        ]
                    }
                },
            ],
            'tags': {
                'string': 'string'
            },
            'participatingResources': [
                {
                    'participatingResourceID': {
                        'sourceNetworkID': 'string'
                    },
                    'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    An array of Jobs.

    • (dict) –

      A job is an asynchronous workflow.

      • jobID (string) –

        The ID of the Job.

      • arn (string) –

        The ARN of a Job.

      • type (string) –

        The type of the Job.

      • initiatedBy (string) –

        A string representing who initiated the Job.

      • creationDateTime (string) –

        The date and time of when the Job was created.

      • endDateTime (string) –

        The date and time of when the Job ended.

      • status (string) –

        The status of the Job.

      • participatingServers (list) –

        A list of servers that the Job is acting upon.

        • (dict) –

          Represents a server participating in an asynchronous Job.

          • sourceServerID (string) –

            The Source Server ID of a participating server.

          • recoveryInstanceID (string) –

            The Recovery Instance ID of a participating server.

          • launchStatus (string) –

            The launch status of a participating server.

          • launchActionsStatus (dict) –

            The post-launch action runs of a participating server.

            • ssmAgentDiscoveryDatetime (string) –

              Time where the AWS Systems Manager was detected as running on the launched instance.

            • runs (list) –

              List of post launch action status.

              • (dict) –

                Launch action run.

                • action (dict) –

                  Action.

                  • actionId (string) –

                    Launch action Id.

                  • actionCode (string) –

                    Launch action code.

                  • type (string) –

                    Launch action type.

                  • name (string) –

                    Launch action name.

                  • active (boolean) –

                    Whether the launch action is active.

                  • order (integer) –

                    Launch action order.

                  • actionVersion (string) –

                    Launch action version.

                  • optional (boolean) –

                    Whether the launch will not be marked as failed if this action fails.

                  • parameters (dict) –

                    Launch action parameters.

                    • (string) –

                      • (dict) –

                        Launch action parameter.

                        • value (string) –

                          Value.

                        • type (string) –

                          Type.

                  • description (string) –

                    Launch action description.

                  • category (string) –

                    Launch action category.

                • runId (string) –

                  Run Id.

                • status (string) –

                  Run status.

                • failureReason (string) –

                  Failure reason.

      • tags (dict) –

        A list of tags associated with the Job.

        • (string) –

          • (string) –

      • participatingResources (list) –

        A list of resources that the Job is acting upon.

        • (dict) –

          Represents a resource participating in an asynchronous Job.

          • participatingResourceID (dict) –

            The ID of a participating resource.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: sourceNetworkID. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • sourceNetworkID (string) –

              Source Network ID.

          • launchStatus (string) –

            The launch status of a participating resource.

  • 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