EndUserMessagingClient
AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS) registrations, and send and validate one-time passcodes across the SMS, voice, and WhatsApp channels.
Functions
Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.
Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.
Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.
Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.
Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.
Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.
Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.
Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.
Retrieves a single brand profile attribute.
Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
Retrieves a notify code configuration.
Retrieves a paginated list of the attributes for a brand profile.
Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.
Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.
Retrieves a paginated list of the notify code configurations in your account.
Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
Retrieves the tags that are associated with a resource.
Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.
Adds or overwrites the tags on a resource.
Removes the specified tags from a resource.
Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.
Updates the value, description, or category of an existing brand profile attribute.
Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.
Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.
Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.
Inherited functions
Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.
Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.
Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.
Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.
Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.
Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.
Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.
Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.
Retrieves a single brand profile attribute.
Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
Retrieves a notify code configuration.
Retrieves a paginated list of the attributes for a brand profile.
Paginate over ListBrandProfileAttributesResponse results.
Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.
Paginate over ListBrandProfilesResponse results.
Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.
Paginate over ListJobsResponse results.
Retrieves a paginated list of the notify code configurations in your account.
Paginate over ListNotifyCodeConfigurationsResponse results.
Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
Paginate over ListRegistrationsFromBrandProfileResponse results.
Retrieves the tags that are associated with a resource.
Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.
Adds or overwrites the tags on a resource.
Removes the specified tags from a resource.
Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.
Updates the value, description, or category of an existing brand profile attribute.
Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.
Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.
Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.
Wait until a brand profile reaches the ACTIVE state.
Wait until an async job reaches the SUCCESS terminal state.
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.