notifications/aws.sdk.kotlin.services.notifications

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

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.

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.

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).

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.

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).

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).

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).

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).

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).

listNotificationHubs

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

Returns a list of NotificationHubs.

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.