{ "smithy": "2.0", "shapes": { "com.amazonaws.endusermessaging#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.endusermessaging#AmazonResourceName": { "type": "string", "traits": { "smithy.api#documentation": "Amazon Resource Name.", "smithy.api#length": { "min": 20, "max": 256 }, "smithy.api#pattern": "^arn:[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#AttachmentBody": { "type": "blob", "traits": { "smithy.api#documentation": "Attachment Body", "smithy.api#length": { "min": 1, "max": 5242880 }, "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#BrandProfileAttributeCategory": { "type": "string", "traits": { "smithy.api#documentation": "Category for the attribute. Validated against supported values at runtime (see FoodCourtConstants).", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.endusermessaging#BrandProfileAttributeDescription": { "type": "string", "traits": { "smithy.api#documentation": "Attribute description.", "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#BrandProfileAttributeInput": { "type": "structure", "members": { "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#required": {} } }, "attributeType": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeType", "traits": { "smithy.api#documentation": "

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

", "smithy.api#required": {} } }, "attributeValue": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeValue", "traits": { "smithy.api#documentation": "

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.

" } }, "attachmentBody": { "target": "com.amazonaws.endusermessaging#AttachmentBody", "traits": { "smithy.api#documentation": "

The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

" } }, "description": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeDescription", "traits": { "smithy.api#documentation": "

A description of the attribute.

" } }, "category": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeCategory", "traits": { "smithy.api#documentation": "

The category of the attribute.

" } } }, "traits": { "smithy.api#documentation": "

Specifies an attribute to create for a brand profile.

" } }, "com.amazonaws.endusermessaging#BrandProfileAttributeInputList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeInput" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#BrandProfileAttributeName": { "type": "string", "traits": { "smithy.api#documentation": "Customer-provided attribute name (unique per brand profile).\nAlphanumeric, underscore, hyphen, and space only.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_ -]*[A-Za-z0-9_-][A-Za-z0-9_ -]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#BrandProfileAttributeOutput": { "type": "structure", "members": { "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#required": {} } }, "attributeType": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeType", "traits": { "smithy.api#documentation": "

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

", "smithy.api#required": {} } }, "mediaDownloadUrl": { "target": "com.amazonaws.endusermessaging#MediaDownloadUrl", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about an attribute that was created for a brand profile.

" } }, "com.amazonaws.endusermessaging#BrandProfileAttributeOutputList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeOutput" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#BrandProfileAttributeSummary": { "type": "structure", "members": { "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#required": {} } }, "attributeType": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeType", "traits": { "smithy.api#documentation": "

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeDescription", "traits": { "smithy.api#documentation": "

A description of the attribute.

" } }, "category": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeCategory", "traits": { "smithy.api#documentation": "

The category of the attribute.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains summary information about a brand profile attribute in a list response.

" } }, "com.amazonaws.endusermessaging#BrandProfileAttributeSummaryList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.endusermessaging#BrandProfileAttributeType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } }, "IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMAGE" } }, "DOCUMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOCUMENT" } } }, "traits": { "smithy.api#documentation": "Type of brand profile attribute. Drives whether a value is inline (TEXT)\nor referenced via a presigned media upload URL." } }, "com.amazonaws.endusermessaging#BrandProfileAttributeValue": { "type": "string", "traits": { "smithy.api#documentation": "Attribute value for TEXT type.", "smithy.api#length": { "min": 0, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#BrandProfileIdOrArn": { "type": "string", "traits": { "smithy.api#documentation": "System-generated brand profile identifier or full ARN.\nAccepts either a bare ID (e.g., \"bp-abc12345678901234\") or a full ARN\n(e.g., \"arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234\").\nSDKs handle percent-encoding of ARN characters in path parameters transparently.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#BrandProfileInfo": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile.

", "smithy.api#required": {} } }, "brandProfileArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand profile.

", "smithy.api#required": {} } }, "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.endusermessaging#Status", "traits": { "smithy.api#documentation": "

The current lifecycle status of the brand profile.

", "smithy.api#required": {} } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about a brand profile.

" } }, "com.amazonaws.endusermessaging#BrandProfileInfoList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#BrandProfileInfo" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.endusermessaging#BrandProfileName": { "type": "string", "traits": { "smithy.api#documentation": "Customer-provided brand profile name. Alphanumeric, underscore, hyphen, and space only.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_ -]*[A-Za-z0-9_-][A-Za-z0-9_ -]*$" } }, "com.amazonaws.endusermessaging#ChannelParameters": { "type": "structure", "members": { "text": { "target": "com.amazonaws.endusermessaging#TextParameters", "traits": { "smithy.api#documentation": "

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

" } }, "voice": { "target": "com.amazonaws.endusermessaging#VoiceParameters", "traits": { "smithy.api#documentation": "

The parameters for the voice channel.

" } }, "notify": { "target": "com.amazonaws.endusermessaging#NotifyParameters", "traits": { "smithy.api#documentation": "

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

" } }, "whatsApp": { "target": "com.amazonaws.endusermessaging#WhatsAppParameters", "traits": { "smithy.api#documentation": "

The parameters for the WhatsApp channel.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.endusermessaging#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "Idempotency token for safe retries on Create operations.", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#CodeConfigurationParameters": { "type": "structure", "members": { "codeType": { "target": "com.amazonaws.endusermessaging#CodeType", "traits": { "smithy.api#documentation": "

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.

" } }, "codeLength": { "target": "com.amazonaws.endusermessaging#CodeLength", "traits": { "smithy.api#documentation": "

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.

" } }, "validityPeriodMinutes": { "target": "com.amazonaws.endusermessaging#ValidityPeriodMinutes", "traits": { "smithy.api#documentation": "

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.

" } }, "maxAttempts": { "target": "com.amazonaws.endusermessaging#MaxVerificationAttempts", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.endusermessaging#CodeLength": { "type": "integer", "traits": { "smithy.api#documentation": "OTP code length (4-8 characters).", "smithy.api#range": { "min": 4, "max": 8 } } }, "com.amazonaws.endusermessaging#CodeType": { "type": "enum", "members": { "NUMERIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Digits 0\u20139.", "smithy.api#enumValue": "NUMERIC" } }, "ALPHA": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Letters A\u2013Z (uppercase).", "smithy.api#enumValue": "ALPHA" } }, "ALPHANUMERIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Letters A\u2013Z and digits 0\u20139.", "smithy.api#enumValue": "ALPHANUMERIC" } } }, "traits": { "smithy.api#documentation": "OTP character alphabet used by a NotifyCodeConfiguration." } }, "com.amazonaws.endusermessaging#ConfigurationSetName": { "type": "string", "traits": { "smithy.api#documentation": "Configuration set name used to control event delivery for the verification message.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.endusermessaging#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the resource that the request conflicts with.

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the resource that the request conflicts with.

" } } }, "traits": { "smithy.api#documentation": "

The request conflicts with the current state of the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.endusermessaging#ContextKey": { "type": "string", "traits": { "smithy.api#documentation": "Caller-supplied context propagated to delivery events for this verification.", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^\\S+$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#ContextMap": { "type": "map", "key": { "target": "com.amazonaws.endusermessaging#ContextKey" }, "value": { "target": "com.amazonaws.endusermessaging#ContextValue" }, "traits": { "smithy.api#documentation": "Caller-supplied context map propagated to delivery events for this verification.", "smithy.api#length": { "max": 5 } } }, "com.amazonaws.endusermessaging#ContextValue": { "type": "string", "traits": { "smithy.api#documentation": "Caller-supplied context value. Blank space is not allowed at the front or end.", "smithy.api#length": { "min": 1, "max": 800 }, "smithy.api#pattern": "^\\S(?:[\\s\\S]*\\S)?$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#CreateBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#CreateBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#CreateBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Create a brand profile", "input": { "brandProfileName": "AcmeCorp", "deletionProtectionEnabled": true }, "output": { "brandProfileId": "bp-abc12345678901234", "brandProfileArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234", "brandProfileName": "AcmeCorp", "status": "ACTIVE", "deletionProtectionEnabled": true, "createdAt": 1727130000, "updatedAt": 1727130000, "attributesCreated": 0 } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/brand-profiles" } } }, "com.amazonaws.endusermessaging#CreateBrandProfileAttributes": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#CreateBrandProfileAttributesInput" }, "output": { "target": "com.amazonaws.endusermessaging#CreateBrandProfileAttributesOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create attributes for a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Create a text attribute on a brand profile", "input": { "brandProfileId": "bp-abc12345678901234", "attributes": [ { "attributeName": "SupportEmail", "attributeType": "TEXT", "attributeValue": "support@example.com", "category": "CONTACT" } ] }, "output": { "attributes": [ { "attributeName": "SupportEmail", "attributeType": "TEXT" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/brand-profiles/{brandProfileId}/attributes" } } }, "com.amazonaws.endusermessaging#CreateBrandProfileAttributesInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeInputList", "traits": { "smithy.api#documentation": "

The brand profile attributes.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#CreateBrandProfileAttributesOutput": { "type": "structure", "members": { "attributes": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeOutputList", "traits": { "smithy.api#documentation": "

The brand profile attributes.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#CreateBrandProfileFromRegistration": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#CreateBrandProfileFromRegistrationInput" }, "output": { "target": "com.amazonaws.endusermessaging#CreateBrandProfileFromRegistrationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a new brand profile populated from an existing registration via Bedrock mapping", "requiredActions": [] }, "smithy.api#documentation": "

Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

", "smithy.api#examples": [ { "title": "Create a brand profile from a registration", "input": { "registrationId": "reg-abc12345678901234", "brandProfileName": "AcmeCorp", "smartMatch": true }, "output": { "results": [ { "jobId": "job-abc12345678901234", "resourceIdentifier": "reg-abc12345678901234" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/brand-profiles/create-from-registration" } } }, "com.amazonaws.endusermessaging#CreateBrandProfileFromRegistrationInput": { "type": "structure", "members": { "registrationId": { "target": "com.amazonaws.endusermessaging#RegistrationIdOrArn", "traits": { "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) of the registration to populate the brand profile from.

", "smithy.api#required": {} } }, "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

", "smithy.api#required": {} } }, "smartMatch": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

" } }, "tags": { "target": "com.amazonaws.endusermessaging#TagList", "traits": { "smithy.api#documentation": "

An array of key and value pair tags that are associated with the resource.

" } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#CreateBrandProfileFromRegistrationOutput": { "type": "structure", "members": { "results": { "target": "com.amazonaws.endusermessaging#JobResults", "traits": { "smithy.api#documentation": "

The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#CreateBrandProfileInput": { "type": "structure", "members": { "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

" } }, "tags": { "target": "com.amazonaws.endusermessaging#TagList", "traits": { "smithy.api#documentation": "

An array of key and value pair tags that are associated with the resource.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#CreateBrandProfileOutput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile.

", "smithy.api#required": {} } }, "brandProfileArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand profile.

", "smithy.api#required": {} } }, "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.endusermessaging#Status", "traits": { "smithy.api#documentation": "

The current lifecycle status of the brand profile.

", "smithy.api#required": {} } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, "attributesCreated": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of default attributes that were created for the brand profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#CreateNotifyCodeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#CreateNotifyCodeConfigurationInput" }, "output": { "target": "com.amazonaws.endusermessaging#CreateNotifyCodeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a notify code configuration", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Create a notify code configuration", "input": { "notifyCodeConfigurationName": "SignupOtp", "codeConfigurationParameters": { "codeType": "NUMERIC", "codeLength": 6, "validityPeriodMinutes": 10, "maxAttempts": 3 }, "channelParameters": { "text": { "inlineTemplateBody": "Your verification code is {{code}}." } } }, "output": { "notifyCodeConfiguration": { "notifyCodeConfigurationId": "ncc-abc12345678901234", "notifyCodeConfigurationArn": "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234", "notifyCodeConfigurationName": "SignupOtp", "codeConfigurationParameters": { "codeType": "NUMERIC", "codeLength": 6, "validityPeriodMinutes": 10, "maxAttempts": 3 }, "channelParameters": { "text": { "inlineTemplateBody": "Your verification code is {{code}}." } }, "deletionProtectionEnabled": false, "createdAt": 1727130000, "updatedAt": 1727130000 } } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/notify-code-configurations" } } }, "com.amazonaws.endusermessaging#CreateNotifyCodeConfigurationInput": { "type": "structure", "members": { "notifyCodeConfigurationName": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationName", "traits": { "smithy.api#documentation": "

The name of the notify code configuration.

", "smithy.api#required": {} } }, "codeConfigurationParameters": { "target": "com.amazonaws.endusermessaging#CodeConfigurationParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "channelParameters": { "target": "com.amazonaws.endusermessaging#ChannelParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

" } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.endusermessaging#TagList", "traits": { "smithy.api#documentation": "

An array of key and value pair tags that are associated with the resource.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#CreateNotifyCodeConfigurationOutput": { "type": "structure", "members": { "notifyCodeConfiguration": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfiguration", "traits": { "smithy.api#documentation": "

The notify code configuration resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#CreateRegistrationsFromBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#CreateRegistrationsFromBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#CreateRegistrationsFromBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create DRAFT registrations pre-filled from brand profile attributes via Bedrock mapping", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Create draft registrations from a brand profile", "input": { "brandProfileId": "bp-abc12345678901234", "registrationTypes": [ "US_TOLL_FREE_REGISTRATION" ], "smartMatch": true }, "output": { "results": [ { "jobId": "job-abc12345678901234", "resourceIdentifier": "US_TOLL_FREE_REGISTRATION" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/brand-profiles/{brandProfileId}/create-registrations" } } }, "com.amazonaws.endusermessaging#CreateRegistrationsFromBrandProfileInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "registrationTypes": { "target": "com.amazonaws.endusermessaging#RegistrationTypeList", "traits": { "smithy.api#documentation": "

The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.

", "smithy.api#required": {} } }, "smartMatch": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

" } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#CreateRegistrationsFromBrandProfileOutput": { "type": "structure", "members": { "results": { "target": "com.amazonaws.endusermessaging#JobResults", "traits": { "smithy.api#documentation": "

The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#DeleteBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#DeleteBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#DeleteBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Delete a brand profile", "input": { "brandProfileId": "bp-abc12345678901234" }, "output": { "brandProfileId": "bp-abc12345678901234", "brandProfileArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/v1/brand-profiles/{brandProfileId+}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#DeleteBrandProfileAttribute": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#DeleteBrandProfileAttributeInput" }, "output": { "target": "com.amazonaws.endusermessaging#DeleteBrandProfileAttributeOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a brand profile attribute", "requiredActions": [] }, "smithy.api#documentation": "

Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.

", "smithy.api#examples": [ { "title": "Delete a brand profile attribute", "input": { "brandProfileId": "bp-abc12345678901234", "attributeName": "SupportEmail" }, "output": { "brandProfileId": "bp-abc12345678901234", "attributeName": "SupportEmail" } } ], "smithy.api#http": { "method": "DELETE", "uri": "/v1/brand-profiles/{brandProfileId}/attributes/{attributeName}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#DeleteBrandProfileAttributeInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#DeleteBrandProfileAttributeOutput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile.

", "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#DeleteBrandProfileInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#DeleteBrandProfileOutput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile.

", "smithy.api#required": {} } }, "brandProfileArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#DeleteNotifyCodeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#DeleteNotifyCodeConfigurationInput" }, "output": { "target": "com.amazonaws.endusermessaging#DeleteNotifyCodeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a notify code configuration", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Delete a notify code configuration", "input": { "notifyCodeConfigurationId": "ncc-abc12345678901234" }, "output": {} } ], "smithy.api#http": { "method": "DELETE", "uri": "/v1/notify-code-configurations/{notifyCodeConfigurationId+}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#DeleteNotifyCodeConfigurationInput": { "type": "structure", "members": { "notifyCodeConfigurationId": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#DeleteNotifyCodeConfigurationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#DestinationCountryParameterKey": { "type": "string", "traits": { "smithy.api#documentation": "Key of a `DestinationCountryParameters` map entry. Up to 64 non-whitespace characters.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.endusermessaging#DestinationCountryParameterValue": { "type": "string", "traits": { "smithy.api#documentation": "Value of a `DestinationCountryParameters` map entry. Up to 64 non-whitespace characters.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^\\S+$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#DestinationCountryParameters": { "type": "map", "key": { "target": "com.amazonaws.endusermessaging#DestinationCountryParameterKey" }, "value": { "target": "com.amazonaws.endusermessaging#DestinationCountryParameterValue" }, "traits": { "smithy.api#documentation": "Country-specific OTP delivery parameters as a map of destination-country-parameter keys to values.", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#DestinationIdentity": { "type": "string", "traits": { "smithy.api#documentation": "Recipient identifier. E.164 phone number for TEXT/VOICE, WhatsApp address for WHATSAPP.", "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^[\\x21-\\x22\\x24-\\x7E]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#EndUserMessaging": { "type": "service", "version": "2026-09-21", "operations": [ { "target": "com.amazonaws.endusermessaging#CreateBrandProfile" }, { "target": "com.amazonaws.endusermessaging#CreateBrandProfileAttributes" }, { "target": "com.amazonaws.endusermessaging#CreateBrandProfileFromRegistration" }, { "target": "com.amazonaws.endusermessaging#CreateNotifyCodeConfiguration" }, { "target": "com.amazonaws.endusermessaging#CreateRegistrationsFromBrandProfile" }, { "target": "com.amazonaws.endusermessaging#DeleteBrandProfile" }, { "target": "com.amazonaws.endusermessaging#DeleteBrandProfileAttribute" }, { "target": "com.amazonaws.endusermessaging#DeleteNotifyCodeConfiguration" }, { "target": "com.amazonaws.endusermessaging#GetBrandProfile" }, { "target": "com.amazonaws.endusermessaging#GetBrandProfileAttribute" }, { "target": "com.amazonaws.endusermessaging#GetJob" }, { "target": "com.amazonaws.endusermessaging#GetNotifyCodeConfiguration" }, { "target": "com.amazonaws.endusermessaging#ListBrandProfileAttributes" }, { "target": "com.amazonaws.endusermessaging#ListBrandProfiles" }, { "target": "com.amazonaws.endusermessaging#ListJobs" }, { "target": "com.amazonaws.endusermessaging#ListNotifyCodeConfigurations" }, { "target": "com.amazonaws.endusermessaging#ListRegistrationsFromBrandProfile" }, { "target": "com.amazonaws.endusermessaging#ListTagsForResource" }, { "target": "com.amazonaws.endusermessaging#SendNotifyCodeVerification" }, { "target": "com.amazonaws.endusermessaging#TagResource" }, { "target": "com.amazonaws.endusermessaging#UntagResource" }, { "target": "com.amazonaws.endusermessaging#UpdateBrandProfile" }, { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileAttribute" }, { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileFromRegistration" }, { "target": "com.amazonaws.endusermessaging#UpdateNotifyCodeConfiguration" }, { "target": "com.amazonaws.endusermessaging#UpdateRegistrationsFromBrandProfile" }, { "target": "com.amazonaws.endusermessaging#ValidateNotifyCodeVerification" } ], "traits": { "aws.api#service": { "sdkId": "EndUserMessaging", "arnNamespace": "end-user-messaging", "cloudTrailEventSource": "end-user-messaging.amazonaws.com", "endpointPrefix": "end-user-messaging" }, "aws.auth#sigv4": { "name": "end-user-messaging" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

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.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#title": "AWS End User Messaging", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://end-user-messaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://end-user-messaging-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://end-user-messaging.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://end-user-messaging.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://end-user-messaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://end-user-messaging-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://end-user-messaging.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://end-user-messaging.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://end-user-messaging.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://end-user-messaging.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://end-user-messaging.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://end-user-messaging.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.endusermessaging#GetBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#GetBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#GetBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Get a brand profile", "input": { "brandProfileId": "bp-abc12345678901234" }, "output": { "brandProfileId": "bp-abc12345678901234", "brandProfileArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234", "brandProfileName": "AcmeCorp", "status": "ACTIVE", "deletionProtectionEnabled": true, "createdAt": 1727130000, "updatedAt": 1727130000 } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/brand-profiles/{brandProfileId+}" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "BrandProfileActive": { "documentation": "Wait until a brand profile reaches the ACTIVE state.", "minDelay": 30, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "BLOCKED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CANCELLED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.endusermessaging#GetBrandProfileAttribute": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#GetBrandProfileAttributeInput" }, "output": { "target": "com.amazonaws.endusermessaging#GetBrandProfileAttributeOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a brand profile attribute", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a single brand profile attribute.

", "smithy.api#examples": [ { "title": "Get a brand profile attribute", "input": { "brandProfileId": "bp-abc12345678901234", "attributeName": "SupportEmail" }, "output": { "attributeName": "SupportEmail", "attributeType": "TEXT", "attributeValue": "support@example.com", "category": "CONTACT", "createdAt": 1727130000, "updatedAt": 1727130000 } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/brand-profiles/{brandProfileId}/attributes/{attributeName}" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#GetBrandProfileAttributeInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#GetBrandProfileAttributeOutput": { "type": "structure", "members": { "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#required": {} } }, "attributeType": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeType", "traits": { "smithy.api#documentation": "

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

", "smithy.api#required": {} } }, "attributeValue": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeValue", "traits": { "smithy.api#documentation": "

The text value of the attribute. This value applies to attributes of type TEXT.

" } }, "description": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeDescription", "traits": { "smithy.api#documentation": "

A description of the attribute.

" } }, "category": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeCategory", "traits": { "smithy.api#documentation": "

The category of the attribute.

" } }, "mediaContentType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The MIME content type of the attribute media.

" } }, "mediaSizeBytes": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The size of the attribute media, in bytes.

" } }, "mediaDownloadUrl": { "target": "com.amazonaws.endusermessaging#MediaDownloadUrl", "traits": { "smithy.api#documentation": "

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.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#GetBrandProfileInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#GetBrandProfileOutput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile.

", "smithy.api#required": {} } }, "brandProfileArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand profile.

", "smithy.api#required": {} } }, "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.endusermessaging#Status", "traits": { "smithy.api#documentation": "

The current lifecycle status of the brand profile.

", "smithy.api#required": {} } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#GetJob": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#GetJobInput" }, "output": { "target": "com.amazonaws.endusermessaging#Job" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get the details of an asynchronous job", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.

", "smithy.api#examples": [ { "title": "Get an async job", "input": { "jobId": "job-abc12345678901234" }, "output": { "jobId": "job-abc12345678901234", "status": "SUCCESS", "operationType": "CreateRegistrationsFromBrandProfile", "createdAt": 1727130000, "updatedAt": 1727130060, "brandProfileId": "bp-abc12345678901234", "resources": [ { "resourceType": "REGISTRATION", "resourceId": "reg-abc12345678901234", "resourceArn": "arn:aws:end-user-messaging:us-east-1:123456789012:registration/reg-abc12345678901234" } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/jobs/{jobId}" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "JobSuccess": { "documentation": "Wait until an async job reaches the SUCCESS terminal state.", "minDelay": 30, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "expected": "SUCCESS", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.endusermessaging#GetJobInput": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.endusermessaging#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#GetNotifyCodeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#GetNotifyCodeConfigurationInput" }, "output": { "target": "com.amazonaws.endusermessaging#GetNotifyCodeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a notify code configuration", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a notify code configuration.

", "smithy.api#examples": [ { "title": "Get a notify code configuration", "input": { "notifyCodeConfigurationId": "ncc-abc12345678901234" }, "output": { "notifyCodeConfiguration": { "notifyCodeConfigurationId": "ncc-abc12345678901234", "notifyCodeConfigurationArn": "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234", "notifyCodeConfigurationName": "SignupOtp", "codeConfigurationParameters": { "codeType": "NUMERIC", "codeLength": 6, "validityPeriodMinutes": 10, "maxAttempts": 3 }, "channelParameters": { "text": { "inlineTemplateBody": "Your verification code is {{code}}." } }, "deletionProtectionEnabled": false, "createdAt": 1727130000, "updatedAt": 1727130000 } } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/notify-code-configurations/{notifyCodeConfigurationId+}" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#GetNotifyCodeConfigurationInput": { "type": "structure", "members": { "notifyCodeConfigurationId": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#GetNotifyCodeConfigurationOutput": { "type": "structure", "members": { "notifyCodeConfiguration": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfiguration", "traits": { "smithy.api#documentation": "

The notify code configuration resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#InlineTemplateBody": { "type": "string", "traits": { "smithy.api#documentation": "Freeform OTP template body. Must contain at least one non-whitespace character.", "smithy.api#length": { "min": 1, "max": 6000 }, "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An unexpected error occurred during the processing of the request.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.endusermessaging#Job": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.endusermessaging#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.endusermessaging#JobStatus", "traits": { "smithy.api#documentation": "

The current lifecycle status of the job.

", "smithy.api#required": {} } }, "operationType": { "target": "com.amazonaws.endusermessaging#JobOperationType", "traits": { "smithy.api#documentation": "

The type of mutating operation that created the job.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The brand profile that the job operates on. This value is absent for operations that create a brand profile.

" } }, "errorCode": { "target": "com.amazonaws.endusermessaging#JobErrorCode", "traits": { "smithy.api#documentation": "

A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

" } }, "errorMessage": { "target": "com.amazonaws.endusermessaging#JobErrorMessage", "traits": { "smithy.api#documentation": "

A human-readable description of why the job failed. This value is present only when the job status is FAILED.

" } }, "resources": { "target": "com.amazonaws.endusermessaging#JobResourceList", "traits": { "smithy.api#documentation": "

The resources that were created or updated by the job.

" } } }, "traits": { "smithy.api#documentation": "Information about an async job tracked by the service. GetJob returns\nthe full `Job`, which may grow detail-only fields that are not part of\nthe `JobSummary` list view.", "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#JobErrorCode": { "type": "string", "traits": { "smithy.api#documentation": "Machine-readable code identifying why a job failed.", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.endusermessaging#JobErrorMessage": { "type": "string", "traits": { "smithy.api#documentation": "Human-readable description of why a job failed.", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.endusermessaging#JobId": { "type": "string", "traits": { "smithy.api#documentation": "System-generated unique identifier for tracking async operations.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.endusermessaging#JobOperationType": { "type": "string", "traits": { "smithy.api#documentation": "The type of mutating operation that created the job.", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.endusermessaging#JobResource": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.endusermessaging#JobResourceType", "traits": { "smithy.api#documentation": "

The type of the resource that the job created or updated.

", "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.endusermessaging#JobResourceId", "traits": { "smithy.api#documentation": "

The identifier of the resource that the job created or updated.

", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#JobResourceId": { "type": "string", "traits": { "smithy.api#documentation": "Identifier of a resource created or updated by a job (registration ID or brand profile ID).\nThis is a distinct type from BrandProfileIdOrArn and RegistrationIdOrArn because:\n1. It represents the *result* of a job, not an *input* identifier\n2. Jobs can produce different resource types, so this is intentionally generic\n3. Semantic clarity: callers see \"JobResourceId\" and understand it came from a job", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#JobResourceIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "Resource identifier echoed back in job results.\nCan be a registration type, registration ID, or other request-specific identifier.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.endusermessaging#JobResourceList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#JobResource" }, "traits": { "smithy.api#documentation": "List of job resources.", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#JobResourceType": { "type": "enum", "members": { "REGISTRATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REGISTRATION" } }, "BRAND_PROFILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BRAND_PROFILE" } } }, "traits": { "smithy.api#documentation": "Type of resource associated with a job." } }, "com.amazonaws.endusermessaging#JobResult": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.endusermessaging#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

", "smithy.api#required": {} } }, "resourceIdentifier": { "target": "com.amazonaws.endusermessaging#JobResourceIdentifier", "traits": { "smithy.api#documentation": "

The identifier from your request that this job is processing.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#JobResults": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#JobResult" }, "traits": { "smithy.api#documentation": "List of job results.", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#JobStatus": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "PROCESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROCESSING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "Processing status of an async job." } }, "com.amazonaws.endusermessaging#JobSummary": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.endusermessaging#JobId", "traits": { "smithy.api#documentation": "

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.endusermessaging#JobStatus", "traits": { "smithy.api#documentation": "

The current lifecycle status of the job.

", "smithy.api#required": {} } }, "operationType": { "target": "com.amazonaws.endusermessaging#JobOperationType", "traits": { "smithy.api#documentation": "

The type of mutating operation that created the job.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The brand profile that the job operates on. This value is absent for operations that create a brand profile.

" } }, "errorCode": { "target": "com.amazonaws.endusermessaging#JobErrorCode", "traits": { "smithy.api#documentation": "

A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

" } }, "errorMessage": { "target": "com.amazonaws.endusermessaging#JobErrorMessage", "traits": { "smithy.api#documentation": "

A human-readable description of why the job failed. This value is present only when the job status is FAILED.

" } }, "resources": { "target": "com.amazonaws.endusermessaging#JobResourceList", "traits": { "smithy.api#documentation": "

The resources that were created or updated by the job.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#JobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#JobSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.endusermessaging#LanguageCode": { "type": "string", "traits": { "smithy.api#documentation": "BCP-47 language code for template rendering.", "smithy.api#length": { "min": 2, "max": 35 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.endusermessaging#ListBrandProfileAttributes": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ListBrandProfileAttributesInput" }, "output": { "target": "com.amazonaws.endusermessaging#ListBrandProfileAttributesOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the attributes for a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a paginated list of the attributes for a brand profile.

", "smithy.api#examples": [ { "title": "List brand profile attributes", "input": { "brandProfileId": "bp-abc12345678901234", "maxResults": 10 }, "output": { "brandProfileAttributes": [ { "attributeName": "SupportEmail", "attributeType": "TEXT", "category": "CONTACT", "createdAt": 1727130000, "updatedAt": 1727130000 } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/brand-profiles/{brandProfileId}/attributes" }, "smithy.api#paginated": { "items": "brandProfileAttributes" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#ListBrandProfileAttributesInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.endusermessaging#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ListBrandProfileAttributesOutput": { "type": "structure", "members": { "brandProfileAttributes": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeSummaryList", "traits": { "smithy.api#documentation": "

The list of brand profile attributes.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ListBrandProfiles": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ListBrandProfilesInput" }, "output": { "target": "com.amazonaws.endusermessaging#ListBrandProfilesOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list brand profiles", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.

", "smithy.api#examples": [ { "title": "List brand profiles", "input": { "maxResults": 10 }, "output": { "brandProfiles": [ { "brandProfileId": "bp-abc12345678901234", "brandProfileArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234", "brandProfileName": "AcmeCorp", "status": "ACTIVE", "deletionProtectionEnabled": true, "createdAt": 1727130000, "updatedAt": 1727130000 } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/brand-profiles" }, "smithy.api#paginated": { "items": "brandProfiles" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListBrandProfilesSmokeTest", "params": {}, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.endusermessaging#ListBrandProfilesInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.endusermessaging#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ListBrandProfilesOutput": { "type": "structure", "members": { "brandProfiles": { "target": "com.amazonaws.endusermessaging#BrandProfileInfoList", "traits": { "smithy.api#documentation": "

The list of brand profiles.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ListJobs": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ListJobsInput" }, "output": { "target": "com.amazonaws.endusermessaging#ListJobsOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list asynchronous jobs in your account", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.

", "smithy.api#examples": [ { "title": "List async jobs", "input": { "maxResults": 10, "status": "SUCCESS" }, "output": { "jobs": [ { "jobId": "job-abc12345678901234", "status": "SUCCESS", "operationType": "CreateRegistrationsFromBrandProfile", "createdAt": 1727130000, "updatedAt": 1727130060, "brandProfileId": "bp-abc12345678901234" } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/jobs" }, "smithy.api#paginated": { "items": "jobs" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#ListJobsInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.endusermessaging#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.endusermessaging#JobStatus", "traits": { "smithy.api#documentation": "

Filters the results to jobs that have the specified status.

", "smithy.api#httpQuery": "status" } }, "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

Filters the results to jobs for the specified brand profile.

", "smithy.api#httpQuery": "brandProfileId" } }, "operationType": { "target": "com.amazonaws.endusermessaging#JobOperationType", "traits": { "smithy.api#documentation": "

Filters the results to jobs of the specified operation type.

", "smithy.api#httpQuery": "operationType" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ListJobsOutput": { "type": "structure", "members": { "jobs": { "target": "com.amazonaws.endusermessaging#JobSummaryList", "traits": { "smithy.api#documentation": "

The list of asynchronous jobs.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ListNotifyCodeConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ListNotifyCodeConfigurationsInput" }, "output": { "target": "com.amazonaws.endusermessaging#ListNotifyCodeConfigurationsOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list notify code configurations", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a paginated list of the notify code configurations in your account.

", "smithy.api#examples": [ { "title": "List notify code configurations", "input": { "maxResults": 10 }, "output": { "notifyCodeConfigurations": [ { "notifyCodeConfigurationId": "ncc-abc12345678901234", "notifyCodeConfigurationArn": "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234", "notifyCodeConfigurationName": "SignupOtp", "codeConfigurationParameters": { "codeType": "NUMERIC", "codeLength": 6, "validityPeriodMinutes": 10, "maxAttempts": 3 }, "channelParameters": { "text": { "inlineTemplateBody": "Your verification code is {{code}}." } }, "deletionProtectionEnabled": false, "createdAt": 1727130000, "updatedAt": 1727130000 } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/notify-code-configurations" }, "smithy.api#paginated": { "items": "notifyCodeConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#ListNotifyCodeConfigurationsInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.endusermessaging#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ListNotifyCodeConfigurationsOutput": { "type": "structure", "members": { "notifyCodeConfigurations": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationList", "traits": { "smithy.api#documentation": "

The list of notify code configurations.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ListRegistrationsFromBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ListRegistrationsFromBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#ListRegistrationsFromBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the registrations created from a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.

", "smithy.api#examples": [ { "title": "List registrations created from a brand profile", "input": { "brandProfileId": "bp-abc12345678901234", "maxResults": 10 }, "output": { "registrationAssociations": [ { "registrationId": "reg-abc12345678901234", "registrationType": "US_TOLL_FREE_REGISTRATION", "createdAt": 1727130000, "smartMatchUsed": true } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/brand-profiles/{brandProfileId}/registrations" }, "smithy.api#paginated": { "items": "registrationAssociations" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#ListRegistrationsFromBrandProfileInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.endusermessaging#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ListRegistrationsFromBrandProfileOutput": { "type": "structure", "members": { "registrationAssociations": { "target": "com.amazonaws.endusermessaging#RegistrationAssociationSummaryList", "traits": { "smithy.api#documentation": "

The list of registrations that are associated with the brand profile.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.endusermessaging#NextToken", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.endusermessaging#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list tags for a resource", "requiredActions": [] }, "smithy.api#documentation": "

Retrieves the tags that are associated with a resource.

", "smithy.api#examples": [ { "title": "List tags on a resource", "input": { "resourceArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234" }, "output": { "tags": [ { "key": "Environment", "value": "Production" } ] } } ], "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.endusermessaging#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.endusermessaging#TagList", "traits": { "smithy.api#documentation": "

An array of key and value pair tags that are associated with the resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "Maximum number of results to return on a paginated operation.", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.endusermessaging#MaxVerificationAttempts": { "type": "integer", "traits": { "smithy.api#documentation": "Maximum number of verification attempts allowed (1-5).", "smithy.api#range": { "min": 1, "max": 5 } } }, "com.amazonaws.endusermessaging#MediaDownloadUrl": { "type": "string", "traits": { "smithy.api#documentation": "Presigned S3 GET URL for downloading attribute media. Marked `@sensitive`\nbecause the URL carries a SigV4 signature that grants object-read for the\nexpiry window (1 hour). Without this trait the value would land in\ngenerated SDK `Debug` output and from there into log retention.", "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#MessageId": { "type": "string", "traits": { "smithy.api#documentation": "Service-generated message id for the OTP delivery message.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "Opaque pagination token.", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.endusermessaging#NotifyChannel": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "SMS / text message.", "smithy.api#enumValue": "TEXT" } }, "VOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Voice call.", "smithy.api#enumValue": "VOICE" } }, "WHATSAPP": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "WhatsApp authentication template.", "smithy.api#enumValue": "WHATSAPP" } } }, "traits": { "smithy.api#documentation": "Channel used to deliver an OTP to the end user." } }, "com.amazonaws.endusermessaging#NotifyCodeConfiguration": { "type": "structure", "members": { "notifyCodeConfigurationId": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationId", "traits": { "smithy.api#documentation": "

The unique identifier of the notify code configuration.

", "smithy.api#required": {} } }, "notifyCodeConfigurationArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notify code configuration.

", "smithy.api#required": {} } }, "notifyCodeConfigurationName": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationName", "traits": { "smithy.api#documentation": "

The name of the notify code configuration.

", "smithy.api#required": {} } }, "codeConfigurationParameters": { "target": "com.amazonaws.endusermessaging#CodeConfigurationParameters", "traits": { "smithy.api#documentation": "

The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.

" } }, "channelParameters": { "target": "com.amazonaws.endusermessaging#ChannelParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#NotifyCodeConfigurationId": { "type": "string", "traits": { "smithy.api#documentation": "Bare system-generated NotifyCodeConfiguration identifier (output-only).\nAlways a bare id, never an ARN \u2014 the ARN is carried separately by\n`NotifyCodeConfiguration$notifyCodeConfigurationArn`. Identifiers are\nopaque tokens; clients must not assume a specific length or format.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.endusermessaging#NotifyCodeConfigurationIdOrArn": { "type": "string", "traits": { "smithy.api#documentation": "System-generated NotifyCodeConfiguration identifier or full ARN.\nAccepts either a bare id or a full ARN (e.g.,\n\"arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/\").\nIdentifiers are opaque tokens; clients must not assume a specific length\nor format. SDKs handle percent-encoding of ARN characters in path\nparameters transparently.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#NotifyCodeConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfiguration" } }, "com.amazonaws.endusermessaging#NotifyCodeConfigurationName": { "type": "string", "traits": { "smithy.api#documentation": "Customer-provided NotifyCodeConfiguration display name.\nAlphanumeric, underscore, hyphen, and space only.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_ -]*[A-Za-z0-9_-][A-Za-z0-9_ -]*$" } }, "com.amazonaws.endusermessaging#NotifyParameters": { "type": "structure", "members": { "notifyTemplateId": { "target": "com.amazonaws.endusermessaging#NotifyTemplateId", "traits": { "smithy.api#documentation": "

The identifier of a preapproved notify template for the SMS or voice channels.

" } }, "voiceId": { "target": "com.amazonaws.endusermessaging#VoiceId", "traits": { "smithy.api#documentation": "

The Amazon Polly voice ID used when the notify template is delivered over the voice channel.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#NotifyTemplateId": { "type": "string", "traits": { "smithy.api#documentation": "Pre-approved SMS / Voice notify template identifier.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.endusermessaging#OnAttributeConflict": { "type": "enum", "members": { "REPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "New registration value replaces the existing attribute value (default).", "smithy.api#enumValue": "REPLACE" } }, "PRESERVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Existing attribute value is kept; the registration value is ignored.", "smithy.api#enumValue": "PRESERVE" } } }, "traits": { "smithy.api#documentation": "Strategy for merging registration data into brand profile attributes." } }, "com.amazonaws.endusermessaging#OriginationIdentity": { "type": "string", "traits": { "smithy.api#documentation": "Sender identifier. Phone number ARN, sender ID, or pool ARN owned by the caller's account.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_:/+-]+$" } }, "com.amazonaws.endusermessaging#ReferenceId": { "type": "string", "traits": { "smithy.api#documentation": "Caller-supplied reference id used to bind a Send to a subsequent Validate request.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.endusermessaging#RegistrationAssociationSummary": { "type": "structure", "members": { "registrationId": { "target": "com.amazonaws.endusermessaging#RegistrationId", "traits": { "smithy.api#documentation": "

The identifier of the registration.

", "smithy.api#required": {} } }, "registrationType": { "target": "com.amazonaws.endusermessaging#RegistrationType", "traits": { "smithy.api#documentation": "

The type of the registration, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "smartMatchUsed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether smart matching was used to create the association.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#RegistrationAssociationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#RegistrationAssociationSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.endusermessaging#RegistrationId": { "type": "string", "traits": { "smithy.api#documentation": "Bare registration identifier (output-only). Always a bare ID, never an ARN.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.endusermessaging#RegistrationIdList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#RegistrationIdOrArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#RegistrationIdOrArn": { "type": "string", "traits": { "smithy.api#documentation": "Registration identifier or ARN.", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#RegistrationType": { "type": "string", "traits": { "smithy.api#documentation": "Registration type identifier (e.g., US_TOLL_FREE_REGISTRATION, SENDER_ID).", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_]+$" } }, "com.amazonaws.endusermessaging#RegistrationTypeList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#RegistrationType" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.endusermessaging#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the resource that could not be found.

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the resource that could not be found.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.endusermessaging#SendNotifyCodeVerification": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#SendNotifyCodeVerificationInput" }, "output": { "target": "com.amazonaws.endusermessaging#SendNotifyCodeVerificationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to send a notify code verification", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Send a one-time passcode over SMS", "input": { "channel": "TEXT", "destinationIdentity": "+14255550100", "originationIdentity": "arn:aws:sms-voice:us-east-1:123456789012:phone-number/pn-abc123", "notifyCodeConfiguration": "ncc-abc12345678901234", "referenceId": "signup-flow-42" }, "output": { "verificationId": "ver-abc12345678901234", "messageId": "msg-abc12345678901234" } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/notify-code-verifications/send" } } }, "com.amazonaws.endusermessaging#SendNotifyCodeVerificationInput": { "type": "structure", "members": { "channel": { "target": "com.amazonaws.endusermessaging#NotifyChannel", "traits": { "smithy.api#documentation": "

The channel used to deliver the one-time passcode to the recipient.

", "smithy.api#required": {} } }, "destinationIdentity": { "target": "com.amazonaws.endusermessaging#DestinationIdentity", "traits": { "smithy.api#documentation": "

The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

", "smithy.api#required": {} } }, "originationIdentity": { "target": "com.amazonaws.endusermessaging#OriginationIdentity", "traits": { "smithy.api#documentation": "

The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

", "smithy.api#required": {} } }, "notifyCodeConfiguration": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationIdOrArn", "traits": { "smithy.api#documentation": "

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.

" } }, "overrideChannelParameters": { "target": "com.amazonaws.endusermessaging#ChannelParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "overrideCodeConfigurationParameters": { "target": "com.amazonaws.endusermessaging#CodeConfigurationParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "configurationSetName": { "target": "com.amazonaws.endusermessaging#ConfigurationSetName", "traits": { "smithy.api#documentation": "

The name of the configuration set used to control how delivery events for the message are handled.

" } }, "context": { "target": "com.amazonaws.endusermessaging#ContextMap", "traits": { "smithy.api#documentation": "

A map of custom key and value pairs that are propagated to the delivery events for this verification.

" } }, "referenceId": { "target": "com.amazonaws.endusermessaging#ReferenceId", "traits": { "smithy.api#documentation": "

A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#SendNotifyCodeVerificationOutput": { "type": "structure", "members": { "verificationId": { "target": "com.amazonaws.endusermessaging#VerificationId", "traits": { "smithy.api#documentation": "

The service-generated identifier for the verification.

", "smithy.api#required": {} } }, "messageId": { "target": "com.amazonaws.endusermessaging#MessageId", "traits": { "smithy.api#documentation": "

The service-generated identifier for the message that delivers the one-time passcode.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request would exceed a service quota for your account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.endusermessaging#Status": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "BLOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCKED" } }, "PAUSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSED" } }, "CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELLED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "Brand profile lifecycle status.\nExposed on brand profile API responses (Get, List, Create, Update)." } }, "com.amazonaws.endusermessaging#Tag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.endusermessaging#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.endusermessaging#TagValue", "traits": { "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "The key of the tag. Tag keys are case-sensitive and must be unique per resource.", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.endusermessaging#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#TagKey" } }, "com.amazonaws.endusermessaging#TagList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.endusermessaging#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#TagResourceInput" }, "output": { "target": "com.amazonaws.endusermessaging#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ServiceQuotaExceededException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to tag a resource", "requiredActions": [] }, "smithy.api#documentation": "

Adds or overwrites the tags on a resource.

", "smithy.api#examples": [ { "title": "Tag a resource", "input": { "resourceArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234", "tags": [ { "key": "Environment", "value": "Production" } ] }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/v1/tags/{resourceArn}" } } }, "com.amazonaws.endusermessaging#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.endusermessaging#TagList", "traits": { "smithy.api#documentation": "

An array of key and value pair tags that are associated with the resource.

", "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#TagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#TagValue": { "type": "string", "traits": { "smithy.api#documentation": "The value of the tag associated with the tag key. May be an empty string.", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^.*$" } }, "com.amazonaws.endusermessaging#TextParameters": { "type": "structure", "members": { "inlineTemplateBody": { "target": "com.amazonaws.endusermessaging#InlineTemplateBody", "traits": { "smithy.api#documentation": "

The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.

" } }, "destinationCountryParameters": { "target": "com.amazonaws.endusermessaging#DestinationCountryParameters", "traits": { "smithy.api#documentation": "

A map of country-specific parameters that control one-time passcode delivery.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.endusermessaging#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#UntagResourceInput" }, "output": { "target": "com.amazonaws.endusermessaging#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to untag a resource", "requiredActions": [] }, "smithy.api#documentation": "

Removes the specified tags from a resource.

", "smithy.api#examples": [ { "title": "Remove tags from a resource", "input": { "resourceArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234", "tagKeys": [ "Environment" ] }, "output": {} } ], "smithy.api#http": { "method": "DELETE", "uri": "/v1/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.endusermessaging#TagKeyList", "traits": { "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#UntagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Update a brand profile name", "input": { "brandProfileId": "bp-abc12345678901234", "brandProfileName": "AcmeCorpUpdated", "deletionProtectionEnabled": false }, "output": { "brandProfileId": "bp-abc12345678901234", "brandProfileArn": "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234", "brandProfileName": "AcmeCorpUpdated", "status": "ACTIVE", "deletionProtectionEnabled": false, "createdAt": 1727130000, "updatedAt": 1727216400 } } ], "smithy.api#http": { "method": "PUT", "uri": "/v1/brand-profiles/{brandProfileId+}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileAttribute": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileAttributeInput" }, "output": { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileAttributeOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a brand profile attribute", "requiredActions": [] }, "smithy.api#documentation": "

Updates the value, description, or category of an existing brand profile attribute.

", "smithy.api#examples": [ { "title": "Update a brand profile attribute value", "input": { "brandProfileId": "bp-abc12345678901234", "attributeName": "SupportEmail", "attributeValue": "help@example.com", "category": "CONTACT" }, "output": { "attributeName": "SupportEmail", "attributeType": "TEXT", "attributeValue": "help@example.com", "category": "CONTACT", "createdAt": 1727130000, "updatedAt": 1727216400 } } ], "smithy.api#http": { "method": "PUT", "uri": "/v1/brand-profiles/{brandProfileId}/attributes/{attributeName}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileAttributeInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributeValue": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeValue", "traits": { "smithy.api#documentation": "

The text value of the attribute. This value applies to attributes of type TEXT.

" } }, "attachmentBody": { "target": "smithy.api#Blob", "traits": { "smithy.api#documentation": "

The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

" } }, "description": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeDescription", "traits": { "smithy.api#documentation": "

A description of the attribute.

" } }, "category": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeCategory", "traits": { "smithy.api#documentation": "

The category of the attribute.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileAttributeOutput": { "type": "structure", "members": { "attributeName": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeName", "traits": { "smithy.api#documentation": "

The name of the brand profile attribute. The name is unique within a brand profile.

", "smithy.api#required": {} } }, "attributeType": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeType", "traits": { "smithy.api#documentation": "

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

", "smithy.api#required": {} } }, "attributeValue": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeValue", "traits": { "smithy.api#documentation": "

The text value of the attribute. This value applies to attributes of type TEXT.

" } }, "description": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeDescription", "traits": { "smithy.api#documentation": "

A description of the attribute.

" } }, "category": { "target": "com.amazonaws.endusermessaging#BrandProfileAttributeCategory", "traits": { "smithy.api#documentation": "

The category of the attribute.

" } }, "mediaContentType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The MIME content type of the attribute media.

" } }, "mediaSizeBytes": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The size of the attribute media, in bytes.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileFromRegistration": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileFromRegistrationInput" }, "output": { "target": "com.amazonaws.endusermessaging#UpdateBrandProfileFromRegistrationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a brand profile from a registration", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Update a brand profile from a registration", "input": { "brandProfileId": "bp-abc12345678901234", "registrationId": "reg-abc12345678901234", "smartMatch": true, "onAttributeConflict": "REPLACE" }, "output": { "results": [ { "jobId": "job-abc12345678901234", "resourceIdentifier": "reg-abc12345678901234" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/brand-profiles/{brandProfileId}/update-from-registration" } } }, "com.amazonaws.endusermessaging#UpdateBrandProfileFromRegistrationInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "registrationId": { "target": "com.amazonaws.endusermessaging#RegistrationIdOrArn", "traits": { "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) of the registration to import attributes from.

", "smithy.api#required": {} } }, "smartMatch": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

" } }, "onAttributeConflict": { "target": "com.amazonaws.endusermessaging#OnAttributeConflict", "traits": { "smithy.api#documentation": "

Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.

" } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileFromRegistrationOutput": { "type": "structure", "members": { "results": { "target": "com.amazonaws.endusermessaging#JobResults", "traits": { "smithy.api#documentation": "

The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

" } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#UpdateBrandProfileOutput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile.

", "smithy.api#required": {} } }, "brandProfileArn": { "target": "com.amazonaws.endusermessaging#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the brand profile.

", "smithy.api#required": {} } }, "brandProfileName": { "target": "com.amazonaws.endusermessaging#BrandProfileName", "traits": { "smithy.api#documentation": "

The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.endusermessaging#Status", "traits": { "smithy.api#documentation": "

The current lifecycle status of the brand profile.

", "smithy.api#required": {} } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was created, in Unix epoch time.

", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time when the resource was last updated, in Unix epoch time.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#UpdateChannelParameters": { "type": "structure", "members": { "text": { "target": "com.amazonaws.endusermessaging#UpdateTextParameters", "traits": { "smithy.api#documentation": "

The text-channel parameters to update. Omit this member to leave the text-channel parameters unchanged.

" } }, "voice": { "target": "com.amazonaws.endusermessaging#UpdateVoiceParameters", "traits": { "smithy.api#documentation": "

The voice-channel parameters to update. Omit this member to leave the voice-channel parameters unchanged.

" } }, "notify": { "target": "com.amazonaws.endusermessaging#UpdateNotifyParameters", "traits": { "smithy.api#documentation": "

The notify-template-route parameters to update. Omit this member to leave them unchanged.

" } }, "whatsApp": { "target": "com.amazonaws.endusermessaging#UpdateWhatsAppParameters", "traits": { "smithy.api#documentation": "

The WhatsApp-channel parameters to update. Omit this member to leave the WhatsApp-channel parameters unchanged.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.endusermessaging#UpdateCodeConfigurationParameters": { "type": "structure", "members": { "codeType": { "target": "com.amazonaws.endusermessaging#CodeType", "traits": { "smithy.api#documentation": "

The updated character set used to generate the one-time passcode. Omit this member to preserve the current value.

" } }, "codeLength": { "target": "com.amazonaws.endusermessaging#CodeLength", "traits": { "smithy.api#documentation": "

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.

" } }, "validityPeriodMinutes": { "target": "com.amazonaws.endusermessaging#ValidityPeriodMinutes", "traits": { "smithy.api#documentation": "

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.

" } }, "maxAttempts": { "target": "com.amazonaws.endusermessaging#MaxVerificationAttempts", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.endusermessaging#UpdateDestinationCountryParameters": { "type": "map", "key": { "target": "com.amazonaws.endusermessaging#DestinationCountryParameterKey" }, "value": { "target": "com.amazonaws.endusermessaging#DestinationCountryParameterValue" }, "traits": { "smithy.api#documentation": "Loose variant of `DestinationCountryParameters` used only in `UpdateNotifyCodeConfigurationInput`.\nAccepts an empty map as the sentinel to clear the persisted attribute.", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.endusermessaging#UpdateInlineTemplateBody": { "type": "string", "traits": { "smithy.api#documentation": "Loose variant of `InlineTemplateBody` used only in `UpdateNotifyCodeConfigurationInput`.\nEmpty (`\"\"`) is the clear sentinel; any non-empty value must satisfy the same character\nclass as `InlineTemplateBody` (at least one non-whitespace character).", "smithy.api#length": { "min": 0, "max": 6000 }, "smithy.api#pattern": "^([\\s\\S]*\\S[\\s\\S]*)?$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#UpdateLanguageCode": { "type": "string", "traits": { "smithy.api#documentation": "Loose variant of `LanguageCode` used only in `UpdateNotifyCodeConfigurationInput`.\nEmpty (`\"\"`) is the clear sentinel; any non-empty value must satisfy the same character\nclass as `LanguageCode` (2-35 non-whitespace characters \u2014 BCP-47 tag).", "smithy.api#length": { "min": 0, "max": 35 }, "smithy.api#pattern": "^(\\S{2,35})?$" } }, "com.amazonaws.endusermessaging#UpdateNotifyCodeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#UpdateNotifyCodeConfigurationInput" }, "output": { "target": "com.amazonaws.endusermessaging#UpdateNotifyCodeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a notify code configuration", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Update a notify code configuration", "input": { "notifyCodeConfigurationId": "ncc-abc12345678901234", "codeConfigurationParameters": { "codeLength": 8, "validityPeriodMinutes": 15 } }, "output": { "notifyCodeConfiguration": { "notifyCodeConfigurationId": "ncc-abc12345678901234", "notifyCodeConfigurationArn": "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234", "notifyCodeConfigurationName": "SignupOtp", "codeConfigurationParameters": { "codeType": "NUMERIC", "codeLength": 8, "validityPeriodMinutes": 15, "maxAttempts": 3 }, "channelParameters": { "text": { "inlineTemplateBody": "Your verification code is {{code}}." } }, "deletionProtectionEnabled": false, "createdAt": 1727130000, "updatedAt": 1727216400 } } } ], "smithy.api#http": { "method": "PUT", "uri": "/v1/notify-code-configurations/{notifyCodeConfigurationId+}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.endusermessaging#UpdateNotifyCodeConfigurationInput": { "type": "structure", "members": { "notifyCodeConfigurationId": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "notifyCodeConfigurationName": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfigurationName", "traits": { "smithy.api#documentation": "

The name of the notify code configuration.

" } }, "codeConfigurationParameters": { "target": "com.amazonaws.endusermessaging#UpdateCodeConfigurationParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "channelParameters": { "target": "com.amazonaws.endusermessaging#UpdateChannelParameters", "traits": { "smithy.api#documentation": "

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.

" } }, "deletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#UpdateNotifyCodeConfigurationOutput": { "type": "structure", "members": { "notifyCodeConfiguration": { "target": "com.amazonaws.endusermessaging#NotifyCodeConfiguration", "traits": { "smithy.api#documentation": "

The notify code configuration resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#UpdateNotifyParameters": { "type": "structure", "members": { "notifyTemplateId": { "target": "com.amazonaws.endusermessaging#UpdateNotifyTemplateId", "traits": { "smithy.api#documentation": "

The updated identifier of a preapproved notify template for the SMS or voice channels. An empty string clears the previously stored value.

" } }, "voiceId": { "target": "com.amazonaws.endusermessaging#UpdateVoiceId", "traits": { "smithy.api#documentation": "

The updated Amazon Polly voice ID. An empty string clears the previously stored value.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.endusermessaging#UpdateNotifyTemplateId": { "type": "string", "traits": { "smithy.api#documentation": "Loose variant of `NotifyTemplateId` used only in `UpdateNotifyCodeConfigurationInput`.\nEmpty (`\"\"`) is the clear sentinel; any non-empty value must satisfy the same character\nclass as `NotifyTemplateId` (`[A-Za-z0-9_-]`).", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_-]*$" } }, "com.amazonaws.endusermessaging#UpdateRegistrationsFromBrandProfile": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#UpdateRegistrationsFromBrandProfileInput" }, "output": { "target": "com.amazonaws.endusermessaging#UpdateRegistrationsFromBrandProfileOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#ConflictException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update registrations from a brand profile", "requiredActions": [] }, "smithy.api#documentation": "

Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.

", "smithy.api#examples": [ { "title": "Update registrations from a brand profile", "input": { "brandProfileId": "bp-abc12345678901234", "registrationIds": [ "reg-abc12345678901234" ], "smartMatch": true, "onAttributeConflict": "PRESERVE" }, "output": { "results": [ { "jobId": "job-abc12345678901234", "resourceIdentifier": "reg-abc12345678901234" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/brand-profiles/{brandProfileId}/update-registrations" } } }, "com.amazonaws.endusermessaging#UpdateRegistrationsFromBrandProfileInput": { "type": "structure", "members": { "brandProfileId": { "target": "com.amazonaws.endusermessaging#BrandProfileIdOrArn", "traits": { "smithy.api#documentation": "

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "registrationIds": { "target": "com.amazonaws.endusermessaging#RegistrationIdList", "traits": { "smithy.api#documentation": "

The identifiers of the registrations.

", "smithy.api#required": {} } }, "smartMatch": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

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.

" } }, "onAttributeConflict": { "target": "com.amazonaws.endusermessaging#OnAttributeConflict", "traits": { "smithy.api#documentation": "

Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.

" } }, "clientToken": { "target": "com.amazonaws.endusermessaging#ClientToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#UpdateRegistrationsFromBrandProfileOutput": { "type": "structure", "members": { "results": { "target": "com.amazonaws.endusermessaging#JobResults", "traits": { "smithy.api#documentation": "

The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#UpdateTextParameters": { "type": "structure", "members": { "inlineTemplateBody": { "target": "com.amazonaws.endusermessaging#UpdateInlineTemplateBody", "traits": { "smithy.api#documentation": "

The updated freeform SMS or RCS template body. An empty string clears the previously stored value.

" } }, "destinationCountryParameters": { "target": "com.amazonaws.endusermessaging#UpdateDestinationCountryParameters", "traits": { "smithy.api#documentation": "

The updated map of country-specific parameters that control one-time passcode delivery. An empty map clears the previously stored value.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#UpdateVoiceId": { "type": "string", "traits": { "smithy.api#documentation": "Loose variant of `VoiceId` used only in `UpdateNotifyCodeConfigurationInput`.\nEmpty (`\"\"`) is the clear sentinel; any non-empty value must satisfy the same character\nclass as `VoiceId` (`[A-Za-z0-9]`).", "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9]*$" } }, "com.amazonaws.endusermessaging#UpdateVoiceParameters": { "type": "structure", "members": { "inlineTemplateBody": { "target": "com.amazonaws.endusermessaging#UpdateInlineTemplateBody", "traits": { "smithy.api#documentation": "

The updated freeform voice template body. An empty string clears the previously stored value.

" } }, "languageCode": { "target": "com.amazonaws.endusermessaging#UpdateLanguageCode", "traits": { "smithy.api#documentation": "

The updated BCP 47 language code. An empty string clears the previously stored value.

" } }, "voiceId": { "target": "com.amazonaws.endusermessaging#UpdateVoiceId", "traits": { "smithy.api#documentation": "

The updated Amazon Polly voice ID. An empty string clears the previously stored value.

" } }, "voiceMessageBodyTextType": { "target": "com.amazonaws.endusermessaging#VoiceMessageBodyTextType", "traits": { "smithy.api#documentation": "

The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#UpdateWhatsAppParameters": { "type": "structure", "members": { "whatsAppTemplateName": { "target": "com.amazonaws.endusermessaging#UpdateWhatsAppTemplateName", "traits": { "smithy.api#documentation": "

The updated name of the Meta-approved WhatsApp authentication template. An empty string clears the previously stored value.

" } }, "languageCode": { "target": "com.amazonaws.endusermessaging#UpdateLanguageCode", "traits": { "smithy.api#documentation": "

The updated BCP 47 language code. An empty string clears the previously stored value.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.endusermessaging#UpdateWhatsAppTemplateName": { "type": "string", "traits": { "smithy.api#documentation": "Loose variant of `WhatsAppTemplateName` used only in `UpdateNotifyCodeConfigurationInput`.\nEmpty (`\"\"`) is the clear sentinel; non-empty values are validated by the service\n(lowercase letters, numbers, underscores).", "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^\\S*$" } }, "com.amazonaws.endusermessaging#ValidateNotifyCodeVerification": { "type": "operation", "input": { "target": "com.amazonaws.endusermessaging#ValidateNotifyCodeVerificationInput" }, "output": { "target": "com.amazonaws.endusermessaging#ValidateNotifyCodeVerificationOutput" }, "errors": [ { "target": "com.amazonaws.endusermessaging#AccessDeniedException" }, { "target": "com.amazonaws.endusermessaging#InternalServerException" }, { "target": "com.amazonaws.endusermessaging#ThrottlingException" }, { "target": "com.amazonaws.endusermessaging#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to validate a notify code verification", "requiredActions": [] }, "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Validate a submitted one-time passcode", "input": { "destinationIdentity": "+14255550100", "referenceId": "signup-flow-42", "code": "123456" }, "output": { "status": "VALID" } } ], "smithy.api#http": { "method": "POST", "uri": "/v1/notify-code-verifications/validate" } } }, "com.amazonaws.endusermessaging#ValidateNotifyCodeVerificationInput": { "type": "structure", "members": { "destinationIdentity": { "target": "com.amazonaws.endusermessaging#DestinationIdentity", "traits": { "smithy.api#documentation": "

The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

", "smithy.api#required": {} } }, "referenceId": { "target": "com.amazonaws.endusermessaging#ReferenceId", "traits": { "smithy.api#documentation": "

The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.

" } }, "code": { "target": "com.amazonaws.endusermessaging#VerificationCode", "traits": { "smithy.api#documentation": "

The one-time passcode that the recipient submitted for validation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.endusermessaging#ValidateNotifyCodeVerificationOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.endusermessaging#VerificationStatus", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.endusermessaging#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A summary of the validation failure.", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.endusermessaging#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "A list of specific failures encountered while validating the input.\nA member can appear in this list more than once if it failed to satisfy multiple constraints." } } }, "traits": { "smithy.api#documentation": "A standard error for input validation failures.\nThis should be thrown by services when a member of the input structure\nfalls outside of the modeled or documented constraints.", "smithy.api#error": "client" } }, "com.amazonaws.endusermessaging#ValidationExceptionField": { "type": "structure", "members": { "path": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A detailed description of the validation failure.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes one specific validation failure for an input member." } }, "com.amazonaws.endusermessaging#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.endusermessaging#ValidationExceptionField" } }, "com.amazonaws.endusermessaging#ValidityPeriodMinutes": { "type": "integer", "traits": { "smithy.api#documentation": "OTP validity window in minutes (1-60).", "smithy.api#range": { "min": 1, "max": 60 } } }, "com.amazonaws.endusermessaging#VerificationCode": { "type": "string", "traits": { "smithy.api#documentation": "OTP code submitted by the end user for validation.", "smithy.api#length": { "min": 4, "max": 8 }, "smithy.api#pattern": "^[A-Za-z0-9]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.endusermessaging#VerificationId": { "type": "string", "traits": { "smithy.api#documentation": "Service-generated verification id returned from SendNotifyCodeVerification.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, "com.amazonaws.endusermessaging#VerificationStatus": { "type": "enum", "members": { "VALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The submitted code matches an active verification within its validity window.", "smithy.api#enumValue": "VALID" } }, "INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The submitted code does not match, has expired, or has exceeded its attempt limit.", "smithy.api#enumValue": "INVALID" } } }, "traits": { "smithy.api#documentation": "Outcome of a ValidateNotifyCodeVerification request." } }, "com.amazonaws.endusermessaging#VoiceId": { "type": "string", "traits": { "smithy.api#documentation": "Amazon Polly voice id for the Voice channel.", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9]+$" } }, "com.amazonaws.endusermessaging#VoiceMessageBodyTextType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } }, "SSML": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SSML" } } }, "traits": { "smithy.api#documentation": "The format of the voice message body text." } }, "com.amazonaws.endusermessaging#VoiceParameters": { "type": "structure", "members": { "inlineTemplateBody": { "target": "com.amazonaws.endusermessaging#InlineTemplateBody", "traits": { "smithy.api#documentation": "

The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.

" } }, "languageCode": { "target": "com.amazonaws.endusermessaging#LanguageCode", "traits": { "smithy.api#documentation": "

The BCP 47 language code used to render the voice message.

" } }, "voiceId": { "target": "com.amazonaws.endusermessaging#VoiceId", "traits": { "smithy.api#documentation": "

The Amazon Polly voice ID used for the voice channel.

" } }, "voiceMessageBodyTextType": { "target": "com.amazonaws.endusermessaging#VoiceMessageBodyTextType", "traits": { "smithy.api#documentation": "

The format of the voice message body. Valid values are TEXT and SSML.

" } } }, "traits": { "smithy.api#documentation": "

The delivery parameters for the voice channel.

" } }, "com.amazonaws.endusermessaging#WhatsAppParameters": { "type": "structure", "members": { "whatsAppTemplateName": { "target": "com.amazonaws.endusermessaging#WhatsAppTemplateName", "traits": { "smithy.api#documentation": "

The name of the Meta-approved WhatsApp authentication template.

" } }, "languageCode": { "target": "com.amazonaws.endusermessaging#LanguageCode", "traits": { "smithy.api#documentation": "

The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.

" } } }, "traits": { "smithy.api#documentation": "

The delivery parameters for the WhatsApp channel.

" } }, "com.amazonaws.endusermessaging#WhatsAppTemplateName": { "type": "string", "traits": { "smithy.api#documentation": "Meta-approved WhatsApp authentication template name. Character-class rules\n(lowercase letters, numbers, underscores) are enforced by the service.", "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^\\S+$" } } } }