The channel-specific parameters used to render and deliver a one-time passcode. Each member configures the parameters for one delivery route. Populate only the channels that a configuration or send request supports. A notify code configuration can carry every channel at once, and a send request resolves to a single route that selects the matching channel at send time.

CodeConfigurationParameters

class CodeConfigurationParameters

The passcode policy parameters that are grouped for reuse across a notify code configuration and its create request. Each member is optional. When you omit a member on a create request, no value is applied at create time and the default is applied when a passcode is sent.

CodeType

sealed class CodeType

OTP character alphabet used by a NotifyCodeConfiguration.

ConflictException

class ConflictException : EndUserMessagingException

The request conflicts with the current state of the resource.

CreateBrandProfileAttributesRequest

class CreateBrandProfileAttributesRequest

CreateBrandProfileAttributesResponse

class CreateBrandProfileAttributesResponse

CreateBrandProfileFromRegistrationRequest

class CreateBrandProfileFromRegistrationRequest

CreateBrandProfileFromRegistrationResponse

class CreateBrandProfileFromRegistrationResponse

CreateBrandProfileRequest

class CreateBrandProfileRequest

CreateBrandProfileResponse

class CreateBrandProfileResponse

CreateNotifyCodeConfigurationRequest

class CreateNotifyCodeConfigurationRequest

CreateNotifyCodeConfigurationResponse

class CreateNotifyCodeConfigurationResponse

CreateRegistrationsFromBrandProfileRequest

class CreateRegistrationsFromBrandProfileRequest

CreateRegistrationsFromBrandProfileResponse

class CreateRegistrationsFromBrandProfileResponse

DeleteBrandProfileAttributeRequest

class DeleteBrandProfileAttributeRequest

DeleteBrandProfileAttributeResponse

class DeleteBrandProfileAttributeResponse

DeleteBrandProfileRequest

class DeleteBrandProfileRequest

DeleteBrandProfileResponse

class DeleteBrandProfileResponse

DeleteNotifyCodeConfigurationRequest

class DeleteNotifyCodeConfigurationRequest

DeleteNotifyCodeConfigurationResponse

class DeleteNotifyCodeConfigurationResponse

EndUserMessagingException

open class EndUserMessagingException : AwsServiceException

Base class for all service related exceptions thrown by the EndUserMessaging client

GetBrandProfileAttributeRequest

class GetBrandProfileAttributeRequest

GetBrandProfileAttributeResponse

class GetBrandProfileAttributeResponse

GetBrandProfileRequest

class GetBrandProfileRequest

GetBrandProfileResponse

class GetBrandProfileResponse

GetJobRequest

class GetJobRequest

GetJobResponse

class GetJobResponse

Information about an async job tracked by the service. GetJob returns the full Job, which may grow detail-only fields that are not part of the JobSummary list view.

GetNotifyCodeConfigurationRequest

class GetNotifyCodeConfigurationRequest

GetNotifyCodeConfigurationResponse

class GetNotifyCodeConfigurationResponse

InternalServerException

class InternalServerException : EndUserMessagingException

An unexpected error occurred during the processing of the request.

JobResource

class JobResource

Contains information about a resource that was created or updated by an asynchronous job.

JobResourceType

sealed class JobResourceType

Type of resource associated with a job.

JobResult

class JobResult

Pairs an asynchronous job with the resource identifier from your request that the job processes.

JobStatus

sealed class JobStatus

Processing status of an async job.

JobSummary

class JobSummary

Contains summary information about an asynchronous job in a list response.

ListBrandProfileAttributesRequest

class ListBrandProfileAttributesRequest

ListBrandProfileAttributesResponse

class ListBrandProfileAttributesResponse

ListBrandProfilesRequest

class ListBrandProfilesRequest

ListBrandProfilesResponse

class ListBrandProfilesResponse

ListJobsRequest

class ListJobsRequest

ListJobsResponse

class ListJobsResponse

ListNotifyCodeConfigurationsRequest

class ListNotifyCodeConfigurationsRequest

ListNotifyCodeConfigurationsResponse

class ListNotifyCodeConfigurationsResponse

ListRegistrationsFromBrandProfileRequest

class ListRegistrationsFromBrandProfileRequest

ListRegistrationsFromBrandProfileResponse

class ListRegistrationsFromBrandProfileResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

NotifyChannel

