You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Route53::Types::ListTrafficPolicyInstancesByPolicyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Route53::Types::ListTrafficPolicyInstancesByPolicyRequest
- Defined in:
- (unknown)
Overview
When passing ListTrafficPolicyInstancesByPolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
traffic_policy_id: "TrafficPolicyId", # required
traffic_policy_version: 1, # required
hosted_zone_id_marker: "ResourceId",
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 complex type that contains the information about the request to list your traffic policy instances.
Instance Attribute Summary collapse
-
#hosted_zone_id_marker ⇒ String
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. -
#max_items ⇒ Integer
The maximum number of traffic policy instances to be included in the response body for this request.
-
#traffic_policy_id ⇒ String
The ID of the traffic policy for which you want to list traffic policy instances.
-
#traffic_policy_instance_name_marker ⇒ String
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. -
#traffic_policy_instance_type_marker ⇒ String
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. -
#traffic_policy_version ⇒ Integer
The version of the traffic policy for which you want to list traffic policy instances.
Instance Attribute Details
#hosted_zone_id_marker ⇒ String
If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of hostedzoneid
, specify the value of
HostedZoneIdMarker
from the previous response, which is the hosted
zone ID of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
#max_items ⇒ Integer
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.
#traffic_policy_id ⇒ String
The ID of the traffic policy for which you want to list traffic policy instances.
#traffic_policy_instance_name_marker ⇒ String
If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
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 that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
#traffic_policy_instance_type_marker ⇒ String
If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of trafficpolicyinstancetype
, specify the value of
TrafficPolicyInstanceTypeMarker
from the previous response, which is
the name of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
Possible values:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
#traffic_policy_version ⇒ Integer
The version of the traffic policy for which you want to list traffic
policy instances. The version must be associated with the traffic policy
that is specified by TrafficPolicyId
.