Skip to content

create_channel

Operation

create_channel

create_channel(request: CreateChannelInput | CreateChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateChannelInputDict]) -> CreateChannelOutput
Warning

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.

Parameters:

Name Type Description Default
request CreateChannelInput | CreateChannelInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateChannelOutput

An instance of CreateChannelOutput.

create_channel async

create_channel(request: CreateChannelInput | CreateChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateChannelInputDict]) -> CreateChannelOutput
Warning

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.

Parameters:

Name Type Description Default
request CreateChannelInput | CreateChannelInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateChannelOutput

An instance of CreateChannelOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateChannelInputDict

Bases: TypedDict

Dictionary form of CreateChannelInput.

Attributes

destinations instance-attribute

One or more event data stores to which events arriving through a channel will be logged.

name instance-attribute
name: Required[str]

The name of the channel.

source instance-attribute
source: Required[str]

The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

tags instance-attribute
tags: Sequence[Tag | TagDict] | None

A list of tags.

CreateChannelInput dataclass

Bases: _SerdeShape

Dataclass for CreateChannelInput structure.

Attributes

destinations class-attribute instance-attribute
destinations: list[Destination] | None = ...

One or more event data stores to which events arriving through a channel will be logged.

name class-attribute instance-attribute
name: str | None = ...

The name of the channel.

source class-attribute instance-attribute
source: str | None = ...

The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

A list of tags.

Output

CreateChannelOutput dataclass

Bases: _SerdeShape

Dataclass for CreateChannelOutput structure.

Attributes

channel_arn class-attribute instance-attribute
channel_arn: str | None = ...

The Amazon Resource Name (ARN) of the new channel.

destinations class-attribute instance-attribute
destinations: list[Destination] | None = ...

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

name class-attribute instance-attribute
name: str | None = ...

The name of the new channel.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

source class-attribute instance-attribute
source: str | None = ...

The partner or external event source name.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

A list of tags.