

# UpdateJobShipmentState
<a name="API_UpdateJobShipmentState"></a>

**Note**  
 AWS Snowball Edge is no longer available to new customers. New customers should explore [AWS DataSync](https://aws.amazon.com/datasync/) for online transfers, [AWS Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or AWS Partner solutions. For edge computing, explore [AWS Outposts](https://aws.amazon.com/outposts/).

Updates the state when a shipment state changes to a different state.

## Request Syntax
<a name="API_UpdateJobShipmentState_RequestSyntax"></a>

```
{
   "JobId": "string",
   "ShipmentState": "string"
}
```

## Request Parameters
<a name="API_UpdateJobShipmentState_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [JobId](#API_UpdateJobShipmentState_RequestSyntax) **   <a name="Snowball-UpdateJobShipmentState-request-JobId"></a>
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](#API_UpdateJobShipmentState_RequestSyntax) **   <a name="Snowball-UpdateJobShipmentState-request-ShipmentState"></a>
The state of a device when it is being shipped.   
Set to `RECEIVED` when the device arrives at your location.  
Set to `RETURNED` when you have returned the device to AWS.  
Type: String  
Valid Values: `RECEIVED | RETURNED`   
Required: Yes

## Response Elements
<a name="API_UpdateJobShipmentState_ResponseElements"></a>

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

## Errors
<a name="API_UpdateJobShipmentState_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.    
 ** ResourceType **   
The provided resource value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_UpdateJobShipmentState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/snowball-2016-06-30/UpdateJobShipmentState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/UpdateJobShipmentState) 