A low-level client representing AWS Import/Export AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon’s high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.:
client = session.create_client('importexport')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
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.
See also: AWS API Documentation
Request Syntax
response = client.cancel_job(
JobId='string',
APIVersion='string'
)
JobId (string) – [REQUIRED] A unique identifier which refers to a particular job.
APIVersion (string) – Specifies the version of the client tool.
dict
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.
Exceptions
Closes underlying endpoint connections.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_job(
JobType='Import'|'Export',
Manifest='string',
ManifestAddendum='string',
ValidateOnly=True|False,
APIVersion='string'
)
JobType (string) – [REQUIRED] Specifies whether the job to initiate is an import or export job.
Manifest (string) – [REQUIRED] The UTF-8 encoded text of the manifest file.
ManifestAddendum (string) – For internal use only.
ValidateOnly (boolean) – [REQUIRED] Validate the manifest and parameter values in the request but do not actually create a job.
APIVersion (string) – Specifies the version of the client tool.
dict
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.
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
See also: AWS API Documentation
Request Syntax
response = 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'
)
jobIds (list) –
[REQUIRED]
(string) –
name (string) – Specifies the name of the person responsible for shipping this package.
company (string) – Specifies the name of the company that will ship this package.
phoneNumber (string) – Specifies the phone number of the person responsible for shipping this package.
country (string) – Specifies the name of your country for the return address.
stateOrProvince (string) – Specifies the name of your state or your province for the return address.
city (string) – Specifies the name of your city for the return address.
postalCode (string) – Specifies the postal code for the return address.
street1 (string) – Specifies the first part of the street address for the return address, for example 1234 Main Street.
street2 (string) – Specifies the optional second part of the street address for the return address, for example Suite 100.
street3 (string) – Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.
APIVersion (string) – Specifies the version of the client tool.
dict
Response Syntax
{
'ShippingLabelURL': 'string',
'Warning': 'string'
}
Response Structure
(dict) –
ShippingLabelURL (string) –
Warning (string) –
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.get_status(
JobId='string',
APIVersion='string'
)
JobId (string) – [REQUIRED] A unique identifier which refers to a particular job.
APIVersion (string) – Specifies the version of the client tool.
dict
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
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
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'
)
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.
dict
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
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.
See also: AWS API Documentation
Request Syntax
response = client.update_job(
JobId='string',
Manifest='string',
JobType='Import'|'Export',
ValidateOnly=True|False,
APIVersion='string'
)
JobId (string) – [REQUIRED] A unique identifier which refers to a particular job.
Manifest (string) – [REQUIRED] The UTF-8 encoded text of the manifest file.
JobType (string) – [REQUIRED] Specifies whether the job to initiate is an import or export job.
ValidateOnly (boolean) – [REQUIRED] Validate the manifest and parameter values in the request but do not actually create a job.
APIVersion (string) – Specifies the version of the client tool.
dict
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.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
ImportExport.Client.exceptions.CreateJobQuotaExceededException
ImportExport.Client.exceptions.InvalidManifestFieldException
ImportExport.Client.exceptions.MissingManifestFieldException
The account specified does not have the appropriate bucket permissions.
Example
try:
...
except client.exceptions.BucketPermissionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The account specified does not have the appropriate bucket permissions.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The specified job ID has been canceled and is no longer valid.
Example
try:
...
except client.exceptions.CanceledJobIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The specified job ID has been canceled and is no longer valid.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
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.
Example
try:
...
except client.exceptions.CreateJobQuotaExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – 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.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Indicates that the specified job has expired out of the system.
Example
try:
...
except client.exceptions.ExpiredJobIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Indicates that the specified job has expired out of the system.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
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.
Example
try:
...
except client.exceptions.InvalidAccessKeyIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – 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.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The address specified in the manifest is invalid.
Example
try:
...
except client.exceptions.InvalidAddressException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The address specified in the manifest is invalid.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more customs parameters was invalid. Please correct and resubmit.
Example
try:
...
except client.exceptions.InvalidCustomsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – One or more customs parameters was invalid. Please correct and resubmit.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
File system specified in export manifest is invalid.
Example
try:
...
except client.exceptions.InvalidFileSystemException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – File system specified in export manifest is invalid.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The JOBID was missing, not found, or not associated with the AWS account.
Example
try:
...
except client.exceptions.InvalidJobIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The JOBID was missing, not found, or not associated with the AWS account.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more manifest fields was invalid. Please correct and resubmit.
Example
try:
...
except client.exceptions.InvalidManifestFieldException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – One or more manifest fields was invalid. Please correct and resubmit.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more parameters had an invalid value.
Example
try:
...
except client.exceptions.InvalidParameterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – One or more parameters had an invalid value.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The client tool version is invalid.
Example
try:
...
except client.exceptions.InvalidVersionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – The client tool version is invalid.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Your manifest is not well-formed.
Example
try:
...
except client.exceptions.MalformedManifestException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Your manifest is not well-formed.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more required customs parameters was missing from the manifest.
Example
try:
...
except client.exceptions.MissingCustomsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – One or more required customs parameters was missing from the manifest.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more required fields were missing from the manifest file. Please correct and resubmit.
Example
try:
...
except client.exceptions.MissingManifestFieldException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – One or more required fields were missing from the manifest file. Please correct and resubmit.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
One or more required parameters was missing from the request.
Example
try:
...
except client.exceptions.MissingParameterException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – One or more required parameters was missing from the request.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.
Example
try:
...
except client.exceptions.MultipleRegionsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
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.
Example
try:
...
except client.exceptions.NoSuchBucketException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – 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.
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AWS Import/Export cannot cancel the job
Example
try:
...
except client.exceptions.UnableToCancelJobIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – AWS Import/Export cannot cancel the job
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AWS Import/Export cannot update the job
Example
try:
...
except client.exceptions.UnableToUpdateJobIdException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – AWS Import/Export cannot update the job
message (string) – The human-readable description of a particular error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
paginator = client.get_paginator('list_jobs')
Creates an iterator that will paginate through responses from ImportExport.Client.list_jobs()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
APIVersion='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
APIVersion (string) – Specifies the version of the client tool.
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.
dict
Response Syntax
{
'Jobs': [
{
'JobId': 'string',
'CreationDate': datetime(2015, 1, 1),
'IsCanceled': True|False,
'JobType': 'Import'|'Export'
},
],
'IsTruncated': True|False,
'NextToken': 'string'
}
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.
NextToken (string) –
A token to resume pagination.