notifications/aws.sdk.kotlin.services.notifications/NotificationsClient

NotificationsClient

interface NotificationsClient : SdkClient

The Amazon Web Services User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.

User Notification control plane APIs are currently available in US East (Virginia) - us-east-1.

GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.

The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).

Types

Builder

class Builder : AbstractSdkClientBuilder<NotificationsClient.Config, NotificationsClient.Config.Builder, NotificationsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<NotificationsClient.Config, NotificationsClient.Config.Builder, NotificationsClient, NotificationsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: NotificationsClient.Config

NotificationsClient's configuration

Functions

associateChannel

abstract suspend fun associateChannel(input: AssociateChannelRequest): AssociateChannelResponse

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

associateManagedNotificationAccountContact

abstract suspend fun associateManagedNotificationAccountContact(input: AssociateManagedNotificationAccountContactRequest): AssociateManagedNotificationAccountContactResponse

Associates an Account Contact with a particular ManagedNotificationConfiguration.

associateManagedNotificationAdditionalChannel

abstract suspend fun associateManagedNotificationAdditionalChannel(input: AssociateManagedNotificationAdditionalChannelRequest): AssociateManagedNotificationAdditionalChannelResponse

Associates an additional Channel with a particular ManagedNotificationConfiguration.

createEventRule

abstract suspend fun createEventRule(input: CreateEventRuleRequest): CreateEventRuleResponse

Creates an EventRule that is associated with a specified NotificationConfiguration.

createNotificationConfiguration

abstract suspend fun createNotificationConfiguration(input: CreateNotificationConfigurationRequest): CreateNotificationConfigurationResponse

Creates a new NotificationConfiguration.

deleteEventRule

abstract suspend fun deleteEventRule(input: DeleteEventRuleRequest): DeleteEventRuleResponse

Deletes an EventRule.

deleteNotificationConfiguration

abstract suspend fun deleteNotificationConfiguration(input: DeleteNotificationConfigurationRequest): DeleteNotificationConfigurationResponse

Deletes a NotificationConfiguration.

deregisterNotificationHub

abstract suspend fun deregisterNotificationHub(input: DeregisterNotificationHubRequest): DeregisterNotificationHubResponse

Deregisters a NotificationConfiguration in the specified Region.

disableNotificationsAccessForOrganization

abstract suspend fun disableNotificationsAccessForOrganization(input: DisableNotificationsAccessForOrganizationRequest = DisableNotificationsAccessForOrganizationRequest { }): DisableNotificationsAccessForOrganizationResponse

Disables service trust between User Notifications and Amazon Web Services Organizations.

disassociateChannel

abstract suspend fun disassociateChannel(input: DisassociateChannelRequest): DisassociateChannelResponse

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

disassociateManagedNotificationAccountContact

abstract suspend fun disassociateManagedNotificationAccountContact(input: DisassociateManagedNotificationAccountContactRequest): DisassociateManagedNotificationAccountContactResponse

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

disassociateManagedNotificationAdditionalChannel

abstract suspend fun disassociateManagedNotificationAdditionalChannel(input: DisassociateManagedNotificationAdditionalChannelRequest): DisassociateManagedNotificationAdditionalChannelResponse

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

enableNotificationsAccessForOrganization

abstract suspend fun enableNotificationsAccessForOrganization(input: EnableNotificationsAccessForOrganizationRequest = EnableNotificationsAccessForOrganizationRequest { }): EnableNotificationsAccessForOrganizationResponse

Enables service trust between User Notifications and Amazon Web Services Organizations.

getEventRule

abstract suspend fun getEventRule(input: GetEventRuleRequest): GetEventRuleResponse

Returns a specified EventRule.

getManagedNotificationChildEvent

abstract suspend fun getManagedNotificationChildEvent(input: GetManagedNotificationChildEventRequest): GetManagedNotificationChildEventResponse

Returns the child event of a specific given ManagedNotificationEvent.

getManagedNotificationConfiguration

abstract suspend fun getManagedNotificationConfiguration(input: GetManagedNotificationConfigurationRequest): GetManagedNotificationConfigurationResponse

