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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Address as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The unique ID for an address.

Returns:

  • (String)

    The unique ID for an address.

#cityString

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

Returns:

  • (String)

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

#companyString

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

Returns:

  • (String)

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

#countryString

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

Returns:

  • (String)

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

#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)

    If the address you are creating is a primary address, then set this option to true.

#landmarkString

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

Returns:

  • (String)

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

#nameString

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

Returns:

  • (String)

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

#phone_numberString

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

Returns:

  • (String)

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

#postal_codeString

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

Returns:

  • (String)

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

#prefecture_or_districtString

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

Returns:

  • (String)

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

#state_or_provinceString

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

Returns:

  • (String)

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

#street_1String

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

Returns:

  • (String)

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

#street_2String

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

Returns:

  • (String)

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

#street_3String

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

Returns:

  • (String)

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