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

Class: Aws::Route53::Types::ListGeoLocationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb

Overview

Note:

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

{
  start_continent_code: "GeoLocationContinentCode",
  start_country_code: "GeoLocationCountryCode",
  start_subdivision_code: "GeoLocationSubdivisionCode",
  max_items: 1,
}

A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.

Instance Attribute Summary collapse

Instance Attribute Details

#max_itemsInteger

(Optional) The maximum number of geolocations to be included in the response body for this request. If more than MaxItems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.

Returns:

  • (Integer)


2716
2717
2718
2719
2720
2721
2722
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 2716

class ListGeoLocationsRequest < Struct.new(
  :start_continent_code,
  :start_country_code,
  :start_subdivision_code,
  :max_items)
  include Aws::Structure
end

#start_continent_codeString

The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in StartContinentCode to return the next page of results.

Include StartContinentCode only if you want to list continents. Don't include StartContinentCode when you're listing countries or countries with their subdivisions.

Returns:

  • (String)


2716
2717
2718
2719
2720
2721
2722
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 2716

class ListGeoLocationsRequest < Struct.new(
  :start_continent_code,
  :start_country_code,
  :start_subdivision_code,
  :max_items)
  include Aws::Structure
end

#start_country_codeString

The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in StartCountryCode to return the next page of results.

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

Returns:

  • (String)


2716
2717
2718
2719
2720
2721
2722
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 2716

class ListGeoLocationsRequest < Struct.new(
  :start_continent_code,
  :start_country_code,
  :start_subdivision_code,
  :max_items)
  include Aws::Structure
end

#start_subdivision_codeString

The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in StartSubdivisionCode to return the next page of results.

To list subdivisions of a country, you must include both StartCountryCode and StartSubdivisionCode.

Returns:

  • (String)


2716
2717
2718
2719
2720
2721
2722
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 2716

class ListGeoLocationsRequest < Struct.new(
  :start_continent_code,
  :start_country_code,
  :start_subdivision_code,
  :max_items)
  include Aws::Structure
end