update_job_shipment_state

Snowball.Client.update_job_shipment_state(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_job_shipment_state(
    JobId='string',
    ShipmentState='RECEIVED'|'RETURNED'
)
Parameters
  • JobId (string) --

    [REQUIRED]

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

  • ShipmentState (string) --

    [REQUIRED]

    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 Amazon Web Services.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Snowball.Client.exceptions.InvalidResourceException
  • Snowball.Client.exceptions.InvalidJobStateException