WorkSpacesWeb / Client / list_session_loggers

list_session_loggers

WorkSpacesWeb.Client.list_session_loggers(**kwargs)

Lists all available session logger resources.

See also: AWS API Documentation

Request Syntax

response = client.list_session_loggers(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The pagination token used to retrieve the next page of results for this operation.

  • maxResults (integer) – The maximum number of results to be included in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'sessionLoggers': [
        {
            'sessionLoggerArn': 'string',
            'logConfiguration': {
                's3': {
                    'bucket': 'string',
                    'keyPrefix': 'string',
                    'bucketOwner': 'string',
                    'logFileFormat': 'JSONLines'|'Json',
                    'folderStructure': 'Flat'|'NestedByDate'
                }
            },
            'displayName': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • sessionLoggers (list) –

      The list of session loggers, including summaries of their details.

      • (dict) –

        The summary of the session logger resource.

        • sessionLoggerArn (string) –

          The ARN of the session logger resource.

        • logConfiguration (dict) –

          The configuration that specifies where the logs are fowarded.

          • s3 (dict) –

            The configuration for delivering the logs to S3.

            • bucket (string) –

              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) –

              The format of the LogFile that is written to S3.

            • folderStructure (string) –

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

        • displayName (string) –

          The human-readable display name.

        • creationDate (datetime) –

          The date the session logger resource was created.

    • nextToken (string) –

      The pagination token used to retrieve the next page of results for this operation.

Exceptions