AWS API Changes

2015/01/27 - AWS Import/Export - 1 new 5 updated api methods

GetShippingLabel (new)

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

client.get_shipping_label(
    jobIds=[
        'string',
    ],
    name='string',
    company='string',
    phoneNumber='string',
    country='string',
    stateOrProvince='string',
    city='string',
    postalCode='string',
    street1='string',
    street2='string',
    street3='string',
    APIVersion='string'
)

type jobIds

list

param jobIds

[REQUIRED]

(string) --

type name

string

param name

type company

string

param company

type phoneNumber

string

param phoneNumber

type country

string

param country

type stateOrProvince

string

param stateOrProvince

type city

string

param city

type postalCode

string

param postalCode

type street1

string

param street1

type street2

string

param street2

type street3

string

param street3

type APIVersion

string

param APIVersion

rtype

dict

returns

Response Syntax

{
    'ShippingLabelURL': 'string',
    'Warning': 'string'
}

Response Structure

(dict) --
- ShippingLabelURL (string) --
- Warning (string) --

CancelJob (updated)

Link ¶
Changes (request)

{'APIVersion': 'string'}

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Request Syntax

client.cancel_job(
    JobId='string',
    APIVersion='string'
)

type JobId

string

param JobId

[REQUIRED] A unique identifier which refers to a particular job.

type APIVersion

string

param APIVersion

Specifies the version of the client tool.

rtype

dict

returns

Response Syntax

{
    'Success': True|False
}

Response Structure

(dict) -- Output structure for the CancelJob operation.
- Success (boolean) -- Specifies whether (true) or not (false) AWS Import/Export updated your job.

CreateJob (updated)

Link ¶
Changes (request, response)
Request

{'APIVersion': 'string'}

Response

{'ArtifactList': [{'Description': 'string', 'URL': 'string'}]}

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

Request Syntax

client.create_job(
    JobType='Import'|'Export',
    Manifest='string',
    ManifestAddendum='string',
    ValidateOnly=True|False,
    APIVersion='string'
)

type JobType

string

param JobType

[REQUIRED] Specifies whether the job to initiate is an import or export job.

type Manifest

string

param Manifest

[REQUIRED] The UTF-8 encoded text of the manifest file.

type ManifestAddendum

string

param ManifestAddendum

For internal use only.

type ValidateOnly

boolean

param ValidateOnly

[REQUIRED] Validate the manifest and parameter values in the request but do not actually create a job.

type APIVersion

string

param APIVersion

Specifies the version of the client tool.

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobType': 'Import'|'Export',
    'Signature': 'string',
    'SignatureFileContents': 'string',
    'WarningMessage': 'string',
    'ArtifactList': [
        {
            'Description': 'string',
            'URL': 'string'
        },
    ]
}

Response Structure

(dict) -- Output structure for the CreateJob 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.
- 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) -- The actual text of the SIGNATURE file to be written to disk.
- WarningMessage (string) -- An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.
- 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.

GetStatus (updated)

Link ¶
Changes (request, response)
Request

{'APIVersion': 'string'}

Response

{'ArtifactList': [{'Description': 'string', 'URL': 'string'}]}

Request Syntax

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

type JobId

string

param JobId

[REQUIRED] A unique identifier which refers to a particular job.

type APIVersion

string

param APIVersion

Specifies the version of the client tool.

rtype

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.

ListJobs (updated)

Link ¶
Changes (request)

{'APIVersion': 'string'}

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.

Request Syntax

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

type MaxJobs

integer

param MaxJobs

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.

type Marker

string

param Marker

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.

type APIVersion

string

param APIVersion

Specifies the version of the client tool.

rtype

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.

UpdateJob (updated)

Link ¶
Changes (request, response)
Request

{'APIVersion': 'string'}

Response

{'ArtifactList': [{'Description': 'string', 'URL': 'string'}]}

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

Request Syntax

client.update_job(
    JobId='string',
    Manifest='string',
    JobType='Import'|'Export',
    ValidateOnly=True|False,
    APIVersion='string'
)

type JobId

string

param JobId

[REQUIRED] A unique identifier which refers to a particular job.

type Manifest

string

param Manifest

[REQUIRED] The UTF-8 encoded text of the manifest file.

type JobType

string

param JobType

[REQUIRED] Specifies whether the job to initiate is an import or export job.

type ValidateOnly

boolean

param ValidateOnly

[REQUIRED] Validate the manifest and parameter values in the request but do not actually create a job.

type APIVersion

string

param APIVersion

Specifies the version of the client tool.

rtype

dict

returns

Response Syntax

{
    'Success': True|False,
    'WarningMessage': 'string',
    'ArtifactList': [
        {
            'Description': 'string',
            'URL': 'string'
        },
    ]
}

Response Structure

(dict) -- Output structure for the UpateJob operation.
- Success (boolean) -- Specifies whether (true) or not (false) AWS Import/Export updated your job.
- WarningMessage (string) -- An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.
- 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.