WorkSpacesWeb / Client / create_session_logger

create_session_logger

WorkSpacesWeb.Client.create_session_logger(**kwargs)

Creates a session logger.

See also: AWS API Documentation

Request Syntax

response = client.create_session_logger(
    eventFilter={
        'all': {}
        ,
        'include': [
            'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd',
        ]
    },
    logConfiguration={
        's3': {
            'bucket': 'string',
            'keyPrefix': 'string',
            'bucketOwner': 'string',
            'logFileFormat': 'JSONLines'|'Json',
            'folderStructure': 'Flat'|'NestedByDate'
        }
    },
    displayName='string',
    customerManagedKey='string',
    additionalEncryptionContext={
        'string': 'string'
    },
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    clientToken='string'
)
Parameters:

  • eventFilter (dict) –

    [REQUIRED]

    The filter that specifies the events to monitor.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: all, include.

    • all (dict) –

      The filter that monitors all of the available events, including any new events emitted in the future.

    • include (list) –

      The filter that monitors only the listed set of events. New events are not auto-monitored.

      • (string) –

  • logConfiguration (dict) –

    [REQUIRED]

    The configuration that specifies where logs are delivered.

    • s3 (dict) –

      The configuration for delivering the logs to S3.

      • bucket (string) – [REQUIRED]

        The S3 bucket name where logs are delivered.

      • keyPrefix (string) –

        The S3 path prefix that determines where log files are stored.

      • bucketOwner (string) –

        The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

      • logFileFormat (string) – [REQUIRED]

        The format of the LogFile that is written to S3.

      • folderStructure (string) – [REQUIRED]

        The folder structure that defines the organizational structure for log files in S3.

  • displayName (string) – The human-readable display name for the session logger resource.

  • customerManagedKey (string) – The custom managed key of the session logger.

  • additionalEncryptionContext (dict) –

    The additional encryption context of the session logger.

    • (string) –

      • (string) –

  • tags (list) –

    The tags to add to the session logger.

    • (dict) –

      The tag.

      • Key (string) – [REQUIRED]

        The key of the tag.

      • Value (string) – [REQUIRED]

        The value of the tag

  • clientToken (string) –

    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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'sessionLoggerArn': 'string'
}

Response Structure

  • (dict) –

    • sessionLoggerArn (string) –

      The ARN of the session logger.

Exceptions