update_channel

update_channel(**kwargs)

Updates a channel specified by a required channel ARN or UUID.

See also: AWS API Documentation

Request Syntax

response = client.update_channel(
    Channel='string',
    Destinations=[
        {
            'Type': 'EVENT_DATA_STORE'|'AWS_SERVICE',
            'Location': 'string'
        },
    ],
    Name='string'
)

Parameters

• Channel (string) --

  [REQUIRED]

  The ARN or ID (the ARN suffix) of the channel that you want to update.

• Destinations (list) --

  The ARNs of event data stores that you want to log events arriving through the channel.

  • (dict) --

    Contains information about the destination receiving events.

    • Type (string) -- [REQUIRED]

      The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EventDataStore . For service-linked channels, the value is AWS_SERVICE .

    • Location (string) -- [REQUIRED]

      For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.

• Name (string) -- Changes the name of the channel.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'Name': 'string',
    'Source': 'string',
    'Destinations': [
        {
            'Type': 'EVENT_DATA_STORE'|'AWS_SERVICE',
            'Location': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • ChannelArn (string) --

    The ARN of the channel that was updated.

  • Name (string) --

    The name of the channel that was updated.

  • Source (string) --

    The event source of the channel that was updated.

  • Destinations (list) --

    The event data stores that log events arriving through the channel.

    • (dict) --

      Contains information about the destination receiving events.

      • Type (string) --

        The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EventDataStore . For service-linked channels, the value is AWS_SERVICE .

      • Location (string) --

        For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.

Exceptions

• CloudTrail.Client.exceptions.ChannelARNInvalidException
• CloudTrail.Client.exceptions.ChannelNotFoundException
• CloudTrail.Client.exceptions.ChannelAlreadyExistsException
• CloudTrail.Client.exceptions.EventDataStoreARNInvalidException
• CloudTrail.Client.exceptions.EventDataStoreNotFoundException
• CloudTrail.Client.exceptions.InvalidEventDataStoreCategoryException
• CloudTrail.Client.exceptions.InactiveEventDataStoreException
• CloudTrail.Client.exceptions.InvalidParameterException
• CloudTrail.Client.exceptions.OperationNotPermittedException
• CloudTrail.Client.exceptions.UnsupportedOperationException