You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ImportExport::Types::GetShippingLabelInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb

Overview

Note:

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

{
  job_ids: ["GenericString"], # required
  name: "name",
  company: "company",
  phone_number: "phoneNumber",
  country: "country",
  state_or_province: "stateOrProvince",
  city: "city",
  postal_code: "postalCode",
  street1: "street1",
  street2: "street2",
  street3: "street3",
  api_version: "APIVersion",
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_versionString

Specifies the version of the client tool.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#cityString

Specifies the name of your city for the return address.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#companyString

Specifies the name of the company that will ship this package.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#countryString

Specifies the name of your country for the return address.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#job_idsArray<String>

Returns:

  • (Array<String>)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#nameString

Specifies the name of the person responsible for shipping this package.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#phone_numberString

Specifies the phone number of the person responsible for shipping this package.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#postal_codeString

Specifies the postal code for the return address.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#state_or_provinceString

Specifies the name of your state or your province for the return address.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#street1String

Specifies the first part of the street address for the return address, for example 1234 Main Street.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#street2String

Specifies the optional second part of the street address for the return address, for example Suite 100.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end

#street3String

Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.

Returns:

  • (String)


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 218

class GetShippingLabelInput < Struct.new(
  :job_ids,
  :name,
  :company,
  :phone_number,
  :country,
  :state_or_province,
  :city,
  :postal_code,
  :street1,
  :street2,
  :street3,
  :api_version)
  include Aws::Structure
end