list_traffic_policy_instances_by_policy ¶

def list_traffic_policy_instances_by_policy(
    self,
    traffic_policy_id: "capo_route_53.types.traffic_policy_id.TrafficPolicyId",
    traffic_policy_version: "capo_route_53.types.traffic_policy_version.TrafficPolicyVersion",
    *,
    config_overrides: Optional[Route53ClientConfig] = None,
    hosted_zone_id_marker: Optional[
        "capo_route_53.types.resource_id.ResourceId"
    ] = None,
    traffic_policy_instance_name_marker: Optional[
        "capo_route_53.types.dns_name.DNSName"
    ] = None,
    traffic_policy_instance_type_marker: Optional[
        "capo_route_53.types.rr_type.RRType"
    ] = None,
    max_items: Optional[int] = None,
) -> "capo_route_53.types.list_traffic_policy_instances_by_policy_response.ListTrafficPolicyInstancesByPolicyResponse":
    """<p>Gets information about the traffic policy instances that you created by using a specify traffic policy version.</p> <note> <p>After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code> 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 <code>State</code> response element.</p> </note> <p>Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the <code>MaxItems</code> parameter to list them in groups of up to 100.</p>

    Args:
        traffic_policy_id: <p>The ID of the traffic policy for which you want to list traffic policy instances.</p>
        traffic_policy_version: <p>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 <code>TrafficPolicyId</code>.</p>
        hosted_zone_id_marker: <p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. </p> <p>For the value of <code>hostedzoneid</code>, specify the value of <code>HostedZoneIdMarker</code> 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.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get.</p>
        traffic_policy_instance_name_marker: <p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request.</p> <p>For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> 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.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get.</p>
        traffic_policy_instance_type_marker: <p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request.</p> <p>For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> 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.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get.</p>
        max_items: <p>The maximum number of traffic policy instances to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.</p>

    Raises:
        capo_route_53.errors.invalid_input.InvalidInput: <p>The input is not valid.</p>
        capo_route_53.errors.no_such_traffic_policy.NoSuchTrafficPolicy: <p>No traffic policy exists with the specified ID.</p>
        capo_route_53.errors.no_such_traffic_policy_instance.NoSuchTrafficPolicyInstance: <p>No traffic policy instance exists with the specified ID.</p>
        capo_route_53.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route_53.types.list_traffic_policy_instances_by_policy_request.ListTrafficPolicyInstancesByPolicyRequest]",
    ) -> OperationResponse[
        "capo_route_53.types.list_traffic_policy_instances_by_policy_response.ListTrafficPolicyInstancesByPolicyResponse"
    ]:
        import capo_route_53._operations.aws_dns_v20130401.list_traffic_policy_instances_by_policy

        output, http_response = (
            capo_route_53._operations.aws_dns_v20130401.list_traffic_policy_instances_by_policy.list_traffic_policy_instances_by_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTrafficPolicyInstancesByPolicy")
    )
    input_: capo_route_53.types.list_traffic_policy_instances_by_policy_request.ListTrafficPolicyInstancesByPolicyRequest = {
        "traffic_policy_id": traffic_policy_id,
        "traffic_policy_version": traffic_policy_version,
    }
    if hosted_zone_id_marker is not None:
        input_["hosted_zone_id_marker"] = hosted_zone_id_marker
    if traffic_policy_instance_name_marker is not None:
        input_["traffic_policy_instance_name_marker"] = (
            traffic_policy_instance_name_marker
        )
    if traffic_policy_instance_type_marker is not None:
        input_["traffic_policy_instance_type_marker"] = (
            traffic_policy_instance_type_marker
        )
    if max_items is not None:
        input_["max_items"] = max_items

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output