update_ingress_point ¶

def update_ingress_point(
    self,
    ingress_point_id: "capo_mailmanager.types.ingress_point_id.IngressPointId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    ingress_point_name: Optional[
        "capo_mailmanager.types.ingress_point_name.IngressPointName"
    ] = None,
    status_to_update: Optional[
        "capo_mailmanager.types.ingress_point_status_to_update.IngressPointStatusToUpdate"
    ] = None,
    rule_set_id: Optional["capo_mailmanager.types.rule_set_id.RuleSetId"] = None,
    traffic_policy_id: Optional[
        "capo_mailmanager.types.traffic_policy_id.TrafficPolicyId"
    ] = None,
    ingress_point_configuration: Optional[
        "capo_mailmanager.types.ingress_point_configuration.IngressPointConfiguration"
    ] = None,
    tls_policy: Optional["capo_mailmanager.types.tls_policy.TlsPolicy"] = None,
) -> "capo_mailmanager.types.update_ingress_point_response.UpdateIngressPointResponse":
    """<p>Update attributes of a provisioned ingress endpoint resource.</p>

    Args:
        ingress_point_id: <p>The identifier for the ingress endpoint you want to update.</p>
        ingress_point_name: <p>A user friendly name for the ingress endpoint resource.</p>
        status_to_update: <p>The update status of an ingress endpoint.</p>
        rule_set_id: <p>The identifier of an existing rule set that you attach to an ingress endpoint resource.</p>
        traffic_policy_id: <p>The identifier of an existing traffic policy that you attach to an ingress endpoint resource.</p>
        ingress_point_configuration: <p>If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.</p>
        tls_policy: <p>The Transport Layer Security (TLS) policy for the ingress point. Valid values are REQUIRED, OPTIONAL. Only ingress endpoints using REQUIRED or OPTIONAL as TlsPolicy can be updated.</p>

    Raises:
        capo_mailmanager.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        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:
        Update Open/Auth IngressPoint with new Name

        >>> client.update_ingress_point(ingress_point_id='inp-12345', ingress_point_name='ingressPointNewName')
        Update Open/Auth IngressPoint with new RuleSetId / TrafficPolicyId

        >>> client.update_ingress_point(ingress_point_id='inp-12345', rule_set_id='rs-12345', traffic_policy_id='tp-12345')
        Update Auth IngressPoint with new SmtpPassword

        >>> client.update_ingress_point(ingress_point_id='inp-12345', ingress_point_configuration={'SmtpPassword': 'newSmtpPassword'})
        Update Auth IngressPoint with new SecretArn

        >>> client.update_ingress_point(ingress_point_id='inp-12345', ingress_point_configuration={'SecretArn': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde'})
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.update_ingress_point_request.UpdateIngressPointRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.update_ingress_point_response.UpdateIngressPointResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.update_ingress_point

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

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

        return capo_mailmanager.types.update_ingress_point_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateIngressPoint", redact_input=_redact_input),
    )
    input_: capo_mailmanager.types.update_ingress_point_request.UpdateIngressPointRequest = {
        "ingress_point_id": ingress_point_id
    }
    if ingress_point_name is not None:
        input_["ingress_point_name"] = ingress_point_name
    if status_to_update is not None:
        input_["status_to_update"] = status_to_update
    if rule_set_id is not None:
        input_["rule_set_id"] = rule_set_id
    if traffic_policy_id is not None:
        input_["traffic_policy_id"] = traffic_policy_id
    if ingress_point_configuration is not None:
        input_["ingress_point_configuration"] = ingress_point_configuration
    if tls_policy is not None:
        input_["tls_policy"] = tls_policy

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