ivschat / Client / create_logging_configuration

create_logging_configuration#

ivschat.Client.create_logging_configuration(**kwargs)#

Creates a logging configuration that allows clients to store and record sent messages.

Request Syntax

response = client.create_logging_configuration(
    name='string',
    destinationConfiguration={
        's3': {
            'bucketName': 'string'
        },
        'cloudWatchLogs': {
            'logGroupName': 'string'
        },
        'firehose': {
            'deliveryStreamName': 'string'
        }
    },
    tags={
        'string': 'string'
    }
)

Parameters:

name (string) – Logging-configuration name. The value does not need to be unique.
destinationConfiguration (dict) –
[REQUIRED]

A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination ( cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: s3, cloudWatchLogs, firehose.
- s3 (dict) –
  
  An Amazon S3 destination configuration where chat activity will be logged.
  - bucketName (string) – [REQUIRED]
    
    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) – [REQUIRED]
    
    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) – [REQUIRED]
    
    Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
tags (dict) –
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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) –

Return type:

dict

Returns:

Response Syntax

{
    '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': 'ACTIVE',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- arn (string) –
  
  Logging-configuration ARN, assigned by the system.
- id (string) –
  
  Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
- 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, from the request (if specified).
- destinationConfiguration (dict) –
  
  A complex type that contains a destination configuration for where chat content will be logged, from the request. There is only one type of destination ( cloudWatchLogs, firehose, or s3) in a destinationConfiguration.
  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 the state is ACTIVE, the configuration is ready to log chat content.
- tags (dict) –
  
  Tags attached to the resource, from the request (if specified). Array of maps, each of the form string:string (key:value).
  - (string) –
    - (string) –

Exceptions

ivschat.Client.exceptions.ConflictException
ivschat.Client.exceptions.AccessDeniedException
ivschat.Client.exceptions.ResourceNotFoundException
ivschat.Client.exceptions.ServiceQuotaExceededException
ivschat.Client.exceptions.PendingVerification
ivschat.Client.exceptions.ValidationException