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.
", "operations": { "CreateBrandProfile": "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.
", "CreateBrandProfileAttributes": "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.
", "CreateBrandProfileFromRegistration": "Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
", "CreateNotifyCodeConfiguration": "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.
", "CreateRegistrationsFromBrandProfile": "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.
", "DeleteBrandProfile": "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.
", "DeleteBrandProfileAttribute": "Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.
", "DeleteNotifyCodeConfiguration": "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.
", "GetBrandProfile": "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.
", "GetBrandProfileAttribute": "Retrieves a single brand profile attribute.
", "GetJob": "Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
", "GetNotifyCodeConfiguration": "Retrieves a notify code configuration.
", "ListBrandProfileAttributes": "Retrieves a paginated list of the attributes for a brand profile.
", "ListBrandProfiles": "Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.
", "ListJobs": "Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.
", "ListNotifyCodeConfigurations": "Retrieves a paginated list of the notify code configurations in your account.
", "ListRegistrationsFromBrandProfile": "Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
", "ListTagsForResource": "Retrieves the tags that are associated with a resource.
", "SendNotifyCodeVerification": "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.
", "TagResource": "Adds or overwrites the tags on a resource.
", "UntagResource": "Removes the specified tags from a resource.
", "UpdateBrandProfile": "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.
", "UpdateBrandProfileAttribute": "Updates the value, description, or category of an existing brand profile attribute.
", "UpdateBrandProfileFromRegistration": "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.
", "UpdateNotifyCodeConfiguration": "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.
", "UpdateRegistrationsFromBrandProfile": "Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.
", "ValidateNotifyCodeVerification": "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.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": {} }, "AmazonResourceName": { "base": "Amazon Resource Name.
", "refs": { "BrandProfileInfo$brandProfileArn": "The Amazon Resource Name (ARN) of the brand profile.
", "CreateBrandProfileOutput$brandProfileArn": "The Amazon Resource Name (ARN) of the brand profile.
", "DeleteBrandProfileOutput$brandProfileArn": "The Amazon Resource Name (ARN) of the brand profile.
", "GetBrandProfileOutput$brandProfileArn": "The Amazon Resource Name (ARN) of the brand profile.
", "JobResource$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "ListTagsForResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "NotifyCodeConfiguration$notifyCodeConfigurationArn": "The Amazon Resource Name (ARN) of the notify code configuration.
", "TagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UpdateBrandProfileOutput$brandProfileArn": "The Amazon Resource Name (ARN) of the brand profile.
" } }, "AttachmentBody": { "base": "Attachment Body
", "refs": { "BrandProfileAttributeInput$attachmentBody": "The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.
" } }, "Blob": { "base": null, "refs": { "UpdateBrandProfileAttributeInput$attachmentBody": "The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.
" } }, "Boolean": { "base": null, "refs": { "BrandProfileInfo$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "CreateBrandProfileFromRegistrationInput$smartMatch": "Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
", "CreateBrandProfileInput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "CreateBrandProfileOutput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "CreateNotifyCodeConfigurationInput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "CreateRegistrationsFromBrandProfileInput$smartMatch": "Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
", "GetBrandProfileOutput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "NotifyCodeConfiguration$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "RegistrationAssociationSummary$smartMatchUsed": "Specifies whether smart matching was used to create the association.
", "UpdateBrandProfileFromRegistrationInput$smartMatch": "Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
", "UpdateBrandProfileInput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "UpdateBrandProfileOutput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "UpdateNotifyCodeConfigurationInput$deletionProtectionEnabled": "Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
", "UpdateRegistrationsFromBrandProfileInput$smartMatch": "Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
" } }, "BrandProfileAttributeCategory": { "base": "Category for the attribute. Validated against supported values at runtime (see FoodCourtConstants).
", "refs": { "BrandProfileAttributeInput$category": "The category of the attribute.
", "BrandProfileAttributeSummary$category": "The category of the attribute.
", "GetBrandProfileAttributeOutput$category": "The category of the attribute.
", "UpdateBrandProfileAttributeInput$category": "The category of the attribute.
", "UpdateBrandProfileAttributeOutput$category": "The category of the attribute.
" } }, "BrandProfileAttributeDescription": { "base": "Attribute description.
", "refs": { "BrandProfileAttributeInput$description": "A description of the attribute.
", "BrandProfileAttributeSummary$description": "A description of the attribute.
", "GetBrandProfileAttributeOutput$description": "A description of the attribute.
", "UpdateBrandProfileAttributeInput$description": "A description of the attribute.
", "UpdateBrandProfileAttributeOutput$description": "A description of the attribute.
" } }, "BrandProfileAttributeInput": { "base": "Specifies an attribute to create for a brand profile.
", "refs": { "BrandProfileAttributeInputList$member": null } }, "BrandProfileAttributeInputList": { "base": null, "refs": { "CreateBrandProfileAttributesInput$attributes": "The brand profile attributes.
" } }, "BrandProfileAttributeName": { "base": "Customer-provided attribute name (unique per brand profile). Alphanumeric, underscore, hyphen, and space only.
", "refs": { "BrandProfileAttributeInput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "BrandProfileAttributeOutput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "BrandProfileAttributeSummary$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "DeleteBrandProfileAttributeInput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "DeleteBrandProfileAttributeOutput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "GetBrandProfileAttributeInput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "GetBrandProfileAttributeOutput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "UpdateBrandProfileAttributeInput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
", "UpdateBrandProfileAttributeOutput$attributeName": "The name of the brand profile attribute. The name is unique within a brand profile.
" } }, "BrandProfileAttributeOutput": { "base": "Contains information about an attribute that was created for a brand profile.
", "refs": { "BrandProfileAttributeOutputList$member": null } }, "BrandProfileAttributeOutputList": { "base": null, "refs": { "CreateBrandProfileAttributesOutput$attributes": "The brand profile attributes.
" } }, "BrandProfileAttributeSummary": { "base": "Contains summary information about a brand profile attribute in a list response.
", "refs": { "BrandProfileAttributeSummaryList$member": null } }, "BrandProfileAttributeSummaryList": { "base": null, "refs": { "ListBrandProfileAttributesOutput$brandProfileAttributes": "The list of brand profile attributes.
" } }, "BrandProfileAttributeType": { "base": "Type of brand profile attribute. Drives whether a value is inline (TEXT) or referenced via a presigned media upload URL.
", "refs": { "BrandProfileAttributeInput$attributeType": "The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
", "BrandProfileAttributeOutput$attributeType": "The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
", "BrandProfileAttributeSummary$attributeType": "The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
", "GetBrandProfileAttributeOutput$attributeType": "The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
", "UpdateBrandProfileAttributeOutput$attributeType": "The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
" } }, "BrandProfileAttributeValue": { "base": "Attribute value for TEXT type.
", "refs": { "BrandProfileAttributeInput$attributeValue": "The text value for the attribute. This value applies to attributes of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the media through the attachment body instead.
", "GetBrandProfileAttributeOutput$attributeValue": "The text value of the attribute. This value applies to attributes of type TEXT.
", "UpdateBrandProfileAttributeInput$attributeValue": "The text value of the attribute. This value applies to attributes of type TEXT.
", "UpdateBrandProfileAttributeOutput$attributeValue": "The text value of the attribute. This value applies to attributes of type TEXT.
" } }, "BrandProfileIdOrArn": { "base": "System-generated brand profile identifier or full ARN. Accepts either a bare ID (e.g., "bp-abc12345678901234") or a full ARN (e.g., "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234"). SDKs handle percent-encoding of ARN characters in path parameters transparently.
", "refs": { "BrandProfileInfo$brandProfileId": "The unique identifier of the brand profile.
", "CreateBrandProfileAttributesInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "CreateBrandProfileOutput$brandProfileId": "The unique identifier of the brand profile.
", "CreateRegistrationsFromBrandProfileInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "DeleteBrandProfileAttributeInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "DeleteBrandProfileAttributeOutput$brandProfileId": "The unique identifier of the brand profile.
", "DeleteBrandProfileInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "DeleteBrandProfileOutput$brandProfileId": "The unique identifier of the brand profile.
", "GetBrandProfileAttributeInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "GetBrandProfileInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "GetBrandProfileOutput$brandProfileId": "The unique identifier of the brand profile.
", "Job$brandProfileId": "The brand profile that the job operates on. This value is absent for operations that create a brand profile.
", "JobSummary$brandProfileId": "The brand profile that the job operates on. This value is absent for operations that create a brand profile.
", "ListBrandProfileAttributesInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "ListJobsInput$brandProfileId": "Filters the results to jobs for the specified brand profile.
", "ListRegistrationsFromBrandProfileInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "UpdateBrandProfileAttributeInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "UpdateBrandProfileFromRegistrationInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "UpdateBrandProfileInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "UpdateBrandProfileOutput$brandProfileId": "The unique identifier of the brand profile.
", "UpdateRegistrationsFromBrandProfileInput$brandProfileId": "The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
" } }, "BrandProfileInfo": { "base": "Contains information about a brand profile.
", "refs": { "BrandProfileInfoList$member": null } }, "BrandProfileInfoList": { "base": null, "refs": { "ListBrandProfilesOutput$brandProfiles": "The list of brand profiles.
" } }, "BrandProfileName": { "base": "Customer-provided brand profile name. Alphanumeric, underscore, hyphen, and space only.
", "refs": { "BrandProfileInfo$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
", "CreateBrandProfileFromRegistrationInput$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
", "CreateBrandProfileInput$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
", "CreateBrandProfileOutput$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
", "GetBrandProfileOutput$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
", "UpdateBrandProfileInput$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
", "UpdateBrandProfileOutput$brandProfileName": "The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
" } }, "ChannelParameters": { "base": "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.
", "refs": { "CreateNotifyCodeConfigurationInput$channelParameters": "The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.
", "NotifyCodeConfiguration$channelParameters": "The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.
", "SendNotifyCodeVerificationInput$overrideChannelParameters": "The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.
" } }, "ClientToken": { "base": "Idempotency token for safe retries on Create operations.
", "refs": { "CreateBrandProfileAttributesInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
", "CreateBrandProfileFromRegistrationInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
", "CreateBrandProfileInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
", "CreateNotifyCodeConfigurationInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
", "CreateRegistrationsFromBrandProfileInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
", "UpdateBrandProfileFromRegistrationInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
", "UpdateRegistrationsFromBrandProfileInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
" } }, "CodeConfigurationParameters": { "base": "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.
", "refs": { "CreateNotifyCodeConfigurationInput$codeConfigurationParameters": "The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.
", "NotifyCodeConfiguration$codeConfigurationParameters": "The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.
", "SendNotifyCodeVerificationInput$overrideCodeConfigurationParameters": "The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.
" } }, "CodeLength": { "base": "OTP code length (4-8 characters).
", "refs": { "CodeConfigurationParameters$codeLength": "The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
", "UpdateCodeConfigurationParameters$codeLength": "The updated number of characters in the one-time passcode. Valid values range from 4 through 8. Omit this member to preserve the current value.
" } }, "CodeType": { "base": "OTP character alphabet used by a NotifyCodeConfiguration.
", "refs": { "CodeConfigurationParameters$codeType": "The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
", "UpdateCodeConfigurationParameters$codeType": "The updated character set used to generate the one-time passcode. Omit this member to preserve the current value.
" } }, "ConfigurationSetName": { "base": "Configuration set name used to control event delivery for the verification message.
", "refs": { "SendNotifyCodeVerificationInput$configurationSetName": "The name of the configuration set used to control how delivery events for the message are handled.
" } }, "ConflictException": { "base": "The request conflicts with the current state of the resource.
", "refs": {} }, "ContextKey": { "base": "Caller-supplied context propagated to delivery events for this verification.
", "refs": { "ContextMap$key": null } }, "ContextMap": { "base": "Caller-supplied context map propagated to delivery events for this verification.
", "refs": { "SendNotifyCodeVerificationInput$context": "A map of custom key and value pairs that are propagated to the delivery events for this verification.
" } }, "ContextValue": { "base": "Caller-supplied context value. Blank space is not allowed at the front or end.
", "refs": { "ContextMap$value": null } }, "CreateBrandProfileAttributesInput": { "base": null, "refs": {} }, "CreateBrandProfileAttributesOutput": { "base": null, "refs": {} }, "CreateBrandProfileFromRegistrationInput": { "base": null, "refs": {} }, "CreateBrandProfileFromRegistrationOutput": { "base": null, "refs": {} }, "CreateBrandProfileInput": { "base": null, "refs": {} }, "CreateBrandProfileOutput": { "base": null, "refs": {} }, "CreateNotifyCodeConfigurationInput": { "base": null, "refs": {} }, "CreateNotifyCodeConfigurationOutput": { "base": null, "refs": {} }, "CreateRegistrationsFromBrandProfileInput": { "base": null, "refs": {} }, "CreateRegistrationsFromBrandProfileOutput": { "base": null, "refs": {} }, "DeleteBrandProfileAttributeInput": { "base": null, "refs": {} }, "DeleteBrandProfileAttributeOutput": { "base": null, "refs": {} }, "DeleteBrandProfileInput": { "base": null, "refs": {} }, "DeleteBrandProfileOutput": { "base": null, "refs": {} }, "DeleteNotifyCodeConfigurationInput": { "base": null, "refs": {} }, "DeleteNotifyCodeConfigurationOutput": { "base": null, "refs": {} }, "DestinationCountryParameterKey": { "base": "Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
Country-specific OTP delivery parameters as a map of destination-country-parameter keys to values.
", "refs": { "TextParameters$destinationCountryParameters": "A map of country-specific parameters that control one-time passcode delivery.
" } }, "DestinationIdentity": { "base": "Recipient identifier. E.164 phone number for TEXT/VOICE, WhatsApp address for WHATSAPP.
", "refs": { "SendNotifyCodeVerificationInput$destinationIdentity": "The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
", "ValidateNotifyCodeVerificationInput$destinationIdentity": "The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
" } }, "GetBrandProfileAttributeInput": { "base": null, "refs": {} }, "GetBrandProfileAttributeOutput": { "base": null, "refs": {} }, "GetBrandProfileInput": { "base": null, "refs": {} }, "GetBrandProfileOutput": { "base": null, "refs": {} }, "GetJobInput": { "base": null, "refs": {} }, "GetNotifyCodeConfigurationInput": { "base": null, "refs": {} }, "GetNotifyCodeConfigurationOutput": { "base": null, "refs": {} }, "InlineTemplateBody": { "base": "Freeform OTP template body. Must contain at least one non-whitespace character.
", "refs": { "TextParameters$inlineTemplateBody": "The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
", "VoiceParameters$inlineTemplateBody": "The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
" } }, "Integer": { "base": null, "refs": { "CreateBrandProfileOutput$attributesCreated": "The number of default attributes that were created for the brand profile.
" } }, "InternalServerException": { "base": "An unexpected error occurred during the processing of the request.
", "refs": {} }, "Job": { "base": "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.
Machine-readable code identifying why a job failed.
", "refs": { "Job$errorCode": "A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
", "JobSummary$errorCode": "A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
" } }, "JobErrorMessage": { "base": "Human-readable description of why a job failed.
", "refs": { "Job$errorMessage": "A human-readable description of why the job failed. This value is present only when the job status is FAILED.
", "JobSummary$errorMessage": "A human-readable description of why the job failed. This value is present only when the job status is FAILED.
" } }, "JobId": { "base": "System-generated unique identifier for tracking async operations.
", "refs": { "GetJobInput$jobId": "The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
", "Job$jobId": "The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
", "JobResult$jobId": "The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
", "JobSummary$jobId": "The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
" } }, "JobOperationType": { "base": "The type of mutating operation that created the job.
", "refs": { "Job$operationType": "The type of mutating operation that created the job.
", "JobSummary$operationType": "The type of mutating operation that created the job.
", "ListJobsInput$operationType": "Filters the results to jobs of the specified operation type.
" } }, "JobResource": { "base": "Contains information about a resource that was created or updated by an asynchronous job.
", "refs": { "JobResourceList$member": null } }, "JobResourceId": { "base": "Identifier of a resource created or updated by a job (registration ID or brand profile ID). This is a distinct type from BrandProfileIdOrArn and RegistrationIdOrArn because:
The identifier of the resource that the job created or updated.
" } }, "JobResourceIdentifier": { "base": "Resource identifier echoed back in job results. Can be a registration type, registration ID, or other request-specific identifier.
", "refs": { "JobResult$resourceIdentifier": "The identifier from your request that this job is processing.
" } }, "JobResourceList": { "base": "List of job resources.
", "refs": { "Job$resources": "The resources that were created or updated by the job.
", "JobSummary$resources": "The resources that were created or updated by the job.
" } }, "JobResourceType": { "base": "Type of resource associated with a job.
", "refs": { "JobResource$resourceType": "The type of the resource that the job created or updated.
" } }, "JobResult": { "base": "Pairs an asynchronous job with the resource identifier from your request that the job processes.
", "refs": { "JobResults$member": null } }, "JobResults": { "base": "List of job results.
", "refs": { "CreateBrandProfileFromRegistrationOutput$results": "The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
", "CreateRegistrationsFromBrandProfileOutput$results": "The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
", "UpdateBrandProfileFromRegistrationOutput$results": "The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
", "UpdateRegistrationsFromBrandProfileOutput$results": "The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
" } }, "JobStatus": { "base": "Processing status of an async job.
", "refs": { "Job$status": "The current lifecycle status of the job.
", "JobSummary$status": "The current lifecycle status of the job.
", "ListJobsInput$status": "Filters the results to jobs that have the specified status.
" } }, "JobSummary": { "base": "Contains summary information about an asynchronous job in a list response.
", "refs": { "JobSummaryList$member": null } }, "JobSummaryList": { "base": null, "refs": { "ListJobsOutput$jobs": "The list of asynchronous jobs.
" } }, "LanguageCode": { "base": "BCP-47 language code for template rendering.
", "refs": { "VoiceParameters$languageCode": "The BCP 47 language code used to render the voice message.
", "WhatsAppParameters$languageCode": "The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
" } }, "ListBrandProfileAttributesInput": { "base": null, "refs": {} }, "ListBrandProfileAttributesOutput": { "base": null, "refs": {} }, "ListBrandProfilesInput": { "base": null, "refs": {} }, "ListBrandProfilesOutput": { "base": null, "refs": {} }, "ListJobsInput": { "base": null, "refs": {} }, "ListJobsOutput": { "base": null, "refs": {} }, "ListNotifyCodeConfigurationsInput": { "base": null, "refs": {} }, "ListNotifyCodeConfigurationsOutput": { "base": null, "refs": {} }, "ListRegistrationsFromBrandProfileInput": { "base": null, "refs": {} }, "ListRegistrationsFromBrandProfileOutput": { "base": null, "refs": {} }, "ListTagsForResourceInput": { "base": null, "refs": {} }, "ListTagsForResourceOutput": { "base": null, "refs": {} }, "Long": { "base": null, "refs": { "GetBrandProfileAttributeOutput$mediaSizeBytes": "The size of the attribute media, in bytes.
", "UpdateBrandProfileAttributeOutput$mediaSizeBytes": "The size of the attribute media, in bytes.
" } }, "MaxResults": { "base": "Maximum number of results to return on a paginated operation.
", "refs": { "ListBrandProfileAttributesInput$maxResults": "The maximum number of results to return per page.
", "ListBrandProfilesInput$maxResults": "The maximum number of results to return per page.
", "ListJobsInput$maxResults": "The maximum number of results to return per page.
", "ListNotifyCodeConfigurationsInput$maxResults": "The maximum number of results to return per page.
", "ListRegistrationsFromBrandProfileInput$maxResults": "The maximum number of results to return per page.
" } }, "MaxVerificationAttempts": { "base": "Maximum number of verification attempts allowed (1-5).
", "refs": { "CodeConfigurationParameters$maxAttempts": "The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
", "UpdateCodeConfigurationParameters$maxAttempts": "The updated maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. Omit this member to preserve the current value.
" } }, "MediaDownloadUrl": { "base": "Presigned S3 GET URL for downloading attribute media. Marked @sensitive because the URL carries a SigV4 signature that grants object-read for the expiry window (1 hour). Without this trait the value would land in generated SDK Debug output and from there into log retention.
A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.
", "GetBrandProfileAttributeOutput$mediaDownloadUrl": "A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.
" } }, "MessageId": { "base": "Service-generated message id for the OTP delivery message.
", "refs": { "SendNotifyCodeVerificationOutput$messageId": "The service-generated identifier for the message that delivers the one-time passcode.
" } }, "NextToken": { "base": "Opaque pagination token.
", "refs": { "ListBrandProfileAttributesInput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListBrandProfileAttributesOutput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListBrandProfilesInput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListBrandProfilesOutput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListJobsInput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListJobsOutput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListNotifyCodeConfigurationsInput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListNotifyCodeConfigurationsOutput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListRegistrationsFromBrandProfileInput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
", "ListRegistrationsFromBrandProfileOutput$nextToken": "The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
" } }, "NotifyChannel": { "base": "Channel used to deliver an OTP to the end user.
", "refs": { "SendNotifyCodeVerificationInput$channel": "The channel used to deliver the one-time passcode to the recipient.
" } }, "NotifyCodeConfiguration": { "base": "Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.
", "refs": { "CreateNotifyCodeConfigurationOutput$notifyCodeConfiguration": "The notify code configuration resource.
", "GetNotifyCodeConfigurationOutput$notifyCodeConfiguration": "The notify code configuration resource.
", "NotifyCodeConfigurationList$member": null, "UpdateNotifyCodeConfigurationOutput$notifyCodeConfiguration": "The notify code configuration resource.
" } }, "NotifyCodeConfigurationId": { "base": "Bare system-generated NotifyCodeConfiguration identifier (output-only). Always a bare id, never an ARN — the ARN is carried separately by NotifyCodeConfiguration$notifyCodeConfigurationArn. Identifiers are opaque tokens; clients must not assume a specific length or format.
The unique identifier of the notify code configuration.
" } }, "NotifyCodeConfigurationIdOrArn": { "base": "System-generated NotifyCodeConfiguration identifier or full ARN. Accepts either a bare id or a full ARN (e.g., "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/
The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "GetNotifyCodeConfigurationInput$notifyCodeConfigurationId": "The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).
", "SendNotifyCodeVerificationInput$notifyCodeConfiguration": "The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.
", "UpdateNotifyCodeConfigurationInput$notifyCodeConfigurationId": "The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).
" } }, "NotifyCodeConfigurationList": { "base": null, "refs": { "ListNotifyCodeConfigurationsOutput$notifyCodeConfigurations": "The list of notify code configurations.
" } }, "NotifyCodeConfigurationName": { "base": "Customer-provided NotifyCodeConfiguration display name. Alphanumeric, underscore, hyphen, and space only.
", "refs": { "CreateNotifyCodeConfigurationInput$notifyCodeConfigurationName": "The name of the notify code configuration.
", "NotifyCodeConfiguration$notifyCodeConfigurationName": "The name of the notify code configuration.
", "UpdateNotifyCodeConfigurationInput$notifyCodeConfigurationName": "The name of the notify code configuration.
" } }, "NotifyParameters": { "base": "The delivery parameters for the preapproved notify-template route over the SMS or voice channels.
", "refs": { "ChannelParameters$notify": "The parameters for the preapproved notify-template route over the SMS or voice channels.
" } }, "NotifyTemplateId": { "base": "Pre-approved SMS / Voice notify template identifier.
", "refs": { "NotifyParameters$notifyTemplateId": "The identifier of a preapproved notify template for the SMS or voice channels.
" } }, "OnAttributeConflict": { "base": "Strategy for merging registration data into brand profile attributes.
", "refs": { "UpdateBrandProfileFromRegistrationInput$onAttributeConflict": "Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.
", "UpdateRegistrationsFromBrandProfileInput$onAttributeConflict": "Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.
" } }, "OriginationIdentity": { "base": "Sender identifier. Phone number ARN, sender ID, or pool ARN owned by the caller's account.
", "refs": { "SendNotifyCodeVerificationInput$originationIdentity": "The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
" } }, "ReferenceId": { "base": "Caller-supplied reference id used to bind a Send to a subsequent Validate request.
", "refs": { "SendNotifyCodeVerificationInput$referenceId": "A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
", "ValidateNotifyCodeVerificationInput$referenceId": "The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.
" } }, "RegistrationAssociationSummary": { "base": "Contains summary information about a registration that is associated with a brand profile.
", "refs": { "RegistrationAssociationSummaryList$member": null } }, "RegistrationAssociationSummaryList": { "base": null, "refs": { "ListRegistrationsFromBrandProfileOutput$registrationAssociations": "The list of registrations that are associated with the brand profile.
" } }, "RegistrationId": { "base": "Bare registration identifier (output-only). Always a bare ID, never an ARN.
", "refs": { "RegistrationAssociationSummary$registrationId": "The identifier of the registration.
" } }, "RegistrationIdList": { "base": null, "refs": { "UpdateRegistrationsFromBrandProfileInput$registrationIds": "The identifiers of the registrations.
" } }, "RegistrationIdOrArn": { "base": "Registration identifier or ARN.
", "refs": { "CreateBrandProfileFromRegistrationInput$registrationId": "The identifier or Amazon Resource Name (ARN) of the registration to populate the brand profile from.
", "RegistrationIdList$member": null, "UpdateBrandProfileFromRegistrationInput$registrationId": "The identifier or Amazon Resource Name (ARN) of the registration to import attributes from.
" } }, "RegistrationType": { "base": "Registration type identifier (e.g., US_TOLL_FREE_REGISTRATION, SENDER_ID).
", "refs": { "RegistrationAssociationSummary$registrationType": "The type of the registration, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.
", "RegistrationTypeList$member": null } }, "RegistrationTypeList": { "base": null, "refs": { "CreateRegistrationsFromBrandProfileInput$registrationTypes": "The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.
" } }, "ResourceNotFoundException": { "base": "The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
", "refs": {} }, "SendNotifyCodeVerificationInput": { "base": null, "refs": {} }, "SendNotifyCodeVerificationOutput": { "base": null, "refs": {} }, "ServiceQuotaExceededException": { "base": "The request would exceed a service quota for your account.
", "refs": {} }, "Status": { "base": "Brand profile lifecycle status. Exposed on brand profile API responses (Get, List, Create, Update).
", "refs": { "BrandProfileInfo$status": "The current lifecycle status of the brand profile.
", "CreateBrandProfileOutput$status": "The current lifecycle status of the brand profile.
", "GetBrandProfileOutput$status": "The current lifecycle status of the brand profile.
", "UpdateBrandProfileOutput$status": "The current lifecycle status of the brand profile.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "ConflictException$resourceId": "The identifier of the resource that the request conflicts with.
", "ConflictException$resourceType": "The type of the resource that the request conflicts with.
", "GetBrandProfileAttributeOutput$mediaContentType": "The MIME content type of the attribute media.
", "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "The identifier of the resource that could not be found.
", "ResourceNotFoundException$resourceType": "The type of the resource that could not be found.
", "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "UpdateBrandProfileAttributeOutput$mediaContentType": "The MIME content type of the attribute media.
", "ValidationException$message": "A summary of the validation failure.
", "ValidationExceptionField$path": "A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.
", "ValidationExceptionField$message": "A detailed description of the validation failure.
" } }, "Tag": { "base": "Describes a tag as a key and value pair that you can associate with a resource.
", "refs": { "TagList$member": null, "TagResourceInputTagsList$member": null } }, "TagKey": { "base": "The key of the tag. Tag keys are case-sensitive and must be unique per resource.
", "refs": { "Tag$key": "The key of the tag.
", "UntagResourceInputTagKeysList$member": null } }, "TagList": { "base": null, "refs": { "CreateBrandProfileFromRegistrationInput$tags": "An array of key and value pair tags that are associated with the resource.
", "CreateBrandProfileInput$tags": "An array of key and value pair tags that are associated with the resource.
", "CreateNotifyCodeConfigurationInput$tags": "An array of key and value pair tags that are associated with the resource.
", "ListTagsForResourceOutput$tags": "An array of key and value pair tags that are associated with the resource.
" } }, "TagResourceInput": { "base": null, "refs": {} }, "TagResourceInputTagsList": { "base": null, "refs": { "TagResourceInput$tags": "An array of key and value pair tags that are associated with the resource.
" } }, "TagResourceOutput": { "base": null, "refs": {} }, "TagValue": { "base": "The value of the tag associated with the tag key. May be an empty string.
", "refs": { "Tag$value": "The value of the tag.
" } }, "TextParameters": { "base": "The delivery parameters for the text channel, which delivers over SMS or RCS.
", "refs": { "ChannelParameters$text": "The parameters for the text channel, which delivers over SMS or RCS.
" } }, "ThrottlingException": { "base": "The request was denied because it exceeded the allowed request rate.
", "refs": {} }, "Timestamp": { "base": null, "refs": { "BrandProfileAttributeSummary$createdAt": "The time when the resource was created, in Unix epoch time.
", "BrandProfileAttributeSummary$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "BrandProfileInfo$createdAt": "The time when the resource was created, in Unix epoch time.
", "BrandProfileInfo$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "CreateBrandProfileOutput$createdAt": "The time when the resource was created, in Unix epoch time.
", "CreateBrandProfileOutput$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "GetBrandProfileAttributeOutput$createdAt": "The time when the resource was created, in Unix epoch time.
", "GetBrandProfileAttributeOutput$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "GetBrandProfileOutput$createdAt": "The time when the resource was created, in Unix epoch time.
", "GetBrandProfileOutput$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "Job$createdAt": "The time when the resource was created, in Unix epoch time.
", "Job$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "JobSummary$createdAt": "The time when the resource was created, in Unix epoch time.
", "JobSummary$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "NotifyCodeConfiguration$createdAt": "The time when the resource was created, in Unix epoch time.
", "NotifyCodeConfiguration$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "RegistrationAssociationSummary$createdAt": "The time when the resource was created, in Unix epoch time.
", "UpdateBrandProfileAttributeOutput$createdAt": "The time when the resource was created, in Unix epoch time.
", "UpdateBrandProfileAttributeOutput$updatedAt": "The time when the resource was last updated, in Unix epoch time.
", "UpdateBrandProfileOutput$createdAt": "The time when the resource was created, in Unix epoch time.
", "UpdateBrandProfileOutput$updatedAt": "The time when the resource was last updated, in Unix epoch time.
" } }, "UntagResourceInput": { "base": null, "refs": {} }, "UntagResourceInputTagKeysList": { "base": null, "refs": { "UntagResourceInput$tagKeys": "The list of tag keys to remove from the resource.
" } }, "UntagResourceOutput": { "base": null, "refs": {} }, "UpdateBrandProfileAttributeInput": { "base": null, "refs": {} }, "UpdateBrandProfileAttributeOutput": { "base": null, "refs": {} }, "UpdateBrandProfileFromRegistrationInput": { "base": null, "refs": {} }, "UpdateBrandProfileFromRegistrationOutput": { "base": null, "refs": {} }, "UpdateBrandProfileInput": { "base": null, "refs": {} }, "UpdateBrandProfileOutput": { "base": null, "refs": {} }, "UpdateChannelParameters": { "base": "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.
", "refs": { "UpdateNotifyCodeConfigurationInput$channelParameters": "The updated channel-specific parameters used to render and deliver the one-time passcode. This is a loose, nested update: when you omit a channel, that channel's parameters remain unchanged. Within a supplied channel, an empty string on a string member, or an empty map on the destination-country parameters, clears the currently stored value, and absent members preserve the current value.
" } }, "UpdateCodeConfigurationParameters": { "base": "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.
", "refs": { "UpdateNotifyCodeConfigurationInput$codeConfigurationParameters": "The updated passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. When you omit a member, its current value is preserved.
" } }, "UpdateDestinationCountryParameters": { "base": "Loose variant of DestinationCountryParameters used only in UpdateNotifyCodeConfigurationInput. Accepts an empty map as the sentinel to clear the persisted attribute.
The updated map of country-specific parameters that control one-time passcode delivery. An empty map clears the previously stored value.
" } }, "UpdateInlineTemplateBody": { "base": "Loose variant of InlineTemplateBody used only in UpdateNotifyCodeConfigurationInput. Empty ("") is the clear sentinel; any non-empty value must satisfy the same character class as InlineTemplateBody (at least one non-whitespace character).
The updated freeform SMS or RCS template body. An empty string clears the previously stored value.
", "UpdateVoiceParameters$inlineTemplateBody": "The updated freeform voice template body. An empty string clears the previously stored value.
" } }, "UpdateLanguageCode": { "base": "Loose variant of LanguageCode used only in UpdateNotifyCodeConfigurationInput. Empty ("") is the clear sentinel; any non-empty value must satisfy the same character class as LanguageCode (2-35 non-whitespace characters — BCP-47 tag).
The updated BCP 47 language code. An empty string clears the previously stored value.
", "UpdateWhatsAppParameters$languageCode": "The updated BCP 47 language code. An empty string clears the previously stored value.
" } }, "UpdateNotifyCodeConfigurationInput": { "base": null, "refs": {} }, "UpdateNotifyCodeConfigurationOutput": { "base": null, "refs": {} }, "UpdateNotifyParameters": { "base": "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.
", "refs": { "UpdateChannelParameters$notify": "The notify-template-route parameters to update. Omit this member to leave them unchanged.
" } }, "UpdateNotifyTemplateId": { "base": "Loose variant of NotifyTemplateId used only in UpdateNotifyCodeConfigurationInput. Empty ("") is the clear sentinel; any non-empty value must satisfy the same character class as NotifyTemplateId ([A-Za-z0-9_-]).
The updated identifier of a preapproved notify template for the SMS or voice channels. An empty string clears the previously stored value.
" } }, "UpdateRegistrationsFromBrandProfileInput": { "base": null, "refs": {} }, "UpdateRegistrationsFromBrandProfileOutput": { "base": null, "refs": {} }, "UpdateTextParameters": { "base": "The updated delivery parameters for the text channel. Absent members preserve the current value, and the empty sentinel on a member clears it.
", "refs": { "UpdateChannelParameters$text": "The text-channel parameters to update. Omit this member to leave the text-channel parameters unchanged.
" } }, "UpdateVoiceId": { "base": "Loose variant of VoiceId used only in UpdateNotifyCodeConfigurationInput. Empty ("") is the clear sentinel; any non-empty value must satisfy the same character class as VoiceId ([A-Za-z0-9]).
The updated Amazon Polly voice ID. An empty string clears the previously stored value.
", "UpdateVoiceParameters$voiceId": "The updated Amazon Polly voice ID. An empty string clears the previously stored value.
" } }, "UpdateVoiceParameters": { "base": "The updated delivery parameters for the voice channel. Absent members preserve the current value, and the empty sentinel on a member clears it.
", "refs": { "UpdateChannelParameters$voice": "The voice-channel parameters to update. Omit this member to leave the voice-channel parameters unchanged.
" } }, "UpdateWhatsAppParameters": { "base": "The updated delivery parameters for the WhatsApp channel. Absent members preserve the current value, and the empty sentinel on a member clears it.
", "refs": { "UpdateChannelParameters$whatsApp": "The WhatsApp-channel parameters to update. Omit this member to leave the WhatsApp-channel parameters unchanged.
" } }, "UpdateWhatsAppTemplateName": { "base": "Loose variant of WhatsAppTemplateName used only in UpdateNotifyCodeConfigurationInput. Empty ("") is the clear sentinel; non-empty values are validated by the service (lowercase letters, numbers, underscores).
The updated name of the Meta-approved WhatsApp authentication template. An empty string clears the previously stored value.
" } }, "ValidateNotifyCodeVerificationInput": { "base": null, "refs": {} }, "ValidateNotifyCodeVerificationOutput": { "base": null, "refs": {} }, "ValidationException": { "base": "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.
", "refs": {} }, "ValidationExceptionField": { "base": "Describes one specific validation failure for an input member.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.
" } }, "ValidityPeriodMinutes": { "base": "OTP validity window in minutes (1-60).
", "refs": { "CodeConfigurationParameters$validityPeriodMinutes": "The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
", "UpdateCodeConfigurationParameters$validityPeriodMinutes": "The updated length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. Omit this member to preserve the current value.
" } }, "VerificationCode": { "base": "OTP code submitted by the end user for validation.
", "refs": { "ValidateNotifyCodeVerificationInput$code": "The one-time passcode that the recipient submitted for validation.
" } }, "VerificationId": { "base": "Service-generated verification id returned from SendNotifyCodeVerification.
", "refs": { "SendNotifyCodeVerificationOutput$verificationId": "The service-generated identifier for the verification.
" } }, "VerificationStatus": { "base": "Outcome of a ValidateNotifyCodeVerification request.
", "refs": { "ValidateNotifyCodeVerificationOutput$status": "The outcome of the validation attempt. VALID indicates that the submitted passcode matched an active verification. INVALID indicates that the passcode did not match, expired, or exceeded its attempt limit.
" } }, "VoiceId": { "base": "Amazon Polly voice id for the Voice channel.
", "refs": { "NotifyParameters$voiceId": "The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
", "VoiceParameters$voiceId": "The Amazon Polly voice ID used for the voice channel.
" } }, "VoiceMessageBodyTextType": { "base": "The format of the voice message body text.
", "refs": { "UpdateVoiceParameters$voiceMessageBodyTextType": "The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.
", "VoiceParameters$voiceMessageBodyTextType": "The format of the voice message body. Valid values are TEXT and SSML.
" } }, "VoiceParameters": { "base": "The delivery parameters for the voice channel.
", "refs": { "ChannelParameters$voice": "The parameters for the voice channel.
" } }, "WhatsAppParameters": { "base": "The delivery parameters for the WhatsApp channel.
", "refs": { "ChannelParameters$whatsApp": "The parameters for the WhatsApp channel.
" } }, "WhatsAppTemplateName": { "base": "Meta-approved WhatsApp authentication template name. Character-class rules (lowercase letters, numbers, underscores) are enforced by the service.
", "refs": { "WhatsAppParameters$whatsAppTemplateName": "The name of the Meta-approved WhatsApp authentication template.
" } } } }