ImportExport / Client / list_jobs

list_jobs#

ImportExport.Client.list_jobs(**kwargs)#

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    MaxJobs=123,
    Marker='string',
    APIVersion='string'
)
Parameters:

  • MaxJobs (integer) – Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see Marker.

  • Marker (string) – Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs.

  • APIVersion (string) – Specifies the version of the client tool.

Return type:

dict

Returns:

Response Syntax

{
    'Jobs': [
        {
            'JobId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'IsCanceled': True|False,
            'JobType': 'Import'|'Export'
        },
    ],
    'IsTruncated': True|False
}

Response Structure

  • (dict) – Output structure for the ListJobs operation.

    • Jobs (list) – A list container for Jobs returned by the ListJobs operation.

      • (dict) – Representation of a job returned by the ListJobs operation.

        • JobId (string) – A unique identifier which refers to a particular job.

        • CreationDate (datetime) – Timestamp of the CreateJob request in ISO8601 date format. For example “2010-03-28T20:27:35Z”.

        • IsCanceled (boolean) – Indicates whether the job was canceled.

        • JobType (string) – Specifies whether the job to initiate is an import or export job.

    • IsTruncated (boolean) – Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker.

Exceptions

  • ImportExport.Client.exceptions.InvalidParameterException

  • ImportExport.Client.exceptions.InvalidAccessKeyIdException

  • ImportExport.Client.exceptions.InvalidVersionException