Returns a specified ManagedNotificationConfiguration.

getManagedNotificationEvent

abstract suspend fun getManagedNotificationEvent(input: GetManagedNotificationEventRequest): GetManagedNotificationEventResponse

Returns a specified ManagedNotificationEvent.

getNotificationConfiguration

abstract suspend fun getNotificationConfiguration(input: GetNotificationConfigurationRequest): GetNotificationConfigurationResponse

Returns a specified NotificationConfiguration.

getNotificationEvent

abstract suspend fun getNotificationEvent(input: GetNotificationEventRequest): GetNotificationEventResponse

Returns a specified NotificationEvent.

getNotificationsAccessForOrganization

abstract suspend fun getNotificationsAccessForOrganization(input: GetNotificationsAccessForOrganizationRequest = GetNotificationsAccessForOrganizationRequest { }): GetNotificationsAccessForOrganizationResponse

Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.

listChannels

abstract suspend fun listChannels(input: ListChannelsRequest): ListChannelsResponse

Returns a list of Channels for a NotificationConfiguration.

listEventRules

abstract suspend fun listEventRules(input: ListEventRulesRequest): ListEventRulesResponse

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

listManagedNotificationChannelAssociations

abstract suspend fun listManagedNotificationChannelAssociations(input: ListManagedNotificationChannelAssociationsRequest): ListManagedNotificationChannelAssociationsResponse

Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.

listManagedNotificationChildEvents

abstract suspend fun listManagedNotificationChildEvents(input: ListManagedNotificationChildEventsRequest): ListManagedNotificationChildEventsResponse

Returns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent, ordered by creation time in reverse chronological order (newest first).

listManagedNotificationConfigurations

abstract suspend fun listManagedNotificationConfigurations(input: ListManagedNotificationConfigurationsRequest = ListManagedNotificationConfigurationsRequest { }): ListManagedNotificationConfigurationsResponse

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

listManagedNotificationEvents

abstract suspend fun listManagedNotificationEvents(input: ListManagedNotificationEventsRequest = ListManagedNotificationEventsRequest { }): ListManagedNotificationEventsResponse

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

listNotificationConfigurations

abstract suspend fun listNotificationConfigurations(input: ListNotificationConfigurationsRequest = ListNotificationConfigurationsRequest { }): ListNotificationConfigurationsResponse

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

listNotificationEvents

abstract suspend fun listNotificationEvents(input: ListNotificationEventsRequest = ListNotificationEventsRequest { }): ListNotificationEventsResponse

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

listNotificationHubs

abstract suspend fun listNotificationHubs(input: ListNotificationHubsRequest = ListNotificationHubsRequest { }): ListNotificationHubsResponse

Returns a list of NotificationHubs.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns a list of tags for a specified Amazon Resource Name (ARN).

registerNotificationHub

abstract suspend fun registerNotificationHub(input: RegisterNotificationHubRequest): RegisterNotificationHubResponse

Registers a NotificationConfiguration in the specified Region.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags the resource with a tag key and value.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Untags a resource with a specified Amazon Resource Name (ARN).

updateEventRule

abstract suspend fun updateEventRule(input: UpdateEventRuleRequest): UpdateEventRuleResponse

Updates an existing EventRule.

updateNotificationConfiguration

abstract suspend fun updateNotificationConfiguration(input: UpdateNotificationConfigurationRequest): UpdateNotificationConfigurationResponse

Updates a NotificationConfiguration.

Inherited functions

associateChannel

inline suspend fun NotificationsClient.associateChannel(crossinline block: AssociateChannelRequest.Builder.() -> Unit): AssociateChannelResponse

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

associateManagedNotificationAccountContact

inline suspend fun NotificationsClient.associateManagedNotificationAccountContact(crossinline block: AssociateManagedNotificationAccountContactRequest.Builder.() -> Unit): AssociateManagedNotificationAccountContactResponse

Associates an Account Contact with a particular ManagedNotificationConfiguration.

associateManagedNotificationAdditionalChannel

