ImportExport / Client / update_job

update_job#

ImportExport.Client.update_job(**kwargs)#

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

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

Return type:

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.

Exceptions

  • ImportExport.Client.exceptions.MissingParameterException

  • ImportExport.Client.exceptions.InvalidParameterException

  • ImportExport.Client.exceptions.InvalidAccessKeyIdException

  • ImportExport.Client.exceptions.InvalidAddressException

  • ImportExport.Client.exceptions.InvalidManifestFieldException

  • ImportExport.Client.exceptions.InvalidJobIdException

  • ImportExport.Client.exceptions.MissingManifestFieldException

  • ImportExport.Client.exceptions.NoSuchBucketException

  • ImportExport.Client.exceptions.ExpiredJobIdException

  • ImportExport.Client.exceptions.CanceledJobIdException

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

  • ImportExport.Client.exceptions.InvalidVersionException