Skip to content

list_traffic_policies async

list_traffic_policies(
    *,
    config_overrides: Optional[AsyncRoute53ClientConfig] = None,
    traffic_policy_id_marker: Optional[TrafficPolicyId] = None,
    max_items: Optional[int] = None,
) -> ListTrafficPoliciesResponse

Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.

For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy.

Parameters:

  • traffic_policy_id_marker (Optional[TrafficPolicyId], default: None ) –

    (Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter.

    If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

  • max_items (Optional[int], default: None ) –

    (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

Raises:

Source code in docs_src/capo_route_53/_services/async_route53.py
async def list_traffic_policies(
    self,
    *,
    config_overrides: Optional[AsyncRoute53ClientConfig] = None,
    traffic_policy_id_marker: Optional[
        "capo_route_53.types.traffic_policy_id.TrafficPolicyId"
    ] = None,
    max_items: Optional[int] = None,
) -> (
    "capo_route_53.types.list_traffic_policies_response.ListTrafficPoliciesResponse"
):
    """<p>Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in. </p> <p>For information about how of deleting a traffic policy affects the response from <code>ListTrafficPolicies</code>, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html">DeleteTrafficPolicy</a>. </p>

    Args:
        traffic_policy_id_marker: <p>(Conditional) For your first request to <code>ListTrafficPolicies</code>, don't include the <code>TrafficPolicyIdMarker</code> parameter.</p> <p>If you have more traffic policies than the value of <code>MaxItems</code>, <code>ListTrafficPolicies</code> returns only the first <code>MaxItems</code> traffic policies. To get the next group of policies, submit another request to <code>ListTrafficPolicies</code>. For the value of <code>TrafficPolicyIdMarker</code>, specify the value of <code>TrafficPolicyIdMarker</code> that was returned in the previous response.</p>
        max_items: <p>(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than <code>MaxItems</code> traffic policies, the value of <code>IsTruncated</code> in the response is <code>true</code>, and the value of <code>TrafficPolicyIdMarker</code> is the ID of the first traffic policy that 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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route_53.types.list_traffic_policies_request.ListTrafficPoliciesRequest]",
    ) -> AsyncOperationResponse[
        "capo_route_53.types.list_traffic_policies_response.ListTrafficPoliciesResponse"
    ]:
        import capo_route_53._operations.aws_dns_v20130401.list_traffic_policies

        (
            output,
            http_response,
        ) = await capo_route_53._operations.aws_dns_v20130401.list_traffic_policies.async_list_traffic_policies(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTrafficPolicies")
    )
    input_: capo_route_53.types.list_traffic_policies_request.ListTrafficPoliciesRequest = {}
    if traffic_policy_id_marker is not None:
        input_["traffic_policy_id_marker"] = traffic_policy_id_marker
    if max_items is not None:
        input_["max_items"] = max_items

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output