Skip to content

associate_channel

associate_channel(
    arn: ChannelArn,
    notification_configuration_arn: NotificationConfigurationArn,
    *,
    config_overrides: Optional[NotificationsClientConfig] = None,
) -> AssociateChannelResponse

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

Parameters:

  • arn (ChannelArn) –

    The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.

    Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and notifications-contacts.

  • notification_configuration_arn (NotificationConfigurationArn) –

    The ARN of the NotificationConfiguration to associate with the Channel.

Raises:

Source code in docs_src/capo_notifications/_services/notifications.py
def associate_channel(
    self,
    arn: "capo_notifications.types.channel_arn.ChannelArn",
    notification_configuration_arn: "capo_notifications.types.notification_configuration_arn.NotificationConfigurationArn",
    *,
    config_overrides: Optional[NotificationsClientConfig] = None,
) -> "capo_notifications.types.associate_channel_response.AssociateChannelResponse":
    """<p>Associates a delivery <a href="https://docs.aws.amazon.com/notifications/latest/userguide/managing-delivery-channels.html">Channel</a> with a particular <code>NotificationConfiguration</code>. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>NotificationConfiguration</code>.</p> <p>Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and notifications-contacts.</p>
        notification_configuration_arn: <p>The ARN of the <code>NotificationConfiguration</code> to associate with the Channel.</p>

    Raises:
        capo_notifications.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_notifications.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_notifications.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_notifications.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist. </p>
        capo_notifications.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_notifications.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling. </p>
        capo_notifications.errors.validation_exception.ValidationException: <p>This exception is thrown when the notification event fails validation.</p>
        capo_notifications.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_notifications.types.associate_channel_request.AssociateChannelRequest]",
    ) -> OperationResponse[
        "capo_notifications.types.associate_channel_response.AssociateChannelResponse"
    ]:
        import capo_notifications._operations.notifications.associate_channel

        output, http_response = (
            capo_notifications._operations.notifications.associate_channel.associate_channel(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateChannel")
    )
    input_: capo_notifications.types.associate_channel_request.AssociateChannelRequest = {
        "arn": arn,
        "notification_configuration_arn": notification_configuration_arn,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output