Skip to content

get_ingress_point

get_ingress_point(
    ingress_point_id: IngressPointId,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    include_trust_store_contents: Optional[TrustStoreResponseOption] = None,
) -> GetIngressPointResponse

Fetch ingress endpoint resource attributes.

Parameters:

  • ingress_point_id (IngressPointId) –

    The identifier of an ingress endpoint.

  • include_trust_store_contents (Optional[TrustStoreResponseOption], default: None ) –

    Whether to include the trust store contents in the response. Use INCLUDE to retrieve trust store certificate and CRL contents.

Raises:

Examples:

Get Open IngressPoint

>>> client.get_ingress_point(ingress_point_id='inp-12345')
Get Auth IngressPoint
>>> client.get_ingress_point(ingress_point_id='inp-12345')
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def get_ingress_point(
    self,
    ingress_point_id: "capo_mailmanager.types.ingress_point_id.IngressPointId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    include_trust_store_contents: Optional[
        "capo_mailmanager.types.trust_store_response_option.TrustStoreResponseOption"
    ] = None,
) -> "capo_mailmanager.types.get_ingress_point_response.GetIngressPointResponse":
    """<p>Fetch ingress endpoint resource attributes.</p>

    Args:
        ingress_point_id: <p>The identifier of an ingress endpoint.</p>
        include_trust_store_contents: <p>Whether to include the trust store contents in the response. Use INCLUDE to retrieve trust store certificate and CRL contents.</p>

    Raises:
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</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.

    Examples:
        Get Open IngressPoint

        >>> client.get_ingress_point(ingress_point_id='inp-12345')
        Get Auth IngressPoint

        >>> client.get_ingress_point(ingress_point_id='inp-12345')
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.get_ingress_point_request.GetIngressPointRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.get_ingress_point_response.GetIngressPointResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.get_ingress_point

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

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

        return capo_mailmanager.types.get_ingress_point_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetIngressPoint", redact_output=_redact_output),
    )
    input_: capo_mailmanager.types.get_ingress_point_request.GetIngressPointRequest = {
        "ingress_point_id": ingress_point_id
    }
    if include_trust_store_contents is not None:
        input_["include_trust_store_contents"] = include_trust_store_contents

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