ImportExport / Client / get_status

get_status#

ImportExport.Client.get_status(**kwargs)#

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

Request Syntax

response = client.get_status(
    JobId='string',
    APIVersion='string'
)

Parameters:

JobId (string) – [REQUIRED] A unique identifier which refers to a particular job.
APIVersion (string) – Specifies the version of the client tool.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string',
    'JobType': 'Import'|'Export',
    'LocationCode': 'string',
    'LocationMessage': 'string',
    'ProgressCode': 'string',
    'ProgressMessage': 'string',
    'Carrier': 'string',
    'TrackingNumber': 'string',
    'LogBucket': 'string',
    'LogKey': 'string',
    'ErrorCount': 123,
    'Signature': 'string',
    'SignatureFileContents': 'string',
    'CurrentManifest': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'ArtifactList': [
        {
            'Description': 'string',
            'URL': 'string'
        },
    ]
}

Response Structure

(dict) – Output structure for the GetStatus operation.
- JobId (string) – A unique identifier which refers to a particular job.
- JobType (string) – Specifies whether the job to initiate is an import or export job.
- LocationCode (string) – A token representing the location of the storage device, such as “AtAWS”.
- LocationMessage (string) – A more human readable form of the physical location of the storage device.
- ProgressCode (string) – A token representing the state of the job, such as “Started”.
- ProgressMessage (string) – A more human readable form of the job status.
- Carrier (string) – Name of the shipping company. This value is included when the LocationCode is “Returned”.
- TrackingNumber (string) – The shipping tracking number assigned by AWS Import/Export to the storage device when it’s returned to you. We return this value when the LocationCode is “Returned”.
- LogBucket (string) – Amazon S3 bucket for user logs.
- LogKey (string) – The key where the user logs were stored.
- ErrorCount (integer) – Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.
- Signature (string) – An encrypted code used to authenticate the request and response, for example, “DV+TpDfx1/TdSE9ktyK9k/bDTVI=”. Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.
- SignatureFileContents (string) – An encrypted code used to authenticate the request and response, for example, “DV+TpDfx1/TdSE9ktyK9k/bDTVI=”. Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.
- CurrentManifest (string) – The last manifest submitted, which will be used to process the job.
- CreationDate (datetime) – Timestamp of the CreateJob request in ISO8601 date format. For example “2010-03-28T20:27:35Z”.
- ArtifactList (list) – A collection of artifacts.
  - (dict) – A discrete item that contains the description and URL of an artifact (such as a PDF).
    - Description (string) – The associated description for this object.
    - URL (string) – The URL for a given Artifact.

Exceptions

ImportExport.Client.exceptions.InvalidJobIdException
ImportExport.Client.exceptions.ExpiredJobIdException
ImportExport.Client.exceptions.CanceledJobIdException
ImportExport.Client.exceptions.InvalidAccessKeyIdException
ImportExport.Client.exceptions.InvalidVersionException