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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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",
}

Endpoint location data

Instance Attribute Summary collapse

Instance Attribute Details

#cityString

The city where the endpoint is located.

Returns:

  • (String)


1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1894

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

#countryString

Country according to ISO 3166-1 Alpha-2 codes. For example, US.

Returns:

  • (String)


1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1894

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

#latitudeFloat

The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).

Returns:

  • (Float)


1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1894

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

#longitudeFloat

The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).

Returns:

  • (Float)


1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1894

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

#postal_codeString

The postal code or zip code of the endpoint.

Returns:

  • (String)


1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1894

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

#regionString

The region of the endpoint location. For example, corresponds to a state in US.

Returns:

  • (String)


1894
1895
1896
1897
1898
1899
1900
1901
1902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1894

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