Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetLoggingConfiguration

Gets the specified logging configuration.

Request Syntax


POST /GetLoggingConfiguration HTTP/1.1
Content-type: application/json

{
   "identifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

identifier

Identifier of the logging configuration to be retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createTime": "string",
   "destinationConfiguration": { ... },
   "id": "string",
   "name": "string",
   "state": "string",
   "tags": { 
      "string" : "string" 
   },
   "updateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

Logging-configuration ARN, from the request (if identifier was an ARN).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$

createTime

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

Type: Timestamp

destinationConfiguration

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

Type: DestinationConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

id

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

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[a-zA-Z0-9]+$

name

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]*$

state

The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.

Type: String

tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

updateTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

ResourceNotFoundException

HTTP Status Code: 404

ValidationException

HTTP Status Code: 400