Snowball / Client / list_jobs

list_jobs#

Snowball.Client.list_jobs(**kwargs)#

Returns an array of JobListEntry objects of the specified length. 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. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The number of JobListEntry objects to return.
NextToken (string) – HTTP requests are stateless. To identify what object comes “next” in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

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',
            'CreationDate': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

Exceptions

Snowball.Client.exceptions.InvalidNextTokenException

Examples

Returns an array of JobListEntry objects of the specified length. 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. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

response = client.list_jobs(
)

print(response)

Expected Output:

{
    'JobListEntries': [
        {
            'CreationDate': datetime(2016, 4, 14, 23, 56, 26, 3, 105, 0),
            'Description': 'MyJob',
            'IsMaster': False,
            'JobId': 'JID123e4567-e89b-12d3-a456-426655440000',
            'JobState': 'New',
            'JobType': 'IMPORT',
            'SnowballType': 'STANDARD',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}