update_app_instance_user_endpoint ¶

def update_app_instance_user_endpoint(
    self,
    app_instance_user_arn: "capo_chime_sdk_identity.types.chime_arn.ChimeArn",
    endpoint_id: "capo_chime_sdk_identity.types.string64.String64",
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
    name: Optional[
        "capo_chime_sdk_identity.types.sensitive_string1600.SensitiveString1600"
    ] = None,
    allow_messages: Optional[
        "capo_chime_sdk_identity.types.allow_messages.AllowMessages"
    ] = None,
) -> "capo_chime_sdk_identity.types.update_app_instance_user_endpoint_response.UpdateAppInstanceUserEndpointResponse":
    """<p>Updates the details of an <code>AppInstanceUserEndpoint</code>. You can update the name and <code>AllowMessage</code> values.</p>

    Args:
        app_instance_user_arn: <p>The ARN of the <code>AppInstanceUser</code>.</p>
        endpoint_id: <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
        name: <p>The name of the <code>AppInstanceUserEndpoint</code>.</p>
        allow_messages: <p>Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_identity.types.update_app_instance_user_endpoint_request.UpdateAppInstanceUserEndpointRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_identity.types.update_app_instance_user_endpoint_response.UpdateAppInstanceUserEndpointResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.update_app_instance_user_endpoint

        output, http_response = (
            capo_chime_sdk_identity._operations.chime_identity_service.update_app_instance_user_endpoint.update_app_instance_user_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_identity.types.update_app_instance_user_endpoint_request.UpdateAppInstanceUserEndpointRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_identity.types.update_app_instance_user_endpoint_request

        return capo_chime_sdk_identity.types.update_app_instance_user_endpoint_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAppInstanceUserEndpoint", redact_input=_redact_input
        ),
    )
    input_: capo_chime_sdk_identity.types.update_app_instance_user_endpoint_request.UpdateAppInstanceUserEndpointRequest = {
        "app_instance_user_arn": app_instance_user_arn,
        "endpoint_id": endpoint_id,
    }
    if name is not None:
        input_["name"] = name
    if allow_messages is not None:
        input_["allow_messages"] = allow_messages

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