Snowball / Paginator / ListJobs

ListJobs

class Snowball.Paginator.ListJobs

paginator = client.get_paginator('list_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Snowball.Client.list_jobs().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'JobListEntries': [
        {
            'JobId': 'string',
            'JobState': 'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
            'IsMaster': True|False,
            'JobType': 'IMPORT'|'EXPORT'|'LOCAL_USE',
            'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C'|'V3_5S',
            'CreationDate': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • JobListEntries (list) –

    Each JobListEntry object contains a job’s state, a job’s ID, and a value that indicates whether the job is a job part, in the case of export jobs.

    • (dict) –

      Each JobListEntry object contains a job’s state, a job’s ID, and a value that indicates whether the job is a job part, in the case of an export job.

      • JobId (string) –

        The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

      • JobState (string) –

        The current state of this job.

      • IsMaster (boolean) –

        A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren’t associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

      • JobType (string) –

        The type of job.

      • SnowballType (string) –

        The type of device used with this job.

      • CreationDate (datetime) –

        The creation date for this job.

      • Description (string) –

        The optional description of this specific job, for example Important Photos 2016-08-11.