drs / Client / describe_job_log_items

describe_job_log_items#

drs.Client.describe_job_log_items(**kwargs)#

Retrieves a detailed Job log with pagination.

See also: AWS API Documentation

Request Syntax

response = client.describe_job_log_items(
    jobID='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • jobID (string) –

    [REQUIRED]

    The ID of the Job for which Job log items will be retrieved.

  • maxResults (integer) – Maximum number of Job log items to retrieve.

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'event': 'JOB_START'|'SERVER_SKIPPED'|'CLEANUP_START'|'CLEANUP_END'|'CLEANUP_FAIL'|'SNAPSHOT_START'|'SNAPSHOT_END'|'SNAPSHOT_FAIL'|'USING_PREVIOUS_SNAPSHOT'|'USING_PREVIOUS_SNAPSHOT_FAILED'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END'|'DEPLOY_NETWORK_CONFIGURATION_START'|'DEPLOY_NETWORK_CONFIGURATION_END'|'DEPLOY_NETWORK_CONFIGURATION_FAILED'|'UPDATE_NETWORK_CONFIGURATION_START'|'UPDATE_NETWORK_CONFIGURATION_END'|'UPDATE_NETWORK_CONFIGURATION_FAILED'|'UPDATE_LAUNCH_TEMPLATE_START'|'UPDATE_LAUNCH_TEMPLATE_END'|'UPDATE_LAUNCH_TEMPLATE_FAILED'|'NETWORK_RECOVERY_FAIL',
            'eventData': {
                'conversionProperties': {
                    'dataTimestamp': 'string',
                    'forceUefi': True|False,
                    'rootVolumeName': 'string',
                    'volumeToConversionMap': {
                        'string': {
                            'string': 'string'
                        }
                    },
                    'volumeToProductCodes': {
                        'string': [
                            {
                                'productCodeId': 'string',
                                'productCodeMode': 'ENABLED'|'DISABLED'
                            },
                        ]
                    },
                    'volumeToVolumeSize': {
                        'string': 123
                    }
                },
                'conversionServerID': 'string',
                'eventResourceData': {
                    'sourceNetworkData': {
                        'sourceNetworkID': 'string',
                        'sourceVpc': 'string',
                        'stackName': 'string',
                        'targetVpc': 'string'
                    }
                },
                'rawError': 'string',
                'sourceServerID': 'string',
                'targetInstanceID': 'string'
            },
            'logDateTime': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      An array of Job log items.

      • (dict) –

        A log outputted by a Job.

        • event (string) –

          The event represents the type of a log.

        • eventData (dict) –

          Metadata associated with a Job log.

          • conversionProperties (dict) –

            Properties of a conversion job

            • dataTimestamp (string) –

              The timestamp of when the snapshot being converted was taken

            • forceUefi (boolean) –

              Whether the volume being converted uses UEFI or not

            • rootVolumeName (string) –

              The root volume name of a conversion job

            • volumeToConversionMap (dict) –

              A mapping between the volumes being converted and the converted snapshot ids

              • (string) –

                • (dict) –

                  • (string) –

                    • (string) –

            • volumeToProductCodes (dict) –

              A mapping between the volumes being converted and the product codes associated with them

              • (string) –

                • (list) –

                  • (dict) –

                    Properties of a product code associated with a volume.

                    • productCodeId (string) –

                      Id of a product code associated with a volume.

                    • productCodeMode (string) –

                      Mode of a product code associated with a volume.

            • volumeToVolumeSize (dict) –

              A mapping between the volumes and their sizes

              • (string) –

                • (integer) –

          • conversionServerID (string) –

            The ID of a conversion server.

          • eventResourceData (dict) –

            Properties of resource related to a job event.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: sourceNetworkData. 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'}

            • sourceNetworkData (dict) –

              Source Network properties.

              • sourceNetworkID (string) –

                Source Network ID.

              • sourceVpc (string) –

                VPC ID protected by the Source Network.

              • stackName (string) –

                CloudFormation stack name that was deployed for recovering the Source Network.

              • targetVpc (string) –

                ID of the recovered VPC following Source Network recovery.

          • rawError (string) –

            A string representing a job error.

          • sourceServerID (string) –

            The ID of a Source Server.

          • targetInstanceID (string) –

            The ID of a Recovery Instance.

        • logDateTime (string) –

          The date and time the log was taken.

    • nextToken (string) –

      The token of the next Job log items to retrieve.

Exceptions