inline suspend fun NotificationsClient.associateManagedNotificationAdditionalChannel(crossinline block: AssociateManagedNotificationAdditionalChannelRequest.Builder.() -> Unit): AssociateManagedNotificationAdditionalChannelResponse

Associates an additional Channel with a particular ManagedNotificationConfiguration.

expect abstract fun close()

createEventRule

inline suspend fun NotificationsClient.createEventRule(crossinline block: CreateEventRuleRequest.Builder.() -> Unit): CreateEventRuleResponse

Creates an EventRule that is associated with a specified NotificationConfiguration.

createNotificationConfiguration

inline suspend fun NotificationsClient.createNotificationConfiguration(crossinline block: CreateNotificationConfigurationRequest.Builder.() -> Unit): CreateNotificationConfigurationResponse

Creates a new NotificationConfiguration.

deleteEventRule

inline suspend fun NotificationsClient.deleteEventRule(crossinline block: DeleteEventRuleRequest.Builder.() -> Unit): DeleteEventRuleResponse

Deletes an EventRule.

deleteNotificationConfiguration

inline suspend fun NotificationsClient.deleteNotificationConfiguration(crossinline block: DeleteNotificationConfigurationRequest.Builder.() -> Unit): DeleteNotificationConfigurationResponse

Deletes a NotificationConfiguration.

deregisterNotificationHub

inline suspend fun NotificationsClient.deregisterNotificationHub(crossinline block: DeregisterNotificationHubRequest.Builder.() -> Unit): DeregisterNotificationHubResponse

Deregisters a NotificationConfiguration in the specified Region.

disableNotificationsAccessForOrganization

inline suspend fun NotificationsClient.disableNotificationsAccessForOrganization(crossinline block: DisableNotificationsAccessForOrganizationRequest.Builder.() -> Unit): DisableNotificationsAccessForOrganizationResponse

Disables service trust between User Notifications and Amazon Web Services Organizations.

disassociateChannel

inline suspend fun NotificationsClient.disassociateChannel(crossinline block: DisassociateChannelRequest.Builder.() -> Unit): DisassociateChannelResponse

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

disassociateManagedNotificationAccountContact

inline suspend fun NotificationsClient.disassociateManagedNotificationAccountContact(crossinline block: DisassociateManagedNotificationAccountContactRequest.Builder.() -> Unit): DisassociateManagedNotificationAccountContactResponse

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

disassociateManagedNotificationAdditionalChannel

inline suspend fun NotificationsClient.disassociateManagedNotificationAdditionalChannel(crossinline block: DisassociateManagedNotificationAdditionalChannelRequest.Builder.() -> Unit): DisassociateManagedNotificationAdditionalChannelResponse

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

enableNotificationsAccessForOrganization

inline suspend fun NotificationsClient.enableNotificationsAccessForOrganization(crossinline block: EnableNotificationsAccessForOrganizationRequest.Builder.() -> Unit): EnableNotificationsAccessForOrganizationResponse

Enables service trust between User Notifications and Amazon Web Services Organizations.

getEventRule

inline suspend fun NotificationsClient.getEventRule(crossinline block: GetEventRuleRequest.Builder.() -> Unit): GetEventRuleResponse

Returns a specified EventRule.

getManagedNotificationChildEvent

inline suspend fun NotificationsClient.getManagedNotificationChildEvent(crossinline block: GetManagedNotificationChildEventRequest.Builder.() -> Unit): GetManagedNotificationChildEventResponse

Returns the child event of a specific given ManagedNotificationEvent.

getManagedNotificationConfiguration

inline suspend fun NotificationsClient.getManagedNotificationConfiguration(crossinline block: GetManagedNotificationConfigurationRequest.Builder.() -> Unit): GetManagedNotificationConfigurationResponse

Returns a specified ManagedNotificationConfiguration.

getManagedNotificationEvent

inline suspend fun NotificationsClient.getManagedNotificationEvent(crossinline block: GetManagedNotificationEventRequest.Builder.() -> Unit): GetManagedNotificationEventResponse

Returns a specified ManagedNotificationEvent.

getNotificationConfiguration

