ivschat / Client / list_logging_configurations

list_logging_configurations

ivschat.Client.list_logging_configurations(**kwargs)

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

See also: AWS API Documentation

Request Syntax

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

  • nextToken (string) – The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of logging configurations to return. Default: 50.

Return type:

dict

Returns:

Response Syntax

{
    'loggingConfigurations': [
        {
            'arn': 'string',
            'id': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'name': 'string',
            'destinationConfiguration': {
                's3': {
                    'bucketName': 'string'
                },
                'cloudWatchLogs': {
                    'logGroupName': 'string'
                },
                'firehose': {
                    'deliveryStreamName': 'string'
                }
            },
            'state': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'ACTIVE',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • loggingConfigurations (list) –

      List of the matching logging configurations (summary information only). There is only one type of destination ( cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

      • (dict) –

        Summary information about a logging configuration.

        • arn (string) –

          Logging-configuration ARN.

        • id (string) –

          Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

        • createTime (datetime) –

          Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.

        • updateTime (datetime) –

          Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

        • name (string) –

          Logging-configuration name. The value does not need to be unique.

        • destinationConfiguration (dict) –

          A complex type that contains a destination configuration for where chat content will be logged.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: s3, cloudWatchLogs, firehose. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • s3 (dict) –

            An Amazon S3 destination configuration where chat activity will be logged.

            • bucketName (string) –

              Name of the Amazon S3 bucket where chat activity will be logged.

          • cloudWatchLogs (dict) –

            An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

            • logGroupName (string) –

              Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

          • firehose (dict) –

            An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

            • deliveryStreamName (string) –

              Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

        • state (string) –

          The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging chat content.

        • tags (dict) –

          Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS Chat has no constraints on tags beyond what is documented there.

          • (string) –

            • (string) –

    • nextToken (string) –

      If there are more logging configurations than maxResults, use nextToken in the request to get the next set.

Exceptions