Request Syntax Request Parameters Response Elements Errors See Also

UpdateJob

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Request Syntax


{
   "AddressId": "string",
   "Description": "string",
   "ForwardingAddressId": "string",
   "JobId": "string",
   "Notification": { 
      "DevicePickupSnsTopicARN": "string",
      "JobStatesToNotify": [ "string" ],
      "NotifyAll": boolean,
      "SnsTopicARN": "string"
   },
   "OnDeviceServiceConfiguration": { 
      "EKSOnDeviceService": { 
         "EKSAnywhereVersion": "string",
         "KubernetesVersion": "string"
      },
      "NFSOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "S3OnDeviceService": { 
         "FaultTolerance": number,
         "ServiceSize": number,
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "TGWOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      }
   },
   "PickupDetails": { 
      "DevicePickupId": "string",
      "Email": "string",
      "IdentificationExpirationDate": number,
      "IdentificationIssuingOrg": "string",
      "IdentificationNumber": "string",
      "Name": "string",
      "PhoneNumber": "string"
   },
   "Resources": { 
      "Ec2AmiResources": [ 
         { 
            "AmiId": "string",
            "SnowballAmiId": "string"
         }
      ],
      "LambdaResources": [ 
         { 
            "EventTriggers": [ 
               { 
                  "EventResourceARN": "string"
               }
            ],
            "LambdaArn": "string"
         }
      ],
      "S3Resources": [ 
         { 
            "BucketArn": "string",
            "KeyRange": { 
               "BeginMarker": "string",
               "EndMarker": "string"
            },
            "TargetOnDeviceServices": [ 
               { 
                  "ServiceName": "string",
                  "TransferOption": "string"
               }
            ]
         }
      ]
   },
   "RoleARN": "string",
   "ShippingOption": "string",
   "SnowballCapacityPreference": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AddressId

The ID of the updated Address object.

Type: String

Length Constraints: Fixed length of 40.

Pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

Description

The updated description of this job's JobMetadata object.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

ForwardingAddressId

This field is not supported in your region.

Type: String

Length Constraints: Fixed length of 40.

Pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

JobId

The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

Type: String

Length Constraints: Fixed length of 39.

Pattern: (M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Notification

The new or updated Notification object.

Type: Notification object

Required: No

OnDeviceServiceConfiguration

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System) and the AWS Storage Gateway service Tape Gateway type.

Type: OnDeviceServiceConfiguration object

Required: No

PickupDetails

Information identifying the person picking up the device.

Type: PickupDetails object

Required: No

Resources

The updated JobResource object, or the updated JobResource object.

Type: JobResource object

Required: No

RoleARN

The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRole AWS Identity and Access Management (IAM) API action.

Type: String

Length Constraints: Maximum length of 255.

Pattern: arn:aws.*:iam::[0-9]{12}:role/.*

Required: No

ShippingOption

The updated shipping option value of this job's ShippingDetails object.

Type: String

Valid Values: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD

Required: No

SnowballCapacityPreference

The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

For information about Snow Family device types, see Snow Family Devices and Capacity in the Snowcone User Guide or Snow Family Devices and Capacity in the Snowball Edge User Guide.

Type: String

Valid Values: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterLimitExceededException

Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.

HTTP Status Code: 400

Ec2RequestFailedException

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

HTTP Status Code: 400

InvalidInputCombinationException

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateCluster:SnowballType value supports your CreateJob:JobType, and try again.

HTTP Status Code: 400

InvalidJobStateException

The action can't be performed because the job's current state doesn't allow that action to be performed.

HTTP Status Code: 400

InvalidResourceException

The specified resource can't be found. Check the information you provided in your last request, and try again.

HTTP Status Code: 400

KMSRequestFailedException

The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

HTTP Status Code: 400