inline suspend fun NotificationsClient.getNotificationConfiguration(crossinline block: GetNotificationConfigurationRequest.Builder.() -> Unit): GetNotificationConfigurationResponse

Returns a specified NotificationConfiguration.

getNotificationEvent

inline suspend fun NotificationsClient.getNotificationEvent(crossinline block: GetNotificationEventRequest.Builder.() -> Unit): GetNotificationEventResponse

Returns a specified NotificationEvent.

getNotificationsAccessForOrganization

inline suspend fun NotificationsClient.getNotificationsAccessForOrganization(crossinline block: GetNotificationsAccessForOrganizationRequest.Builder.() -> Unit): GetNotificationsAccessForOrganizationResponse

Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.

listChannels

inline suspend fun NotificationsClient.listChannels(crossinline block: ListChannelsRequest.Builder.() -> Unit): ListChannelsResponse

Returns a list of Channels for a NotificationConfiguration.

listChannelsPaginated

fun NotificationsClient.listChannelsPaginated(initialRequest: ListChannelsRequest): Flow<ListChannelsResponse>

fun NotificationsClient.listChannelsPaginated(block: ListChannelsRequest.Builder.() -> Unit): Flow<ListChannelsResponse>

Paginate over ListChannelsResponse results.

listEventRules

inline suspend fun NotificationsClient.listEventRules(crossinline block: ListEventRulesRequest.Builder.() -> Unit): ListEventRulesResponse

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

listEventRulesPaginated

fun NotificationsClient.listEventRulesPaginated(initialRequest: ListEventRulesRequest): Flow<ListEventRulesResponse>

fun NotificationsClient.listEventRulesPaginated(block: ListEventRulesRequest.Builder.() -> Unit): Flow<ListEventRulesResponse>

Paginate over ListEventRulesResponse results.

listManagedNotificationChannelAssociations

inline suspend fun NotificationsClient.listManagedNotificationChannelAssociations(crossinline block: ListManagedNotificationChannelAssociationsRequest.Builder.() -> Unit): ListManagedNotificationChannelAssociationsResponse

Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.

listManagedNotificationChannelAssociationsPaginated

fun NotificationsClient.listManagedNotificationChannelAssociationsPaginated(initialRequest: ListManagedNotificationChannelAssociationsRequest): Flow<ListManagedNotificationChannelAssociationsResponse>

fun NotificationsClient.listManagedNotificationChannelAssociationsPaginated(block: ListManagedNotificationChannelAssociationsRequest.Builder.() -> Unit): Flow<ListManagedNotificationChannelAssociationsResponse>

Paginate over ListManagedNotificationChannelAssociationsResponse results.

listManagedNotificationChildEvents

inline suspend fun NotificationsClient.listManagedNotificationChildEvents(crossinline block: ListManagedNotificationChildEventsRequest.Builder.() -> Unit): ListManagedNotificationChildEventsResponse

Returns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent, ordered by creation time in reverse chronological order (newest first).

listManagedNotificationChildEventsPaginated

fun NotificationsClient.listManagedNotificationChildEventsPaginated(initialRequest: ListManagedNotificationChildEventsRequest): Flow<ListManagedNotificationChildEventsResponse>

fun NotificationsClient.listManagedNotificationChildEventsPaginated(block: ListManagedNotificationChildEventsRequest.Builder.() -> Unit): Flow<ListManagedNotificationChildEventsResponse>

Paginate over ListManagedNotificationChildEventsResponse results.

listManagedNotificationConfigurations

inline suspend fun NotificationsClient.listManagedNotificationConfigurations(crossinline block: ListManagedNotificationConfigurationsRequest.Builder.() -> Unit): ListManagedNotificationConfigurationsResponse

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

listManagedNotificationConfigurationsPaginated

fun NotificationsClient.listManagedNotificationConfigurationsPaginated(initialRequest: ListManagedNotificationConfigurationsRequest = ListManagedNotificationConfigurationsRequest { }): Flow<ListManagedNotificationConfigurationsResponse>

fun NotificationsClient.listManagedNotificationConfigurationsPaginated(block: ListManagedNotificationConfigurationsRequest.Builder.() -> Unit): Flow<ListManagedNotificationConfigurationsResponse>

