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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EndpointLocation

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

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

Specifies geographic information about an endpoint.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #city ⇒ 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.

• #latitude ⇒ 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.

• #postal_code ⇒ 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.

Instance Attribute Details

#city ⇒ String

The name of the city where the endpoint is located.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 6372

class EndpointLocation < Struct.new(
  :city,
  :country,
  :latitude,
  :longitude,
  :postal_code,
  :region)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-pinpoint/types.rb', line 6372

class EndpointLocation < Struct.new(
  :city,
  :country,
  :latitude,
  :longitude,
  :postal_code,
  :region)
  include Aws::Structure
end

#latitude ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-pinpoint/types.rb', line 6372

class EndpointLocation < Struct.new(
  :city,
  :country,
  :latitude,
  :longitude,
  :postal_code,
  :region)
  include Aws::Structure
end

#longitude ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-pinpoint/types.rb', line 6372

class EndpointLocation < Struct.new(
  :city,
  :country,
  :latitude,
  :longitude,
  :postal_code,
  :region)
  include Aws::Structure
end

#postal_code ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 6372

class EndpointLocation < Struct.new(
  :city,
  :country,
  :latitude,
  :longitude,
  :postal_code,
  :region)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-pinpoint/types.rb', line 6372

class EndpointLocation < Struct.new(
  :city,
  :country,
  :latitude,
  :longitude,
  :postal_code,
  :region)
  include Aws::Structure
end