create_channel async ¶

async def create_channel(
    self,
    name: "capo_cloudtrail.types.channel_name.ChannelName",
    source: "capo_cloudtrail.types.source.Source",
    destinations: "capo_cloudtrail.types.destinations.Destinations",
    *,
    config_overrides: Optional[AsyncCloudTrailClientConfig] = None,
    tags: Optional["capo_cloudtrail.types.tags_list.TagsList"] = None,
) -> "capo_cloudtrail.types.create_channel_response.CreateChannelResponse":
    """<important> <p>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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-service-availability-change.html">CloudTrail Lake availability change</a>.</p> </important> <p>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.</p>

    Args:
        name: <p>The name of the channel.</p>
        source: <p>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.</p> <p> A source can be either <code>Custom</code> 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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information">Additional information about integration partners</a> in the CloudTrail User Guide. </p>
        destinations: <p>One or more event data stores to which events arriving through a channel will be logged.</p>

    Raises:
        capo_cloudtrail.errors.channel_already_exists_exception.ChannelAlreadyExistsException: <p> This exception is thrown when the provided channel already exists. </p>
        capo_cloudtrail.errors.channel_max_limit_exceeded_exception.ChannelMaxLimitExceededException: <p> This exception is thrown when the maximum number of channels limit is exceeded. </p>
        capo_cloudtrail.errors.event_data_store_arn_invalid_exception.EventDataStoreARNInvalidException: <p>The specified event data store ARN is not valid or does not map to an event data store in your account.</p>
        capo_cloudtrail.errors.event_data_store_not_found_exception.EventDataStoreNotFoundException: <p>The specified event data store was not found.</p>
        capo_cloudtrail.errors.inactive_event_data_store_exception.InactiveEventDataStoreException: <p>The event data store is inactive.</p>
        capo_cloudtrail.errors.invalid_event_data_store_category_exception.InvalidEventDataStoreCategoryException: <p>This exception is thrown when event categories of specified event data stores are not valid.</p>
        capo_cloudtrail.errors.invalid_parameter_exception.InvalidParameterException: <p>The request includes a parameter that is not valid.</p>
        capo_cloudtrail.errors.invalid_source_exception.InvalidSourceException: <p>This exception is thrown when the specified value of <code>Source</code> is not valid.</p>
        capo_cloudtrail.errors.invalid_tag_parameter_exception.InvalidTagParameterException: <p>This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.</p>
        capo_cloudtrail.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>This exception is thrown when the requested operation is not permitted.</p>
        capo_cloudtrail.errors.tags_limit_exceeded_exception.TagsLimitExceededException: <p>The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is 50.</p>
        capo_cloudtrail.errors.unsupported_operation_exception.UnsupportedOperationException: <p>This exception is thrown when the requested operation is not supported.</p>
        capo_cloudtrail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudtrail.types.create_channel_request.CreateChannelRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudtrail.types.create_channel_response.CreateChannelResponse"
    ]:
        import capo_cloudtrail._operations.cloud_trail_20131101.create_channel

        (
            output,
            http_response,
        ) = await capo_cloudtrail._operations.cloud_trail_20131101.create_channel.async_create_channel(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateChannel")
    )
    input_: capo_cloudtrail.types.create_channel_request.CreateChannelRequest = {
        "name": name,
        "source": source,
        "destinations": destinations,
    }
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output