list_traffic_policies `async` ¶

list_traffic_policies(
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    page_size: Optional[PageSize] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListTrafficPoliciesResponse

List traffic policy resources.

Parameters:

page_size (Optional[PageSize], default: None ) –

The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
next_token (Optional[PaginationToken], default: None ) –

If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Raises:

ValidationException –

The request validation has failed. For details, see the accompanying error message.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

List TrafficPolicies

>>> await client.list_traffic_policies()
List TrafficPolicies with PageSize

>>> await client.list_traffic_policies(page_size=10)
List TrafficPolicies with NextToken

>>> await client.list_traffic_policies(next_token='nextToken')

Source code in docs_src/capo_mailmanager/_services/async_mail_manager.py

async def list_traffic_policies(
    self,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    page_size: Optional["capo_mailmanager.types.page_size.PageSize"] = None,
    next_token: Optional[
        "capo_mailmanager.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_mailmanager.types.list_traffic_policies_response.ListTrafficPoliciesResponse":
    """<p>List traffic policy resources.</p>

    Args:
        page_size: <p>The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.</p>
        next_token: <p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p>

    Raises:
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List TrafficPolicies

        >>> await client.list_traffic_policies()
        List TrafficPolicies with PageSize

        >>> await client.list_traffic_policies(page_size=10)
        List TrafficPolicies with NextToken

        >>> await client.list_traffic_policies(next_token='nextToken')
    """

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

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.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_mailmanager.types.list_traffic_policies_request.ListTrafficPoliciesRequest = {}
    if page_size is not None:
        input_["page_size"] = page_size
    if next_token is not None:
        input_["next_token"] = next_token

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

list_traffic_policies async ¶

list_traffic_policies `async` ¶