mgn / Paginator / DescribeJobLogItems

DescribeJobLogItems

class mgn.Paginator.DescribeJobLogItems

paginator = client.get_paginator('describe_job_log_items')

paginate(**kwargs)

Creates an iterator that will paginate through responses from mgn.Client.describe_job_log_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    jobID='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• jobID (string) –

  [REQUIRED]

  Request to describe Job log job ID.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.