Skip to content

update_user_access_logging_settings

update_user_access_logging_settings(
    user_access_logging_settings_arn: ARN,
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
    kinesis_stream_arn: Optional[KinesisStreamArn] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateUserAccessLoggingSettingsResponse

Updates the user access logging settings.

Parameters:

  • user_access_logging_settings_arn (ARN) –

    The ARN of the user access logging settings.

  • kinesis_stream_arn (Optional[KinesisStreamArn], default: None ) –

    The ARN of the Kinesis stream.

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Raises:

Source code in docs_src/capo_workspaces_web/_services/work_spaces_web.py
def update_user_access_logging_settings(
    self,
    user_access_logging_settings_arn: "capo_workspaces_web.types.arn.ARN",
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
    kinesis_stream_arn: Optional[
        "capo_workspaces_web.types.kinesis_stream_arn.KinesisStreamArn"
    ] = None,
    client_token: Optional[
        "capo_workspaces_web.types.client_token.ClientToken"
    ] = None,
) -> "capo_workspaces_web.types.update_user_access_logging_settings_response.UpdateUserAccessLoggingSettingsResponse":
    """<p>Updates the user access logging settings.</p>

    Args:
        user_access_logging_settings_arn: <p>The ARN of the user access logging settings.</p>
        kinesis_stream_arn: <p>The ARN of the Kinesis stream.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource cannot be found.</p>
        capo_workspaces_web.errors.throttling_exception.ThrottlingException: <p>There is a throttling error.</p>
        capo_workspaces_web.errors.validation_exception.ValidationException: <p>There is a validation error.</p>
        capo_workspaces_web.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_web.types.update_user_access_logging_settings_request.UpdateUserAccessLoggingSettingsRequest]",
    ) -> OperationResponse[
        "capo_workspaces_web.types.update_user_access_logging_settings_response.UpdateUserAccessLoggingSettingsResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.update_user_access_logging_settings

        output, http_response = (
            capo_workspaces_web._operations.aws_ermine_control_plane_service.update_user_access_logging_settings.update_user_access_logging_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateUserAccessLoggingSettings")
    )
    input_: capo_workspaces_web.types.update_user_access_logging_settings_request.UpdateUserAccessLoggingSettingsRequest = {
        "user_access_logging_settings_arn": user_access_logging_settings_arn
    }
    if kinesis_stream_arn is not None:
        input_["kinesis_stream_arn"] = kinesis_stream_arn
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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