mgn / Client / describe_job_log_items

describe_job_log_items#

mgn.Client.describe_job_log_items(**kwargs)#

Retrieves detailed job log items with paging.

See also: AWS API Documentation

Request Syntax

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

  • accountID (string) – Request to describe Job log Account ID.

  • jobID (string) –

    [REQUIRED]

    Request to describe Job log job ID.

  • maxResults (integer) – Request to describe Job log item maximum results.

  • nextToken (string) – Request to describe Job log next token.

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'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END',
            'eventData': {
                'conversionServerID': 'string',
                'rawError': 'string',
                'sourceServerID': 'string',
                'targetInstanceID': 'string'
            },
            'logDateTime': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Request to describe Job log response items.

      • (dict) –

        Job log.

        • event (string) –

          Job log event.

        • eventData (dict) –

          Job event data

          • conversionServerID (string) –

            Job Event conversion Server ID.

          • rawError (string) –

            Job error.

          • sourceServerID (string) –

            Job Event Source Server ID.

          • targetInstanceID (string) –

            Job Event Target instance ID.

        • logDateTime (string) –

          Job log event date and time.

    • nextToken (string) –

      Request to describe Job log response next token.

Exceptions