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

Class: Aws::Pinpoint::Types::EndpointLocation

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

Overview

Note:

When passing EndpointLocation as input to an Aws::Client method, you can use a vanilla Hash:

{
  city: "__string",
  country: "__string",
  latitude: 1.0,
  longitude: 1.0,
  postal_code: "__string",
  region: "__string",
}

Specifies geographic information about an endpoint.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#city ⇒ String

The name of the city where the endpoint is located.

Returns:

  • (String) —

    The name of the city where the endpoint is located.

#country ⇒ String

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

Returns:

  • (String) —

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located.

#latitude ⇒ Float

The latitude coordinate of the endpoint location, rounded to one decimal place.

Returns:

  • (Float) —

    The latitude coordinate of the endpoint location, rounded to one decimal place.

#longitude ⇒ Float

The longitude coordinate of the endpoint location, rounded to one decimal place.

Returns:

  • (Float) —

    The longitude coordinate of the endpoint location, rounded to one decimal place.

#postal_code ⇒ String

The postal or ZIP code for the area where the endpoint is located.

Returns:

  • (String) —

    The postal or ZIP code for the area where the endpoint is located.

#region ⇒ String

The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

Returns:

  • (String) —

    The name of the region where the endpoint is located.