sealed class NotifyChannel

Channel used to deliver an OTP to the end user.

NotifyCodeConfiguration

class NotifyCodeConfiguration

Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.

NotifyParameters

class NotifyParameters

The delivery parameters for the preapproved notify-template route over the SMS or voice channels.

OnAttributeConflict

sealed class OnAttributeConflict

Strategy for merging registration data into brand profile attributes.

RegistrationAssociationSummary

class RegistrationAssociationSummary

Contains summary information about a registration that is associated with a brand profile.

ResourceNotFoundException

class ResourceNotFoundException : EndUserMessagingException

The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.

SendNotifyCodeVerificationRequest

class SendNotifyCodeVerificationRequest

SendNotifyCodeVerificationResponse

class SendNotifyCodeVerificationResponse

ServiceQuotaExceededException

class ServiceQuotaExceededException : EndUserMessagingException

The request would exceed a service quota for your account.

Status

sealed class Status

Brand profile lifecycle status. Exposed on brand profile API responses (Get, List, Create, Update).

Tag

class Tag

Describes a tag as a key and value pair that you can associate with a resource.

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

TextParameters

class TextParameters

The delivery parameters for the text channel, which delivers over SMS or RCS.

ThrottlingException

class ThrottlingException : EndUserMessagingException

The request was denied because it exceeded the allowed request rate.

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateBrandProfileAttributeRequest

class UpdateBrandProfileAttributeRequest

UpdateBrandProfileAttributeResponse

class UpdateBrandProfileAttributeResponse

UpdateBrandProfileFromRegistrationRequest

class UpdateBrandProfileFromRegistrationRequest

UpdateBrandProfileFromRegistrationResponse

class UpdateBrandProfileFromRegistrationResponse

UpdateBrandProfileRequest

class UpdateBrandProfileRequest

UpdateBrandProfileResponse

class UpdateBrandProfileResponse

UpdateChannelParameters

class UpdateChannelParameters

The updated channel-specific parameters used only when you update a notify code configuration. When you omit a channel, that channel's parameters remain unchanged. When you supply a channel, you can clear individual fields by using the empty-string or empty-map sentinel on a member, or drop the whole channel's parameters by clearing every member. These sentinels apply only when you update a configuration; a create request rejects empty values with a validation error.

UpdateCodeConfigurationParameters

class UpdateCodeConfigurationParameters

The loose variant of the passcode policy parameters that is used only when you update a notify code configuration. When you omit a member, its current value is preserved.

UpdateNotifyCodeConfigurationRequest

class UpdateNotifyCodeConfigurationRequest

UpdateNotifyCodeConfigurationResponse

class UpdateNotifyCodeConfigurationResponse

UpdateNotifyParameters

class UpdateNotifyParameters

The updated delivery parameters for the preapproved notify-template route. Absent members preserve the current value, and the empty sentinel on a member clears it.

UpdateRegistrationsFromBrandProfileRequest

class UpdateRegistrationsFromBrandProfileRequest

UpdateRegistrationsFromBrandProfileResponse

class UpdateRegistrationsFromBrandProfileResponse

UpdateTextParameters

class UpdateTextParameters

The updated delivery parameters for the text channel. Absent members preserve the current value, and the empty sentinel on a member clears it.

UpdateVoiceParameters

class UpdateVoiceParameters

The updated delivery parameters for the voice channel. Absent members preserve the current value, and the empty sentinel on a member clears it.

UpdateWhatsAppParameters

class UpdateWhatsAppParameters

The updated delivery parameters for the WhatsApp channel. Absent members preserve the current value, and the empty sentinel on a member clears it.

ValidateNotifyCodeVerificationRequest

class ValidateNotifyCodeVerificationRequest

ValidateNotifyCodeVerificationResponse

class ValidateNotifyCodeVerificationResponse

ValidationException

class ValidationException : EndUserMessagingException

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ValidationExceptionField

class ValidationExceptionField

Describes one specific validation failure for an input member.

VerificationStatus

sealed class VerificationStatus

Outcome of a ValidateNotifyCodeVerification request.

VoiceMessageBodyTextType

sealed class VoiceMessageBodyTextType

The format of the voice message body text.

VoiceParameters

class VoiceParameters

The delivery parameters for the voice channel.

WhatsAppParameters

class WhatsAppParameters

The delivery parameters for the WhatsApp channel.