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

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

Overview

The address that you want the Snow device(s) 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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

The unique ID for an address.

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#city ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#company ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#country ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#is_restricted ⇒ Boolean

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) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#landmark ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of a person to receive a Snow device at an address.

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#postal_code ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#prefecture_or_district ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#state_or_province ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#street_1 ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#street_2 ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#street_3 ⇒ String

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

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

Returns:

  • (String) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/aws-sdk-snowball/types.rb', line 90

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,
  :type)
  SENSITIVE = []
  include Aws::Structure
end