amazonka-ivschat-2.0: Amazon Interactive Video Service Chat SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IVSChat.CreateLoggingConfiguration

Description

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

Synopsis

Creating a Request

data CreateLoggingConfiguration Source #

See: newCreateLoggingConfiguration smart constructor.

Constructors

CreateLoggingConfiguration' 

Fields

  • name :: Maybe Text

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

  • tags :: Maybe (HashMap Text Text)

    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.

  • destinationConfiguration :: DestinationConfiguration

    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.

Instances

Instances details
ToJSON CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

ToHeaders CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

ToPath CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

ToQuery CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

AWSRequest CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Generic CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Associated Types

type Rep CreateLoggingConfiguration :: Type -> Type #

Read CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Show CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

NFData CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Eq CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Hashable CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

type AWSResponse CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

type Rep CreateLoggingConfiguration Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

type Rep CreateLoggingConfiguration = D1 ('MetaData "CreateLoggingConfiguration" "Amazonka.IVSChat.CreateLoggingConfiguration" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "CreateLoggingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "destinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DestinationConfiguration))))

newCreateLoggingConfiguration Source #

Create a value of CreateLoggingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

CreateLoggingConfiguration, createLoggingConfiguration_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.

CreateLoggingConfiguration, createLoggingConfiguration_destinationConfiguration - 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.

Request Lenses

createLoggingConfiguration_name :: Lens' CreateLoggingConfiguration (Maybe Text) Source #

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

createLoggingConfiguration_tags :: Lens' CreateLoggingConfiguration (Maybe (HashMap Text Text)) Source #

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.

createLoggingConfiguration_destinationConfiguration :: Lens' CreateLoggingConfiguration DestinationConfiguration Source #

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.

Destructuring the Response

data CreateLoggingConfigurationResponse Source #

Constructors

CreateLoggingConfigurationResponse' 

Fields

  • arn :: Maybe Text

    Logging-configuration ARN, assigned by the system.

  • createTime :: Maybe ISO8601

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

  • destinationConfiguration :: Maybe DestinationConfiguration

    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.

  • id :: Maybe Text

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

  • name :: Maybe Text

    Logging-configuration name, from the request (if specified).

  • state :: Maybe CreateLoggingConfigurationState

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

  • tags :: Maybe (HashMap Text Text)

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

  • updateTime :: Maybe ISO8601

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateLoggingConfigurationResponse Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Associated Types

type Rep CreateLoggingConfigurationResponse :: Type -> Type #

Read CreateLoggingConfigurationResponse Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Show CreateLoggingConfigurationResponse Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

NFData CreateLoggingConfigurationResponse Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

Eq CreateLoggingConfigurationResponse Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

type Rep CreateLoggingConfigurationResponse Source # 
Instance details

Defined in Amazonka.IVSChat.CreateLoggingConfiguration

newCreateLoggingConfigurationResponse Source #

Create a value of CreateLoggingConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateLoggingConfigurationResponse, createLoggingConfigurationResponse_arn - Logging-configuration ARN, assigned by the system.

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

CreateLoggingConfiguration, createLoggingConfigurationResponse_destinationConfiguration - 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.

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

CreateLoggingConfiguration, createLoggingConfigurationResponse_name - Logging-configuration name, from the request (if specified).

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

CreateLoggingConfiguration, createLoggingConfigurationResponse_tags - Tags attached to the resource, from the request (if specified). Array of maps, each of the form string:string (key:value).

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

$sel:httpStatus:CreateLoggingConfigurationResponse', createLoggingConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createLoggingConfigurationResponse_createTime :: Lens' CreateLoggingConfigurationResponse (Maybe UTCTime) Source #

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

createLoggingConfigurationResponse_destinationConfiguration :: Lens' CreateLoggingConfigurationResponse (Maybe DestinationConfiguration) Source #

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.

createLoggingConfigurationResponse_id :: Lens' CreateLoggingConfigurationResponse (Maybe Text) Source #

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

createLoggingConfigurationResponse_name :: Lens' CreateLoggingConfigurationResponse (Maybe Text) Source #

Logging-configuration name, from the request (if specified).

createLoggingConfigurationResponse_state :: Lens' CreateLoggingConfigurationResponse (Maybe CreateLoggingConfigurationState) Source #

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

createLoggingConfigurationResponse_tags :: Lens' CreateLoggingConfigurationResponse (Maybe (HashMap Text Text)) Source #

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

createLoggingConfigurationResponse_updateTime :: Lens' CreateLoggingConfigurationResponse (Maybe UTCTime) Source #

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