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

Class: Aws::Snowball::Types::Address

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

Overview

Note:

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

{
  address_id: "AddressId",
  name: "String",
  company: "String",
  street_1: "String",
  street_2: "String",
  street_3: "String",
  city: "String",
  state_or_province: "String",
  prefecture_or_district: "String",
  landmark: "String",
  country: "String",
  postal_code: "String",
  phone_number: "String",
  is_restricted: false,
}

The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The unique ID for an address.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#cityString

The city in an address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#companyString

The name of the company to receive a Snowball at an address.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#countryString

The country in an address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#is_restrictedBoolean

If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

Returns:

  • (Boolean)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#landmarkString

This field is no longer used and the value is ignored.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#nameString

The name of a person to receive a Snowball at an address.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#phone_numberString

The phone number associated with an address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#postal_codeString

The postal code in an address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#prefecture_or_districtString

This field is no longer used and the value is ignored.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#state_or_provinceString

The state or province in an address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#street_1String

The first line in a street address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#street_2String

The second line in a street address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end

#street_3String

The third line in a street address that a Snowball is to be delivered to.

Returns:

  • (String)


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 102

class Address < Struct.new(
  :address_id,
  :name,
  :company,
  :street_1,
  :street_2,
  :street_3,
  :city,
  :state_or_province,
  :prefecture_or_district,
  :landmark,
  :country,
  :postal_code,
  :phone_number,
  :is_restricted)
  include Aws::Structure
end