LoggingConfigurationSummary - Amazon IVS

LoggingConfigurationSummary

Summary information about a logging configuration.

Contents

arn

Logging-configuration 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-]+$

Required: No

createTime

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

Type: Timestamp

Required: No

destinationConfiguration

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

Type: DestinationConfiguration object

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

Required: No

id

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

Type: String

Length Constraints: Fixed length of 12.

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

Required: No

name

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

Type: String

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

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

Required: No

state

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

Type: String

Valid Values: CREATING | CREATE_FAILED | DELETING | DELETE_FAILED | UPDATING | UPDATE_FAILED | ACTIVE

Required: No

tags

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.

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.

Required: No

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: