List Traffic Policy Instances By Policy
route53_list_traffic_policy_instances_by_policy | R Documentation |
Gets information about the traffic policy instances that you created by using a specify traffic policy version¶
Description¶
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a create_traffic_policy_instance
or an
update_traffic_policy_instance
request, there's a brief delay while
Amazon Route 53 creates the resource record sets that are specified in
the traffic policy definition. For more information, see the State
response element.
Route 53 returns a maximum of 100 items in each response. If you have a
lot of traffic policy instances, you can use the MaxItems
parameter to
list them in groups of up to 100.
Usage¶
route53_list_traffic_policy_instances_by_policy(TrafficPolicyId,
TrafficPolicyVersion, HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, TrafficPolicyInstanceTypeMarker,
MaxItems)
Arguments¶
TrafficPolicyId
[required] The ID of the traffic policy for which you want to list traffic policy instances.
TrafficPolicyVersion
[required] 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
.HostedZoneIdMarker
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherlist_traffic_policy_instances_by_policy
request.For the value of
hostedzoneid
, specify the value ofHostedZoneIdMarker
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 wasfalse
, there are no more traffic policy instances to get.TrafficPolicyInstanceNameMarker
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherlist_traffic_policy_instances_by_policy
request.For the value of
trafficpolicyinstancename
, specify the value ofTrafficPolicyInstanceNameMarker
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 wasfalse
, there are no more traffic policy instances to get.TrafficPolicyInstanceTypeMarker
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherlist_traffic_policy_instances_by_policy
request.For the value of
trafficpolicyinstancetype
, specify the value ofTrafficPolicyInstanceTypeMarker
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 wasfalse
, there are no more traffic policy instances to get.MaxItems
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 theIsTruncated
element in the response istrue
, and the values ofHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.
Value¶
A list with the following syntax:
list(
TrafficPolicyInstances = list(
list(
Id = "string",
HostedZoneId = "string",
Name = "string",
TTL = 123,
State = "string",
Message = "string",
TrafficPolicyId = "string",
TrafficPolicyVersion = 123,
TrafficPolicyType = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|"DS"
)
),
HostedZoneIdMarker = "string",
TrafficPolicyInstanceNameMarker = "string",
TrafficPolicyInstanceTypeMarker = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|"DS",
IsTruncated = TRUE|FALSE,
MaxItems = "string"
)
Request syntax¶
svc$list_traffic_policy_instances_by_policy(
TrafficPolicyId = "string",
TrafficPolicyVersion = 123,
HostedZoneIdMarker = "string",
TrafficPolicyInstanceNameMarker = "string",
TrafficPolicyInstanceTypeMarker = "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"NAPTR"|"PTR"|"SRV"|"SPF"|"AAAA"|"CAA"|"DS",
MaxItems = "string"
)