create_session_logger async ¶

async def create_session_logger(
    self,
    event_filter: "capo_workspaces_web.types.event_filter.EventFilter",
    log_configuration: "capo_workspaces_web.types.log_configuration.LogConfiguration",
    *,
    config_overrides: Optional[AsyncWorkSpacesWebClientConfig] = None,
    display_name: Optional[
        "capo_workspaces_web.types.display_name_safe.DisplayNameSafe"
    ] = None,
    customer_managed_key: Optional[
        "capo_workspaces_web.types.key_arn.keyArn"
    ] = None,
    additional_encryption_context: Optional[
        "capo_workspaces_web.types.encryption_context_map.EncryptionContextMap"
    ] = None,
    tags: Optional["capo_workspaces_web.types.tag_list.TagList"] = None,
    client_token: Optional[
        "capo_workspaces_web.types.client_token.ClientToken"
    ] = None,
) -> "capo_workspaces_web.types.create_session_logger_response.CreateSessionLoggerResponse":
    """<p>Creates a session logger.</p>

    Args:
        event_filter: <p>The filter that specifies the events to monitor.</p>
        log_configuration: <p>The configuration that specifies where logs are delivered.</p>
        display_name: <p>The human-readable display name for the session logger resource.</p>
        customer_managed_key: <p>The custom managed key of the session logger.</p>
        additional_encryption_context: <p>The additional encryption context of the session logger.</p>
        tags: <p>The tags to add to the session logger.</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 returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK.</p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.conflict_exception.ConflictException: <p>There is a conflict.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota has been exceeded.</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.

    Examples:
        Create Session Logger with All Events
        Creates a session logger that captures all events and stores them in S3 with JSON format and flat folder structure

        >>> await client.create_session_logger(event_filter={'all': {}}, log_configuration={'s3': {'bucket': 'my-session-logs-bucket', 'keyPrefix': 'session-logs/all/events', 'bucketOwner': '123456789012', 'logFileFormat': 'Json', 'folderStructure': 'Flat'}}, display_name='Session Logger with All Events')
        Create Session Logger with Specific Events
        Creates a session logger that captures only specific events with JSONLines format and nested folder structure

        >>> await client.create_session_logger(event_filter={'include': ['SessionStart', 'SessionEnd', 'UrlLoad', 'WebsiteInteract']}, log_configuration={'s3': {'bucket': 'my-session-logs-bucket', 'keyPrefix': 'session-logs/each/event', 'bucketOwner': '123456789012', 'logFileFormat': 'JSONLines', 'folderStructure': 'NestedByDate'}}, display_name='Session Logger with Each Events', customer_managed_key='arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012', additional_encryption_context={'EncryptionContextKey': 'EncryptionContextValue'}, tags=[{'Key': 'KEY-1', 'Value': 'VALUE-1'}, {'Key': 'KEY-2', 'Value': 'VALUE-2'}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces_web.types.create_session_logger_request.CreateSessionLoggerRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces_web.types.create_session_logger_response.CreateSessionLoggerResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.create_session_logger

        (
            output,
            http_response,
        ) = await capo_workspaces_web._operations.aws_ermine_control_plane_service.create_session_logger.async_create_session_logger(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workspaces_web.types.create_session_logger_request.CreateSessionLoggerRequest",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.create_session_logger_request

        return capo_workspaces_web.types.create_session_logger_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateSessionLogger", redact_input=_redact_input),
    )
    input_: capo_workspaces_web.types.create_session_logger_request.CreateSessionLoggerRequest = {
        "event_filter": event_filter,
        "log_configuration": log_configuration,
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if customer_managed_key is not None:
        input_["customer_managed_key"] = customer_managed_key
    if additional_encryption_context is not None:
        input_["additional_encryption_context"] = additional_encryption_context
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output