SDK for PHP 3.x

AWS Import/Export 2010-06-01

Client: Aws\ImportExport\ImportExportClient
Service ID: importexport
Version: 2010-06-01

This page describes the parameters and results for the operations of the AWS Import/Export (2010-06-01), and shows how to use the Aws\ImportExport\ImportExportClient object to call the described operations. This documentation is specific to the 2010-06-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelJob ( array $params = [] )
This operation cancels a specified job.
CreateJob ( array $params = [] )
This operation initiates the process of scheduling an upload or download of your data.
GetShippingLabel ( array $params = [] )
This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
GetStatus ( array $params = [] )
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.
ListJobs ( array $params = [] )
This operation returns the jobs associated with the requester.
UpdateJob ( array $params = [] )
You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListJobs

Operations

CancelJob 

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelJob([
    'APIVersion' => '<string>',
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
APIVersion
Type: string
Specifies the version of the client tool.
JobId
Required: Yes
Type: string
A unique identifier which refers to a particular job.

Result Syntax

[
    'Success' => true || false,
]

Result Details

Members
Success
Type: boolean
Specifies whether (true) or not (false) AWS Import/Export updated your job.

Errors

InvalidJobIdException:
The JOBID was missing, not found, or not associated with the AWS account.
ExpiredJobIdException:
Indicates that the specified job has expired out of the system.
CanceledJobIdException:
The specified job ID has been canceled and is no longer valid.
UnableToCancelJobIdException:
AWS Import/Export cannot cancel the job
InvalidAccessKeyIdException:
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidVersionException:
The client tool version is invalid.

CreateJob 

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createJob([
    'APIVersion' => '<string>',
    'JobType' => 'Import|Export', // REQUIRED
    'Manifest' => '<string>', // REQUIRED
    'ManifestAddendum' => '<string>',
    'ValidateOnly' => true || false, // REQUIRED
]);

Parameter Details

Members
APIVersion
Type: string
Specifies the version of the client tool.
JobType
Required: Yes
Type: string
Specifies whether the job to initiate is an import or export job.
Manifest
Required: Yes
Type: string
The UTF-8 encoded text of the manifest file.
ManifestAddendum
Type: string
For internal use only.
ValidateOnly
Required: Yes
Type: boolean
Validate the manifest and parameter values in the request but do not actually create a job.

Result Syntax

[
    'ArtifactList' => [
        [
            'Description' => '<string>',
            'URL' => '<string>',
        ],
        // ...
    ],
    'JobId' => '<string>',
    'JobType' => 'Import|Export',
    'Signature' => '<string>',
    'SignatureFileContents' => '<string>',
    'WarningMessage' => '<string>',
]

Result Details

Members
ArtifactList
Type: Array of Artifact structures
A collection of artifacts.
JobId
Type: string
A unique identifier which refers to a particular job.
JobType
Type: string
Specifies whether the job to initiate is an import or export job.
Signature
Type: 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
Type: string
The actual text of the SIGNATURE file to be written to disk.
WarningMessage
Type: string
An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

Errors

MissingParameterException:
One or more required parameters was missing from the request.
InvalidParameterException:
One or more parameters had an invalid value.
InvalidAccessKeyIdException:
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidAddressException:
The address specified in the manifest is invalid.
InvalidManifestFieldException:
One or more manifest fields was invalid. Please correct and resubmit.
MissingManifestFieldException:
One or more required fields were missing from the manifest file. Please correct and resubmit.
NoSuchBucketException:
The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.
MissingCustomsException:
One or more required customs parameters was missing from the manifest.
InvalidCustomsException:
One or more customs parameters was invalid. Please correct and resubmit.
InvalidFileSystemException:
File system specified in export manifest is invalid.
MultipleRegionsException:
Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.
BucketPermissionException:
The account specified does not have the appropriate bucket permissions.
MalformedManifestException:
Your manifest is not well-formed.
CreateJobQuotaExceededException:
Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case.
InvalidJobIdException:
The JOBID was missing, not found, or not associated with the AWS account.
InvalidVersionException:
The client tool version is invalid.

GetShippingLabel 

$result = $client->getShippingLabel([/* ... */]);
$promise = $client->getShippingLabelAsync([/* ... */]);

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Parameter Syntax

$result = $client->getShippingLabel([
    'APIVersion' => '<string>',
    'city' => '<string>',
    'company' => '<string>',
    'country' => '<string>',
    'jobIds' => ['<string>', ...], // REQUIRED
    'name' => '<string>',
    'phoneNumber' => '<string>',
    'postalCode' => '<string>',
    'stateOrProvince' => '<string>',
    'street1' => '<string>',
    'street2' => '<string>',
    'street3' => '<string>',
]);

Parameter Details

Members
APIVersion
Type: string
Specifies the version of the client tool.
city
Type: string
Specifies the name of your city for the return address.
company
Type: string
Specifies the name of the company that will ship this package.
country
Type: string
Specifies the name of your country for the return address.
jobIds
Required: Yes
Type: Array of strings
name
Type: string
Specifies the name of the person responsible for shipping this package.
phoneNumber
Type: string
Specifies the phone number of the person responsible for shipping this package.
postalCode
Type: string
Specifies the postal code for the return address.
stateOrProvince
Type: string
Specifies the name of your state or your province for the return address.
street1
Type: string
Specifies the first part of the street address for the return address, for example 1234 Main Street.
street2
Type: string
Specifies the optional second part of the street address for the return address, for example Suite 100.
street3
Type: string
Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.

Result Syntax

[
    'ShippingLabelURL' => '<string>',
    'Warning' => '<string>',
]

Result Details

Members
ShippingLabelURL
Type: string
Warning
Type: string

Errors

InvalidJobIdException:
The JOBID was missing, not found, or not associated with the AWS account.
ExpiredJobIdException:
Indicates that the specified job has expired out of the system.
CanceledJobIdException:
The specified job ID has been canceled and is no longer valid.
InvalidAccessKeyIdException:
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidAddressException:
The address specified in the manifest is invalid.
InvalidVersionException:
The client tool version is invalid.
InvalidParameterException:
One or more parameters had an invalid value.

GetStatus 

$result = $client->getStatus([/* ... */]);
$promise = $client->getStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getStatus([
    'APIVersion' => '<string>',
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
APIVersion
Type: string
Specifies the version of the client tool.
JobId
Required: Yes
Type: string
A unique identifier which refers to a particular job.

Result Syntax

[
    'ArtifactList' => [
        [
            'Description' => '<string>',
            'URL' => '<string>',
        ],
        // ...
    ],
    'Carrier' => '<string>',
    'CreationDate' => <DateTime>,
    'CurrentManifest' => '<string>',
    'ErrorCount' => <integer>,
    'JobId' => '<string>',
    'JobType' => 'Import|Export',
    'LocationCode' => '<string>',
    'LocationMessage' => '<string>',
    'LogBucket' => '<string>',
    'LogKey' => '<string>',
    'ProgressCode' => '<string>',
    'ProgressMessage' => '<string>',
    'Signature' => '<string>',
    'SignatureFileContents' => '<string>',
    'TrackingNumber' => '<string>',
]

Result Details

Members
ArtifactList
Type: Array of Artifact structures
A collection of artifacts.
Carrier
Type: string
Name of the shipping company. This value is included when the LocationCode is "Returned".
CreationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".
CurrentManifest
Type: string
The last manifest submitted, which will be used to process the job.
ErrorCount
Type: int
Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.
JobId
Type: string
A unique identifier which refers to a particular job.
JobType
Type: string
Specifies whether the job to initiate is an import or export job.
LocationCode
Type: string
A token representing the location of the storage device, such as "AtAWS".
LocationMessage
Type: string
A more human readable form of the physical location of the storage device.
LogBucket
Type: string
Amazon S3 bucket for user logs.
LogKey
Type: string
The key where the user logs were stored.
ProgressCode
Type: string
A token representing the state of the job, such as "Started".
ProgressMessage
Type: string
A more human readable form of the job status.
Signature
Type: 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
Type: 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.
TrackingNumber
Type: 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".

Errors

InvalidJobIdException:
The JOBID was missing, not found, or not associated with the AWS account.
ExpiredJobIdException:
Indicates that the specified job has expired out of the system.
CanceledJobIdException:
The specified job ID has been canceled and is no longer valid.
InvalidAccessKeyIdException:
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidVersionException:
The client tool version is invalid.

ListJobs 

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listJobs([
    'APIVersion' => '<string>',
    'Marker' => '<string>',
    'MaxJobs' => <integer>,
]);

Parameter Details

Members
APIVersion
Type: string
Specifies the version of the client tool.
Marker
Type: 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.
MaxJobs
Type: int
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.

Result Syntax

[
    'IsTruncated' => true || false,
    'Jobs' => [
        [
            'CreationDate' => <DateTime>,
            'IsCanceled' => true || false,
            'JobId' => '<string>',
            'JobType' => 'Import|Export',
        ],
        // ...
    ],
]

Result Details

Members
IsTruncated
Type: boolean
Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker.
Jobs
Type: Array of Job structures
A list container for Jobs returned by the ListJobs operation.

Errors

InvalidParameterException:
One or more parameters had an invalid value.
InvalidAccessKeyIdException:
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidVersionException:
The client tool version is invalid.

UpdateJob 

$result = $client->updateJob([/* ... */]);
$promise = $client->updateJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateJob([
    'APIVersion' => '<string>',
    'JobId' => '<string>', // REQUIRED
    'JobType' => 'Import|Export', // REQUIRED
    'Manifest' => '<string>', // REQUIRED
    'ValidateOnly' => true || false, // REQUIRED
]);

Parameter Details

Members
APIVersion
Type: string
Specifies the version of the client tool.
JobId
Required: Yes
Type: string
A unique identifier which refers to a particular job.
JobType
Required: Yes
Type: string
Specifies whether the job to initiate is an import or export job.
Manifest
Required: Yes
Type: string
The UTF-8 encoded text of the manifest file.
ValidateOnly
Required: Yes
Type: boolean
Validate the manifest and parameter values in the request but do not actually create a job.

Result Syntax

[
    'ArtifactList' => [
        [
            'Description' => '<string>',
            'URL' => '<string>',
        ],
        // ...
    ],
    'Success' => true || false,
    'WarningMessage' => '<string>',
]

Result Details

Members
ArtifactList
Type: Array of Artifact structures
A collection of artifacts.
Success
Type: boolean
Specifies whether (true) or not (false) AWS Import/Export updated your job.
WarningMessage
Type: string
An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

Errors

MissingParameterException:
One or more required parameters was missing from the request.
InvalidParameterException:
One or more parameters had an invalid value.
InvalidAccessKeyIdException:
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidAddressException:
The address specified in the manifest is invalid.
InvalidManifestFieldException:
One or more manifest fields was invalid. Please correct and resubmit.
InvalidJobIdException:
The JOBID was missing, not found, or not associated with the AWS account.
MissingManifestFieldException:
One or more required fields were missing from the manifest file. Please correct and resubmit.
NoSuchBucketException:
The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.
ExpiredJobIdException:
Indicates that the specified job has expired out of the system.
CanceledJobIdException:
The specified job ID has been canceled and is no longer valid.
MissingCustomsException:
One or more required customs parameters was missing from the manifest.
InvalidCustomsException:
One or more customs parameters was invalid. Please correct and resubmit.
InvalidFileSystemException:
File system specified in export manifest is invalid.
MultipleRegionsException:
Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.
BucketPermissionException:
The account specified does not have the appropriate bucket permissions.
MalformedManifestException:
Your manifest is not well-formed.
UnableToUpdateJobIdException:
AWS Import/Export cannot update the job
InvalidVersionException:
The client tool version is invalid.

Shapes

Artifact

Description
A discrete item that contains the description and URL of an artifact (such as a PDF).
Members
Description
Type: string
The associated description for this object.
URL
Type: string
The URL for a given Artifact.

BucketPermissionException

Description
The account specified does not have the appropriate bucket permissions.
Members
message
Type: string
The human-readable description of a particular error.

CancelJobOutput

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

CanceledJobIdException

Description
The specified job ID has been canceled and is no longer valid.
Members
message
Type: string
The human-readable description of a particular error.

CreateJobOutput

Description
Output structure for the CreateJob operation.
Members
ArtifactList
Type: Array of Artifact structures
A collection of artifacts.
JobId
Type: string
A unique identifier which refers to a particular job.
JobType
Type: string
Specifies whether the job to initiate is an import or export job.
Signature
Type: 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
Type: string
The actual text of the SIGNATURE file to be written to disk.
WarningMessage
Type: string
An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

CreateJobQuotaExceededException

Description
Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case.
Members
message
Type: string
The human-readable description of a particular error.

ExpiredJobIdException

Description
Indicates that the specified job has expired out of the system.
Members
message
Type: string
The human-readable description of a particular error.

GetShippingLabelOutput

Members
ShippingLabelURL
Type: string
Warning
Type: string

GetStatusOutput

Description
Output structure for the GetStatus operation.
Members
ArtifactList
Type: Array of Artifact structures
A collection of artifacts.
Carrier
Type: string
Name of the shipping company. This value is included when the LocationCode is "Returned".
CreationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".
CurrentManifest
Type: string
The last manifest submitted, which will be used to process the job.
ErrorCount
Type: int
Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.
JobId
Type: string
A unique identifier which refers to a particular job.
JobType
Type: string
Specifies whether the job to initiate is an import or export job.
LocationCode
Type: string
A token representing the location of the storage device, such as "AtAWS".
LocationMessage
Type: string
A more human readable form of the physical location of the storage device.
LogBucket
Type: string
Amazon S3 bucket for user logs.
LogKey
Type: string
The key where the user logs were stored.
ProgressCode
Type: string
A token representing the state of the job, such as "Started".
ProgressMessage
Type: string
A more human readable form of the job status.
Signature
Type: 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
Type: 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.
TrackingNumber
Type: 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".

InvalidAccessKeyIdException

Description
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
Members
message
Type: string
The human-readable description of a particular error.

InvalidAddressException

Description
The address specified in the manifest is invalid.
Members
message
Type: string
The human-readable description of a particular error.

InvalidCustomsException

Description
One or more customs parameters was invalid. Please correct and resubmit.
Members
message
Type: string
The human-readable description of a particular error.

InvalidFileSystemException

Description
File system specified in export manifest is invalid.
Members
message
Type: string
The human-readable description of a particular error.

InvalidJobIdException

Description
The JOBID was missing, not found, or not associated with the AWS account.
Members
message
Type: string
The human-readable description of a particular error.

InvalidManifestFieldException

Description
One or more manifest fields was invalid. Please correct and resubmit.
Members
message
Type: string
The human-readable description of a particular error.

InvalidParameterException

Description
One or more parameters had an invalid value.
Members
message
Type: string
The human-readable description of a particular error.

InvalidVersionException

Description
The client tool version is invalid.
Members
message
Type: string
The human-readable description of a particular error.

Job

Description
Representation of a job returned by the ListJobs operation.
Members
CreationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".
IsCanceled
Type: boolean
Indicates whether the job was canceled.
JobId
Type: string
A unique identifier which refers to a particular job.
JobType
Type: string
Specifies whether the job to initiate is an import or export job.

ListJobsOutput

Description
Output structure for the ListJobs operation.
Members
IsTruncated
Type: boolean
Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker.
Jobs
Type: Array of Job structures
A list container for Jobs returned by the ListJobs operation.

MalformedManifestException

Description
Your manifest is not well-formed.
Members
message
Type: string
The human-readable description of a particular error.

MissingCustomsException

Description
One or more required customs parameters was missing from the manifest.
Members
message
Type: string
The human-readable description of a particular error.

MissingManifestFieldException

Description
One or more required fields were missing from the manifest file. Please correct and resubmit.
Members
message
Type: string
The human-readable description of a particular error.

MissingParameterException

Description
One or more required parameters was missing from the request.
Members
message
Type: string
The human-readable description of a particular error.

MultipleRegionsException

Description
Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.
Members
message
Type: string
The human-readable description of a particular error.

NoSuchBucketException

Description
The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.
Members
message
Type: string
The human-readable description of a particular error.

UnableToCancelJobIdException

Description
AWS Import/Export cannot cancel the job
Members
message
Type: string
The human-readable description of a particular error.

UnableToUpdateJobIdException

Description
AWS Import/Export cannot update the job
Members
message
Type: string
The human-readable description of a particular error.

UpdateJobOutput

Description
Output structure for the UpateJob operation.
Members
ArtifactList
Type: Array of Artifact structures
A collection of artifacts.
Success
Type: boolean
Specifies whether (true) or not (false) AWS Import/Export updated your job.
WarningMessage
Type: string
An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.