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",
}

Specifies geographic information about an endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cityString

The name of the city where the endpoint is located.

Returns:

  • (String)


6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6822

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

#countryString

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)


6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6822

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

#latitudeFloat

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

Returns:

  • (Float)


6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6822

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

#longitudeFloat

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

Returns:

  • (Float)


6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6822

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

#postal_codeString

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

Returns:

  • (String)


6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6822

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

#regionString

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)


6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6822

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