list_members_of_address_list async ¶

async def list_members_of_address_list(
    self,
    address_list_id: "capo_mailmanager.types.address_list_id.AddressListId",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    filter: Optional["capo_mailmanager.types.address_filter.AddressFilter"] = None,
    next_token: Optional[
        "capo_mailmanager.types.pagination_token.PaginationToken"
    ] = None,
    page_size: Optional[
        "capo_mailmanager.types.address_page_size.AddressPageSize"
    ] = None,
) -> "capo_mailmanager.types.list_members_of_address_list_response.ListMembersOfAddressListResponse":
    """<p>Lists members of an address list.</p>

    Args:
        address_list_id: <p>The unique identifier of the address list to list the addresses from.</p>
        filter: <p>Filter to be used to limit the results.</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>
        page_size: <p>The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.</p>

    Raises:
        capo_mailmanager.errors.access_denied_exception.AccessDeniedException: <p>Occurs when a user is denied access to a specific resource or action.</p>
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</p>
        capo_mailmanager.errors.throttling_exception.ThrottlingException: <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mailmanager.types.list_members_of_address_list_request.ListMembersOfAddressListRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.list_members_of_address_list_response.ListMembersOfAddressListResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.list_members_of_address_list

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.list_members_of_address_list.async_list_members_of_address_list(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mailmanager.types.list_members_of_address_list_request.ListMembersOfAddressListRequest",
    ) -> dict[str, Any]:
        import capo_mailmanager.types.list_members_of_address_list_request

        return capo_mailmanager.types.list_members_of_address_list_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_mailmanager.types.list_members_of_address_list_response.ListMembersOfAddressListResponse",
    ) -> dict[str, Any]:
        import capo_mailmanager.types.list_members_of_address_list_response

        return capo_mailmanager.types.list_members_of_address_list_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListMembersOfAddressList",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_mailmanager.types.list_members_of_address_list_request.ListMembersOfAddressListRequest = {
        "address_list_id": address_list_id
    }
    if filter is not None:
        input_["filter"] = filter
    if next_token is not None:
        input_["next_token"] = next_token
    if page_size is not None:
        input_["page_size"] = page_size

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