- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateJobShipmentStateCommand
Updates the state when a shipment state changes to a different state.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SnowballClient, UpdateJobShipmentStateCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, UpdateJobShipmentStateCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // UpdateJobShipmentStateRequest
JobId: "STRING_VALUE", // required
ShipmentState: "RECEIVED" || "RETURNED", // required
};
const command = new UpdateJobShipmentStateCommand(input);
const response = await client.send(command);
// {};
UpdateJobShipmentStateCommand Input
See UpdateJobShipmentStateCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
JobIdRequired | string | undefined | The job ID of the job whose shipment date you want to update, for example |
ShipmentStateRequired | ShipmentState | undefined | The state of a device when it is being shipped. Set to Set to |
UpdateJobShipmentStateCommand Output
See UpdateJobShipmentStateCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidJobStateException | client | The action can't be performed because the job's current state doesn't allow that action to be performed. |
| InvalidResourceException | client | The specified resource can't be found. Check the information you provided in your last request, and try again. |
| SnowballServiceException | Base exception class for all service exceptions from Snowball service. |