UpdateJobShipmentState
Important
End of support notice: On November 12, 2024, AWS will discontinue previous generation AWS Snowball devices, and both Snowcone devices (HDD and SDD). We will continue to support existing customers using these end-of-life devices until November 12, 2025. The latest generation AWS Snowball devices are available for all customers.
For more information, visit this blog post
Updates the state when a shipment state changes to a different state.
Request Syntax
{
"JobId": "string",
"ShipmentState": "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.
- JobId
-
The job ID of the job whose shipment date 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
- ShipmentState
-
The state of a device when it is being shipped.
Set to
RECEIVEDwhen the device arrives at your location.Set to
RETURNEDwhen you have returned the device to AWS.Type: String
Valid Values:
RECEIVED | RETURNEDRequired: Yes
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.
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
