notificationscontacts/aws.sdk.kotlin.services.notificationscontacts/NotificationsContactsClient

NotificationsContactsClient

interface NotificationsContactsClient : SdkClient

AWS User Notifications Contacts is a service that allows you to create and manage email contacts for AWS User Notifications. The AWS User Notifications Contacts API Reference provides descriptions, API request parameters, and the JSON response for all email contact related API actions.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: NotificationsContactsClient.Config

NotificationsContactsClient's configuration

Functions

activateEmailContact

abstract suspend fun activateEmailContact(input: ActivateEmailContactRequest): ActivateEmailContactResponse

Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.

createEmailContact

abstract suspend fun createEmailContact(input: CreateEmailContactRequest): CreateEmailContactResponse

Creates an email contact for the provided email address.

deleteEmailContact

abstract suspend fun deleteEmailContact(input: DeleteEmailContactRequest): DeleteEmailContactResponse

Deletes an email contact.

getEmailContact

abstract suspend fun getEmailContact(input: GetEmailContactRequest): GetEmailContactResponse

Returns an email contact.

listEmailContacts

abstract suspend fun listEmailContacts(input: ListEmailContactsRequest = ListEmailContactsRequest { }): ListEmailContactsResponse

Lists all email contacts created under the Account.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

sendActivationCode

abstract suspend fun sendActivationCode(input: SendActivationCodeRequest): SendActivationCodeResponse

Sends an activation email to the email address associated with the specified email contact.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts..

Inherited functions

activateEmailContact

inline suspend fun NotificationsContactsClient.activateEmailContact(crossinline block: ActivateEmailContactRequest.Builder.() -> Unit): ActivateEmailContactResponse

Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.

expect abstract fun close()

createEmailContact

inline suspend fun NotificationsContactsClient.createEmailContact(crossinline block: CreateEmailContactRequest.Builder.() -> Unit): CreateEmailContactResponse

Creates an email contact for the provided email address.

deleteEmailContact

inline suspend fun NotificationsContactsClient.deleteEmailContact(crossinline block: DeleteEmailContactRequest.Builder.() -> Unit): DeleteEmailContactResponse

Deletes an email contact.

getEmailContact

inline suspend fun NotificationsContactsClient.getEmailContact(crossinline block: GetEmailContactRequest.Builder.() -> Unit): GetEmailContactResponse

Returns an email contact.

listEmailContacts

inline suspend fun NotificationsContactsClient.listEmailContacts(crossinline block: ListEmailContactsRequest.Builder.() -> Unit): ListEmailContactsResponse

Lists all email contacts created under the Account.

listEmailContactsPaginated

fun NotificationsContactsClient.listEmailContactsPaginated(initialRequest: ListEmailContactsRequest = ListEmailContactsRequest { }): Flow<ListEmailContactsResponse>

fun NotificationsContactsClient.listEmailContactsPaginated(block: ListEmailContactsRequest.Builder.() -> Unit): Flow<ListEmailContactsResponse>

Paginate over ListEmailContactsResponse results.

listTagsForResource

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

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

sendActivationCode

inline suspend fun NotificationsContactsClient.sendActivationCode(crossinline block: SendActivationCodeRequest.Builder.() -> Unit): SendActivationCodeResponse

Sends an activation email to the email address associated with the specified email contact.

tagResource

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

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.

untagResource

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

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts..

withConfig

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

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.