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

Inherits:
Struct
  • Object
show all
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",
}

Location data for the endpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#cityString

The city where the endpoint is located.

Returns:

  • (String)


3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/aws-sdk-pinpoint/types.rb', line 3782

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

#countryString

The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as “US” for the United States.

Returns:

  • (String)


3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/aws-sdk-pinpoint/types.rb', line 3782

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 place.

Returns:

  • (Float)


3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/aws-sdk-pinpoint/types.rb', line 3782

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 place.

Returns:

  • (Float)


3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/aws-sdk-pinpoint/types.rb', line 3782

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)


3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/aws-sdk-pinpoint/types.rb', line 3782

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

#regionString

The region of the endpoint location. For example, in the United States, this corresponds to a state.

Returns:

  • (String)


3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/aws-sdk-pinpoint/types.rb', line 3782

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