Paginate over ListManagedNotificationConfigurationsResponse results.

listManagedNotificationEvents

inline suspend fun NotificationsClient.listManagedNotificationEvents(crossinline block: ListManagedNotificationEventsRequest.Builder.() -> Unit): ListManagedNotificationEventsResponse

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

listManagedNotificationEventsPaginated

fun NotificationsClient.listManagedNotificationEventsPaginated(initialRequest: ListManagedNotificationEventsRequest = ListManagedNotificationEventsRequest { }): Flow<ListManagedNotificationEventsResponse>

fun NotificationsClient.listManagedNotificationEventsPaginated(block: ListManagedNotificationEventsRequest.Builder.() -> Unit): Flow<ListManagedNotificationEventsResponse>

Paginate over ListManagedNotificationEventsResponse results.

listNotificationConfigurations

inline suspend fun NotificationsClient.listNotificationConfigurations(crossinline block: ListNotificationConfigurationsRequest.Builder.() -> Unit): ListNotificationConfigurationsResponse

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

listNotificationConfigurationsPaginated

fun NotificationsClient.listNotificationConfigurationsPaginated(initialRequest: ListNotificationConfigurationsRequest = ListNotificationConfigurationsRequest { }): Flow<ListNotificationConfigurationsResponse>

fun NotificationsClient.listNotificationConfigurationsPaginated(block: ListNotificationConfigurationsRequest.Builder.() -> Unit): Flow<ListNotificationConfigurationsResponse>

Paginate over ListNotificationConfigurationsResponse results.

listNotificationEvents

inline suspend fun NotificationsClient.listNotificationEvents(crossinline block: ListNotificationEventsRequest.Builder.() -> Unit): ListNotificationEventsResponse

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

listNotificationEventsPaginated

fun NotificationsClient.listNotificationEventsPaginated(initialRequest: ListNotificationEventsRequest = ListNotificationEventsRequest { }): Flow<ListNotificationEventsResponse>

fun NotificationsClient.listNotificationEventsPaginated(block: ListNotificationEventsRequest.Builder.() -> Unit): Flow<ListNotificationEventsResponse>

Paginate over ListNotificationEventsResponse results.

listNotificationHubs

inline suspend fun NotificationsClient.listNotificationHubs(crossinline block: ListNotificationHubsRequest.Builder.() -> Unit): ListNotificationHubsResponse

Returns a list of NotificationHubs.

listNotificationHubsPaginated

fun NotificationsClient.listNotificationHubsPaginated(initialRequest: ListNotificationHubsRequest = ListNotificationHubsRequest { }): Flow<ListNotificationHubsResponse>

fun NotificationsClient.listNotificationHubsPaginated(block: ListNotificationHubsRequest.Builder.() -> Unit): Flow<ListNotificationHubsResponse>

Paginate over ListNotificationHubsResponse results.

listTagsForResource

inline suspend fun NotificationsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags for a specified Amazon Resource Name (ARN).

registerNotificationHub

inline suspend fun NotificationsClient.registerNotificationHub(crossinline block: RegisterNotificationHubRequest.Builder.() -> Unit): RegisterNotificationHubResponse

Registers a NotificationConfiguration in the specified Region.

tagResource

inline suspend fun NotificationsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags the resource with a tag key and value.

untagResource

inline suspend fun NotificationsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Untags a resource with a specified Amazon Resource Name (ARN).

updateEventRule

inline suspend fun NotificationsClient.updateEventRule(crossinline block: UpdateEventRuleRequest.Builder.() -> Unit): UpdateEventRuleResponse

Updates an existing EventRule.

updateNotificationConfiguration

inline suspend fun NotificationsClient.updateNotificationConfiguration(crossinline block: UpdateNotificationConfigurationRequest.Builder.() -> Unit): UpdateNotificationConfigurationResponse

Updates a NotificationConfiguration.

withConfig

fun NotificationsClient.withConfig(block: NotificationsClient.Config.Builder.() -> Unit): NotificationsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.