Skip to content

list_ingress_points

list_ingress_points(
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    page_size: Optional[PageSize] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListIngressPointsResponse

List all ingress endpoint resources.

Parameters:

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

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

  • 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 IngressPoints

>>> client.list_ingress_points()
List IngressPoints with PageSize
>>> client.list_ingress_points(page_size=10)
List IngressPoints with NextToken
>>> client.list_ingress_points(next_token='nextToken')
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def list_ingress_points(
    self,
    *,
    config_overrides: Optional[MailManagerClientConfig] = 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_ingress_points_response.ListIngressPointsResponse"
):
    """<p>List all ingress endpoint resources.</p>

    Args:
        page_size: <p>The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.</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 IngressPoints

        >>> client.list_ingress_points()
        List IngressPoints with PageSize

        >>> client.list_ingress_points(page_size=10)
        List IngressPoints with NextToken

        >>> client.list_ingress_points(next_token='nextToken')
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.list_ingress_points_request.ListIngressPointsRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.list_ingress_points_response.ListIngressPointsResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.list_ingress_points

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.list_ingress_points.list_ingress_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListIngressPoints")
    )
    input_: capo_mailmanager.types.list_ingress_points_request.ListIngressPointsRequest = {}
    if page_size is not None:
        input_["page_size"] = page_size
    if next_token is not None:
        input_["next_token"] = next_token

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