Class: Aws::Snowball::Types::UpdateJobShipmentStateRequest

Inherits:

Struct

Object
Struct
Aws::Snowball::Types::UpdateJobShipmentStateRequest

show all

Defined in:: gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb

Overview

Note:

When making an API call, you may pass UpdateJobShipmentStateRequest data as a hash:

{
  job_id: "JobId", # required
  shipment_state: "RECEIVED", # required, accepts RECEIVED, RETURNED
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#job_id ⇒ String
The job ID of the job whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
#shipment_state ⇒ String
The state of a device when it is being shipped.

Instance Attribute Details

#job_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2961

class UpdateJobShipmentStateRequest < Struct.new(
  :job_id,
  :shipment_state)
  SENSITIVE = []
  include Aws::Structure
end

#shipment_state ⇒ `String`

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.