ListJobs¶

class EndUserMessaging.Paginator.ListJobs¶

paginator = client.get_paginator('list_jobs')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    status='SUCCESS'|'PROCESSING'|'FAILED',
    brandProfileId='string',
    operationType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

status (string) – Filters the results to jobs that have the specified status.
brandProfileId (string) – Filters the results to jobs for the specified brand profile.
operationType (string) – Filters the results to jobs of the specified operation type.
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

{
    'jobs': [
        {
            'jobId': 'string',
            'status': 'SUCCESS'|'PROCESSING'|'FAILED',
            'operationType': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'brandProfileId': 'string',
            'errorCode': 'string',
            'errorMessage': 'string',
            'resources': [
                {
                    'resourceType': 'REGISTRATION'|'BRAND_PROFILE',
                    'resourceId': 'string',
                    'resourceArn': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- jobs (list) –
  
  The list of asynchronous jobs.
  - (dict) –
    
    Contains summary information about an asynchronous job in a list response.
    - jobId (string) –
      
      The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
    - status (string) –
      
      The current lifecycle status of the job.
    - operationType (string) –
      
      The type of mutating operation that created the job.
    - createdAt (datetime) –
      
      The time when the resource was created, in Unix epoch time.
    - updatedAt (datetime) –
      
      The time when the resource was last updated, in Unix epoch time.
    - brandProfileId (string) –
      
      The brand profile that the job operates on. This value is absent for operations that create a brand profile.
    - errorCode (string) –
      
      A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
    - errorMessage (string) –
      
      A human-readable description of why the job failed. This value is present only when the job status is FAILED.
    - resources (list) –
      
      The resources that were created or updated by the job.
      - (dict) –
        
        Contains information about a resource that was created or updated by an asynchronous job.
        
        resourceType (string) –
        
        The type of the resource that the job created or updated.
        
        resourceId (string) –
        
        The identifier of the resource that the job created or updated.
        
        resourceArn (string) –
        
        The Amazon Resource Name (ARN) of the resource.
- NextToken (string) –
  
  A token to resume pagination.