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

Class: Aws::Route53::Types::ListTrafficPolicyInstancesByHostedZoneRequest

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 ListTrafficPolicyInstancesByHostedZoneRequest data as a hash:

{
  hosted_zone_id: "ResourceId", # required
  traffic_policy_instance_name_marker: "DNSName",
  traffic_policy_instance_type_marker: "SOA", # accepts SOA, A, TXT, NS, CNAME, MX, NAPTR, PTR, SRV, SPF, AAAA, CAA
  max_items: 1,
}

A request for the traffic policy instances that you created in a specified hosted zone.

Instance Attribute Summary collapse

Instance Attribute Details

#hosted_zone_idString

The ID of the hosted zone that you want to list traffic policy instances for.

Returns:

  • (String)


3714
3715
3716
3717
3718
3719
3720
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3714

class ListTrafficPolicyInstancesByHostedZoneRequest < Struct.new(
  :hosted_zone_id,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

Returns:

  • (Integer)


3714
3715
3716
3717
3718
3719
3720
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3714

class ListTrafficPolicyInstancesByHostedZoneRequest < Struct.new(
  :hosted_zone_id,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  include Aws::Structure
end

#traffic_policy_instance_name_markerString

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Returns:

  • (String)


3714
3715
3716
3717
3718
3719
3720
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3714

class ListTrafficPolicyInstancesByHostedZoneRequest < Struct.new(
  :hosted_zone_id,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  include Aws::Structure
end

#traffic_policy_instance_type_markerString

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Returns:

  • (String)


3714
3715
3716
3717
3718
3719
3720
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 3714

class ListTrafficPolicyInstancesByHostedZoneRequest < Struct.new(
  :hosted_zone_id,
  :traffic_policy_instance_name_marker,
  :traffic_policy_instance_type_marker,
  :max_items)
  include Aws::Structure
end