WorkSpacesWeb / Paginator / ListSessionLoggers

ListSessionLoggers¶

class WorkSpacesWeb.Paginator.ListSessionLoggers¶

paginator = client.get_paginator('list_session_loggers')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WorkSpacesWeb.Client.list_session_loggers().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

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) –
  
  A token to resume pagination.