create_job

ImportExport.Client.create_job(**kwargs)

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'
)

Parameters

• 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.

Return type

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.

Exceptions

• ImportExport.Client.exceptions.MissingParameterException
• ImportExport.Client.exceptions.InvalidParameterException
• ImportExport.Client.exceptions.InvalidAccessKeyIdException
• ImportExport.Client.exceptions.InvalidAddressException
• ImportExport.Client.exceptions.InvalidManifestFieldException
• ImportExport.Client.exceptions.MissingManifestFieldException
• ImportExport.Client.exceptions.NoSuchBucketException
• ImportExport.Client.exceptions.MissingCustomsException
• ImportExport.Client.exceptions.InvalidCustomsException
• ImportExport.Client.exceptions.InvalidFileSystemException
• ImportExport.Client.exceptions.MultipleRegionsException
• ImportExport.Client.exceptions.BucketPermissionException
• ImportExport.Client.exceptions.MalformedManifestException
• ImportExport.Client.exceptions.CreateJobQuotaExceededException
• ImportExport.Client.exceptions.InvalidJobIdException
• ImportExport.Client.exceptions.InvalidVersionException