ivschat / Client / get_logging_configuration
get_logging_configuration#
- ivschat.Client.get_logging_configuration(**kwargs)#
Gets the specified logging configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_logging_configuration( identifier='string' )
- Parameters:
identifier (string) –
[REQUIRED]
Identifier of the logging configuration to be retrieved.
- Return type:
dict
- Returns:
Response Syntax
{ 'arn': 'string', 'createTime': datetime(2015, 1, 1), 'destinationConfiguration': { 'cloudWatchLogs': { 'logGroupName': 'string' }, 'firehose': { 'deliveryStreamName': 'string' }, 's3': { 'bucketName': 'string' } }, 'id': 'string', 'name': 'string', 'state': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'ACTIVE', 'tags': { 'string': 'string' }, 'updateTime': datetime(2015, 1, 1) }
Response Structure
(dict) –
arn (string) –
Logging-configuration ARN, from the request (if
identifier
was an ARN).createTime (datetime) –
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
destinationConfiguration (dict) –
A complex type that contains a destination configuration for where chat content will be logged. There is only one type of destination (
cloudWatchLogs
,firehose
, ors3
) in adestinationConfiguration
.Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
cloudWatchLogs
,firehose
,s3
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
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.
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.
name (string) –
Logging-configuration name. This value does not need to be unique.
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. Array of maps, each of the form
string:string (key:value)
.(string) –
(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.
Exceptions
ivschat.Client.exceptions.AccessDeniedException
ivschat.Client.exceptions.ResourceNotFoundException
ivschat.Client.exceptions.ValidationException