{ "smithy": "2.0", "shapes": { "com.amazonaws.socialmessaging#AccessDeniedByMetaException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.socialmessaging#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.socialmessaging#AddContactNumber": { "type": "boolean" }, "com.amazonaws.socialmessaging#AddLearnMoreLink": { "type": "boolean" }, "com.amazonaws.socialmessaging#AddSecurityRecommendation": { "type": "boolean" }, "com.amazonaws.socialmessaging#AddTrackPackageLink": { "type": "boolean" }, "com.amazonaws.socialmessaging#Arn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.socialmessaging#AssociateInProgressToken": { "type": "string", "traits": { "smithy.api#length": { "max": 50 }, "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccount": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountInput" }, "output": { "target": "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#LimitExceededException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/signup", "code": 200 } } }, "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountInput": { "type": "structure", "members": { "signupCallback": { "target": "com.amazonaws.socialmessaging#WhatsAppSignupCallback", "traits": { "smithy.api#documentation": "Contains the callback access token.
" } }, "setupFinalization": { "target": "com.amazonaws.socialmessaging#WhatsAppSetupFinalization", "traits": { "smithy.api#documentation": "A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountOutput": { "type": "structure", "members": { "signupCallbackResult": { "target": "com.amazonaws.socialmessaging#WhatsAppSignupCallbackResult", "traits": { "smithy.api#documentation": "Contains your WhatsApp registration status.
" } }, "statusCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The status code for the response.
" } }, "linkedWhatsAppBusinessAccountId": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account that was linked to your Amazon Web Services account.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#BusinessPublicKeyPem": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 } } }, "com.amazonaws.socialmessaging#BusinessPublicKeySignatureStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#ButtonType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.socialmessaging#CodeExpirationMinutes": { "type": "integer" }, "com.amazonaws.socialmessaging#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.socialmessaging#CreateWhatsAppDataset": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppDatasetInput" }, "output": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppDatasetOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Creates a Meta Conversions API dataset for a WhatsApp Business Account.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/waba/dataset", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppDatasetInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account to create a dataset for, formatted as waba-01234567890123456789012345678901.
The Meta-generated dataset ID, a numeric string of 10 to 20 digits.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppFlow": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppFlowInput" }, "output": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppFlowOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences\n that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If publish\n is set to true and a valid flowJson is provided, the Flow is published immediately.
The ID of the WhatsApp Business Account to associate with this Flow.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowName": { "target": "com.amazonaws.socialmessaging#MetaFlowName", "traits": { "smithy.api#documentation": "The name of the Flow. Must be unique within the WhatsApp Business Account.
", "smithy.api#required": {} } }, "categories": { "target": "com.amazonaws.socialmessaging#MetaFlowCategoryList", "traits": { "smithy.api#documentation": "The categories that classify the business purpose of the Flow. At least one category is required.
", "smithy.api#required": {} } }, "flowJson": { "target": "com.amazonaws.socialmessaging#MetaFlowJsonBlob", "traits": { "smithy.api#documentation": "The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.
" } }, "publish": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Set to true to publish the Flow immediately after creation. Requires a valid flowJson that passes Meta's validation.
The ID of an existing Flow within the same WhatsApp Business Account to clone.
" } }, "endpointUri": { "target": "com.amazonaws.socialmessaging#MetaFlowEndpointUri", "traits": { "smithy.api#documentation": "The HTTPS endpoint that Meta calls for a data exchange Flow.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppFlowOutput": { "type": "structure", "members": { "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier assigned to the Flow by Meta.
" } }, "validationErrors": { "target": "com.amazonaws.socialmessaging#ValidationErrorList", "traits": { "smithy.api#documentation": "A list of validation errors returned by Meta, if any. Validation errors must be resolved before the Flow can be published.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplate": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateInput" }, "output": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Creates a new WhatsApp message template from a custom definition.
\nAmazon Web Services End User Messaging Social does not store any WhatsApp message template content.
\nCreates a new WhatsApp message template using a template from Meta's template library.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/template/create", "code": 200 } } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibraryInput": { "type": "structure", "members": { "metaLibraryTemplate": { "target": "com.amazonaws.socialmessaging#MetaLibraryTemplate", "traits": { "smithy.api#documentation": "The template configuration from Meta's library, including customizations for buttons and body text.
", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account to associate with this template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibraryOutput": { "type": "structure", "members": { "metaTemplateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The numeric ID assigned to the template by Meta.
" } }, "templateStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The status of the created template (for example, PENDING or APPROVED).
" } }, "category": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The category of the template (for example, UTILITY or MARKETING).
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateInput": { "type": "structure", "members": { "templateDefinition": { "target": "com.amazonaws.socialmessaging#MetaTemplateDefinition", "traits": { "smithy.api#documentation": "The complete template definition as a JSON blob.
", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account to associate with this template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMedia": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaInput" }, "output": { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Uploads media for use in a WhatsApp message template.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/template/media", "code": 200 } } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this media upload.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "sourceS3File": { "target": "com.amazonaws.socialmessaging#S3File" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaOutput": { "type": "structure", "members": { "metaHeaderHandle": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The handle assigned to the uploaded media by Meta, used to reference the media in templates.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateOutput": { "type": "structure", "members": { "metaTemplateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The numeric ID assigned to the template by Meta.
" } }, "templateStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The status of the created template, such as PENDING or APPROVED..
" } }, "category": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The category of the template, such as UTILITY or MARKETING.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#DeleteAllLanguages": { "type": "boolean" }, "com.amazonaws.socialmessaging#DeleteWhatsAppFlow": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppFlowInput" }, "output": { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppFlowOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/whatsapp/flow", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppFlowInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow to delete.
", "smithy.api#httpQuery": "flowId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppFlowOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMedia": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput" }, "output": { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/whatsapp/media", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput": { "type": "structure", "members": { "mediaId": { "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", "traits": { "smithy.api#documentation": "The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.
The unique identifier of the originating phone number associated with the media. Phone\n number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.
Success indicator for deleting the media file.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplate": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateInput" }, "output": { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Deletes a WhatsApp message template.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/whatsapp/template", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateInput": { "type": "structure", "members": { "metaTemplateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The numeric ID of the template assigned by Meta.
", "smithy.api#httpQuery": "metaTemplateId" } }, "deleteAllLanguages": { "target": "com.amazonaws.socialmessaging#DeleteAllLanguages", "traits": { "smithy.api#documentation": "If true, deletes all language versions of the template.
", "smithy.api#httpQuery": "deleteAllTemplates" } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this template.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "templateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name of the template to delete.
", "smithy.api#httpQuery": "templateName", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#DependencyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Thrown when performing an action because a dependency would be broken.
", "smithy.api#error": "server", "smithy.api#httpError": 502, "smithy.api#retryable": {} } }, "com.amazonaws.socialmessaging#DeprecateWhatsAppFlow": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#DeprecateWhatsAppFlowInput" }, "output": { "target": "com.amazonaws.socialmessaging#DeprecateWhatsAppFlowOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Deprecates a published WhatsApp Flow, marking it as no longer recommended for use. The Flow must be in PUBLISHED status. This is an irreversible operation.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/flow/deprecate", "code": 200 } } }, "com.amazonaws.socialmessaging#DeprecateWhatsAppFlowInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow to deprecate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#DeprecateWhatsAppFlowOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#DirectSendEnforcementStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "com.amazonaws.socialmessaging#DirectSendEnforcementStatusExpiresAt": { "type": "timestamp" }, "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccount": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput" }, "output": { "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/whatsapp/waba/disassociate", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as\n waba-01234567890123456789012345678901. Use\n ListLinkedWhatsAppBusinessAccounts to list all WABAs \n and their details.
Get the details of your linked WhatsApp Business Account.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/waba/details", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The unique identifier, from Amazon Web Services, of the linked WhatsApp Business\n Account. WABA identifiers are formatted as\n waba-01234567890123456789012345678901. Use\n ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
The details of the linked WhatsApp Business Account.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/waba/phone/details", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the phone number. Phone number\n identifiers are formatted as phone-number-id-01234567890123456789012345678901.\n Use GetLinkedWhatsAppBusinessAccount \n to find a phone number's id.
The WABA identifier linked to the phone number, formatted as\n waba-01234567890123456789012345678901.
The calling settings configured for the phone number. This value is absent when calling is not configured.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppBusinessPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetWhatsAppBusinessPublicKeyInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetWhatsAppBusinessPublicKeyOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#AccessDeniedException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Retrieves the business public key for a phone number and its signature status.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/business-public-key", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppBusinessPublicKeyInput": { "type": "structure", "members": { "originationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the phone number whose business public key to retrieve.
", "smithy.api#httpQuery": "originationPhoneNumberId", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppBusinessPublicKeyOutput": { "type": "structure", "members": { "businessPublicKey": { "target": "com.amazonaws.socialmessaging#BusinessPublicKeyPem", "traits": { "smithy.api#documentation": "The stored PEM-encoded 2048-bit RSA public key.
" } }, "businessPublicKeySignatureStatus": { "target": "com.amazonaws.socialmessaging#BusinessPublicKeySignatureStatus", "traits": { "smithy.api#documentation": "The signature status of the stored business public key. Valid values are VALID and MISMATCH.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppCallPermission": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetWhatsAppCallPermissionInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetWhatsAppCallPermissionOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Retrieves the current calling permission for a WhatsApp end user, along with the calling actions the business is allowed to take with that user. Provide the destination phone number or the business-scoped user ID to identify the end user.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/call/permission/get", "code": 200 } } }, "com.amazonaws.socialmessaging#GetWhatsAppCallPermissionInput": { "type": "structure", "members": { "originationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the business phone number for which to retrieve the calling permission. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The end user's phone number, in E.164 format, for which to retrieve the calling permission.
" } }, "endUserBsuid": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessScopedUserId", "traits": { "smithy.api#documentation": "The business-scoped user identifier (BSUID) of the end user for which to retrieve the calling permission.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppCallPermissionOutput": { "type": "structure", "members": { "permission": { "target": "com.amazonaws.socialmessaging#WhatsAppCallPermission", "traits": { "smithy.api#documentation": "The current calling permission state for the end user.
", "smithy.api#required": {} } }, "actions": { "target": "com.amazonaws.socialmessaging#WhatsAppCallPermissionActionList", "traits": { "smithy.api#documentation": "The calling actions the business can take with the end user, and any limits that apply to each action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppFlow": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetWhatsAppFlowInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetWhatsAppFlowOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/flow", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppFlowInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow to retrieve.
", "smithy.api#httpQuery": "flowId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppFlowOutput": { "type": "structure", "members": { "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow.
", "smithy.api#required": {} } }, "flowName": { "target": "com.amazonaws.socialmessaging#MetaFlowName", "traits": { "smithy.api#documentation": "The name of the Flow.
", "smithy.api#required": {} } }, "flowStatus": { "target": "com.amazonaws.socialmessaging#MetaFlowStatus", "traits": { "smithy.api#documentation": "The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED.
", "smithy.api#required": {} } }, "categories": { "target": "com.amazonaws.socialmessaging#MetaFlowCategoryList", "traits": { "smithy.api#documentation": "The categories that classify the business purpose of the Flow.
" } }, "validationErrors": { "target": "com.amazonaws.socialmessaging#ValidationErrorList", "traits": { "smithy.api#documentation": "A list of validation errors from Meta, if any.
" } }, "jsonVersion": { "target": "com.amazonaws.socialmessaging#MetaFlowJsonVersion", "traits": { "smithy.api#documentation": "The version of the Flow JSON schema used by this Flow (for example, 7.3).
" } }, "dataApiVersion": { "target": "com.amazonaws.socialmessaging#MetaFlowDataApiVersion", "traits": { "smithy.api#documentation": "The data API version for data exchange endpoint Flows.
" } }, "endpointUri": { "target": "com.amazonaws.socialmessaging#MetaFlowEndpointUri", "traits": { "smithy.api#documentation": "The HTTPS endpoint that Meta calls for a data exchange Flow.
" } }, "preview": { "target": "com.amazonaws.socialmessaging#MetaFlowPreviewInfo", "traits": { "smithy.api#documentation": "The preview URL and its expiration timestamp for testing the Flow.
" } }, "whatsAppBusinessAccount": { "target": "com.amazonaws.socialmessaging#MetaFlowWhatsAppBusinessAccountInfo", "traits": { "smithy.api#documentation": "The WhatsApp Business Account information from Meta associated with this Flow.
" } }, "application": { "target": "com.amazonaws.socialmessaging#MetaFlowApplicationInfo", "traits": { "smithy.api#documentation": "The Meta application information associated with this Flow.
" } }, "healthStatus": { "target": "com.amazonaws.socialmessaging#MetaFlowHealthStatus", "traits": { "smithy.api#documentation": "The health status information for this Flow from Meta.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppFlowPreview": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetWhatsAppFlowPreviewInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetWhatsAppFlowPreviewOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/flow/preview", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppFlowPreviewInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow to preview.
", "smithy.api#httpQuery": "flowId", "smithy.api#required": {} } }, "invalidate": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Set to true to force generation of a new preview URL. Use this if the previous URL has been compromised or you want a fresh expiration period.
The unique identifier of the Flow.
", "smithy.api#required": {} } }, "preview": { "target": "com.amazonaws.socialmessaging#MetaFlowPreviewInfo", "traits": { "smithy.api#documentation": "The preview URL and its expiration timestamp.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppMessageMedia": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Get a media file from the WhatsApp service. On successful completion the media file is\n retrieved from Meta and stored in the specified Amazon S3 bucket. Use either\n destinationS3File or destinationS3PresignedUrl for the\n destination. If both are used then an InvalidParameterException is\n returned.
The unique identifier for the media file.
", "smithy.api#required": {} } }, "originationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the originating phone number for the WhatsApp message media.\n The phone number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.
Set to True to get only the metadata for the file.
The presign url of the media file.
" } }, "destinationS3File": { "target": "com.amazonaws.socialmessaging#S3File", "traits": { "smithy.api#documentation": "The bucketName and key of the S3 media file.
The MIME type of the media.
" } }, "fileSize": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The size of the media file, in KB.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplate": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateInput" }, "output": { "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Retrieves a specific WhatsApp message template.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/template", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateInput": { "type": "structure", "members": { "metaTemplateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The numeric ID of the template assigned by Meta.
", "smithy.api#httpQuery": "metaTemplateId" } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this template.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "templateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name of the message template. Use together with templateLanguageCode as an alternative to metaTemplateId to identify a template.
The language code of the message template (for example, en or en_US). Use together with templateName as an alternative to metaTemplateId to identify a template.
The complete template definition as a JSON string (maximum 6000 characters).
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#Headers": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.socialmessaging#IanaTimezone": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#InternalServiceException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or\n failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.socialmessaging#InvalidParametersException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "One or more parameters provided to the action are not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.socialmessaging#Iso8601Duration": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#IsoCountryCode": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Z]{2}$" } }, "com.amazonaws.socialmessaging#KmsKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:aws[a-z-]*:kms:[a-z0-9-]+:[0-9]{12}:(key/.+|alias/.+)$" } }, "com.amazonaws.socialmessaging#LibraryTemplateBodyInputs": { "type": "structure", "members": { "addContactNumber": { "target": "com.amazonaws.socialmessaging#AddContactNumber", "traits": { "smithy.api#documentation": "When true, includes a contact number in the template body.
" } }, "addLearnMoreLink": { "target": "com.amazonaws.socialmessaging#AddLearnMoreLink", "traits": { "smithy.api#documentation": "When true, includes a \"learn more\" link in the template body.
" } }, "addSecurityRecommendation": { "target": "com.amazonaws.socialmessaging#AddSecurityRecommendation", "traits": { "smithy.api#documentation": "When true, includes security recommendations in the template body.
" } }, "addTrackPackageLink": { "target": "com.amazonaws.socialmessaging#AddTrackPackageLink", "traits": { "smithy.api#documentation": "When true, includes a package tracking link in the template body.
" } }, "codeExpirationMinutes": { "target": "com.amazonaws.socialmessaging#CodeExpirationMinutes", "traits": { "smithy.api#documentation": "The number of minutes until a verification code or OTP expires.
" } } }, "traits": { "smithy.api#documentation": "Configuration options for customizing the body content of a template from Meta's library.
" } }, "com.amazonaws.socialmessaging#LibraryTemplateButtonInput": { "type": "structure", "members": { "type": { "target": "com.amazonaws.socialmessaging#ButtonType", "traits": { "smithy.api#documentation": "The type of button (for example, QUICK_REPLY, CALL, or URL).
" } }, "phoneNumber": { "target": "com.amazonaws.socialmessaging#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number in E.164 format for CALL-type buttons.
" } }, "url": { "target": "com.amazonaws.socialmessaging#MetaUrlWithSuffixExample", "traits": { "smithy.api#documentation": "The URL with dynamic parameters for URL-type buttons.
" } }, "otpType": { "target": "com.amazonaws.socialmessaging#OtpType", "traits": { "smithy.api#documentation": "The type of one-time password for OTP buttons.
" } }, "zeroTapTermsAccepted": { "target": "com.amazonaws.socialmessaging#ZeroTapTermsAccepted", "traits": { "smithy.api#documentation": "When true, indicates acceptance of zero-tap terms for the button.
" } }, "supportedApps": { "target": "com.amazonaws.socialmessaging#SupportedApps", "traits": { "smithy.api#documentation": "List of supported applications for this button type.
" } } }, "traits": { "smithy.api#documentation": "Configuration options for customizing buttons in a template from Meta's library.
" } }, "com.amazonaws.socialmessaging#LibraryTemplateButtonList": { "type": "structure", "members": { "type": { "target": "com.amazonaws.socialmessaging#ButtonType", "traits": { "smithy.api#documentation": "The type of button (for example, QUICK_REPLY, CALL, or URL).
" } }, "text": { "target": "com.amazonaws.socialmessaging#MetaText", "traits": { "smithy.api#documentation": "The text displayed on the button (maximum 40 characters).
" } }, "phoneNumber": { "target": "com.amazonaws.socialmessaging#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number in E.164 format for CALL-type buttons.
" } }, "url": { "target": "com.amazonaws.socialmessaging#MetaUrl", "traits": { "smithy.api#documentation": "The URL for URL-type buttons.
" } }, "otpType": { "target": "com.amazonaws.socialmessaging#OtpType", "traits": { "smithy.api#documentation": "The type of one-time password for OTP buttons.
" } }, "zeroTapTermsAccepted": { "target": "com.amazonaws.socialmessaging#ZeroTapTermsAccepted", "traits": { "smithy.api#documentation": "When true, indicates acceptance of zero-tap terms for the button.
" } }, "supportedApps": { "target": "com.amazonaws.socialmessaging#SupportedApps", "traits": { "smithy.api#documentation": "List of supported applications for this button type.
" } } }, "traits": { "smithy.api#documentation": "Defines a button in a template from Meta's library.
" } }, "com.amazonaws.socialmessaging#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request was denied because it would exceed one or more service quotas or limits.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.socialmessaging#LinkedAccountWithIncompleteSetup": { "type": "map", "key": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId" }, "value": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountIdMetaData" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccount": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn", "traits": { "smithy.api#documentation": "The ARN of the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The WhatsApp Business Account ID from meta.
", "smithy.api#required": {} } }, "registrationStatus": { "target": "com.amazonaws.socialmessaging#RegistrationStatus", "traits": { "smithy.api#documentation": "The registration status of the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "linkDate": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate", "traits": { "smithy.api#documentation": "The date the WhatsApp Business Account was linked.
", "smithy.api#required": {} } }, "wabaName": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", "traits": { "smithy.api#documentation": "The name of the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "eventDestinations": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", "traits": { "smithy.api#documentation": "The event destinations for the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "marketingMessagesOnboardingStatus": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountMarketingMessagesOnboardingStatus", "traits": { "smithy.api#documentation": "The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
" } }, "directSendEnforcementStatus": { "target": "com.amazonaws.socialmessaging#DirectSendEnforcementStatus", "traits": { "smithy.api#documentation": "The Direct Send enforcement status for the WhatsApp Business Account. Enforcement applies when an account repeatedly sends messages in a category that does not match the content. This field is not present when no enforcement is active.
" } }, "directSendEnforcementStatusExpiresAt": { "target": "com.amazonaws.socialmessaging#DirectSendEnforcementStatusExpiresAt", "traits": { "smithy.api#documentation": "The time when the current Direct Send enforcement is expected to lift. This field is not present for permanent enforcement or when no enforcement is active.
" } }, "datasetId": { "target": "com.amazonaws.socialmessaging#WhatsAppDatasetId", "traits": { "smithy.api#documentation": "The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.
" } }, "phoneNumbers": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummaryList", "traits": { "smithy.api#documentation": "The phone numbers associated with the Linked WhatsApp Business Account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of your linked WhatsApp Business Account.
" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:.*:waba/[0-9a-zA-Z]+$" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 115 }, "smithy.api#pattern": "(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$)" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountIdMetaData": { "type": "structure", "members": { "accountName": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", "traits": { "smithy.api#documentation": "The name of your account.
" } }, "registrationStatus": { "target": "com.amazonaws.socialmessaging#RegistrationStatus", "traits": { "smithy.api#documentation": "The registration status of the linked WhatsApp Business Account.
" } }, "unregisteredWhatsAppPhoneNumbers": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetailList", "traits": { "smithy.api#documentation": "The details for unregistered WhatsApp phone numbers.
" } }, "wabaId": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the WhatsApp Business Account ID.
" } } }, "traits": { "smithy.api#documentation": "Contains your WhatsApp registration status and details of any unregistered WhatsApp\n phone number.
" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource": { "type": "resource", "identifiers": { "WabaId": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId" } }, "create": { "target": "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccount" }, "read": { "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccount" }, "delete": { "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccount" }, "list": { "target": "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccounts" }, "operations": [ { "target": "com.amazonaws.socialmessaging#CreateWhatsAppDataset" }, { "target": "com.amazonaws.socialmessaging#CreateWhatsAppFlow" }, { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplate" }, { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibrary" }, { "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMedia" }, { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppFlow" }, { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplate" }, { "target": "com.amazonaws.socialmessaging#DeprecateWhatsAppFlow" }, { "target": "com.amazonaws.socialmessaging#GetWhatsAppFlow" }, { "target": "com.amazonaws.socialmessaging#GetWhatsAppFlowPreview" }, { "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplate" }, { "target": "com.amazonaws.socialmessaging#ListWhatsAppFlowAssets" }, { "target": "com.amazonaws.socialmessaging#ListWhatsAppFlows" }, { "target": "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplates" }, { "target": "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibrary" }, { "target": "com.amazonaws.socialmessaging#PublishWhatsAppFlow" }, { "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinations" }, { "target": "com.amazonaws.socialmessaging#SendWhatsAppConversionEvent" }, { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppFlow" }, { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppFlowAssets" }, { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplate" } ], "traits": { "aws.api#arn": { "template": "waba/{WabaId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "waba", "relativeDocumentation": "managing-wabas.html" } } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn", "traits": { "smithy.api#documentation": "The ARN of the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The WhatsApp Business Account ID provided by Meta.
", "smithy.api#required": {} } }, "registrationStatus": { "target": "com.amazonaws.socialmessaging#RegistrationStatus", "traits": { "smithy.api#documentation": "The registration status of the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "linkDate": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate", "traits": { "smithy.api#documentation": "The date the WhatsApp Business Account was linked.
", "smithy.api#required": {} } }, "wabaName": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", "traits": { "smithy.api#documentation": "The name of the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "eventDestinations": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", "traits": { "smithy.api#documentation": "The event destinations for the linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "marketingMessagesOnboardingStatus": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountMarketingMessagesOnboardingStatus", "traits": { "smithy.api#documentation": "The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
" } }, "directSendEnforcementStatus": { "target": "com.amazonaws.socialmessaging#DirectSendEnforcementStatus", "traits": { "smithy.api#documentation": "The Direct Send enforcement status for the WhatsApp Business Account. Enforcement applies when an account repeatedly sends messages in a category that does not match the content. This field is not present when no enforcement is active.
" } }, "directSendEnforcementStatusExpiresAt": { "target": "com.amazonaws.socialmessaging#DirectSendEnforcementStatusExpiresAt", "traits": { "smithy.api#documentation": "The time when the current Direct Send enforcement is expected to lift. This field is not present for permanent enforcement or when no enforcement is active.
" } }, "datasetId": { "target": "com.amazonaws.socialmessaging#WhatsAppDatasetId", "traits": { "smithy.api#documentation": "The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.
" } } }, "traits": { "smithy.api#documentation": "The details of a linked WhatsApp Business Account.
" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummaryList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummary" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:.*:phone-number-id/[0-9a-zA-Z]+$" } }, "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource": { "type": "resource", "identifiers": { "OriginationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId" } }, "read": { "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumber" }, "operations": [ { "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMedia" }, { "target": "com.amazonaws.socialmessaging#GetWhatsAppBusinessPublicKey" }, { "target": "com.amazonaws.socialmessaging#GetWhatsAppCallPermission" }, { "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMedia" }, { "target": "com.amazonaws.socialmessaging#PostWhatsAppMessageMedia" }, { "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessPublicKey" }, { "target": "com.amazonaws.socialmessaging#SendWhatsAppCallEvent" }, { "target": "com.amazonaws.socialmessaging#SendWhatsAppMessage" }, { "target": "com.amazonaws.socialmessaging#UpdateLinkedWhatsAppBusinessAccountPhoneNumber" } ], "traits": { "aws.api#arn": { "template": "phone-number-id/{OriginationPhoneNumberId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamResource": { "name": "phone-number-id", "relativeDocumentation": "managing-phone-numbers.html" } } }, "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccounts": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsInput" }, "output": { "target": "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "List all WhatsApp Business Accounts linked to your Amazon Web Services account.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/waba/list", "code": 200 }, "smithy.api#paginated": { "items": "linkedAccounts" }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The next token for pagination.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.socialmessaging#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsOutput": { "type": "structure", "members": { "linkedAccounts": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummaryList", "traits": { "smithy.api#documentation": "A list of WhatsApp Business Accounts linked to your Amazon Web Services account.
" } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The next token for pagination.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.socialmessaging#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "List all tags associated with a resource, such as a phone number or WABA.
", "smithy.api#http": { "method": "GET", "uri": "/v1/tags/list", "code": 200 }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListTagsFailure", "params": { "resourceArn": "arn:aws:social-messaging:us-east-1:9923825:phone-number-id/45c1973a7577" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.socialmessaging#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.socialmessaging#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to retrieve the tags from.
", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#ListTagsForResourceOutput": { "type": "structure", "members": { "statusCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The status code of the response.
" } }, "tags": { "target": "com.amazonaws.socialmessaging#TagList", "traits": { "smithy.api#documentation": "The tags for the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppFlowAssets": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#ListWhatsAppFlowAssetsInput" }, "output": { "target": "com.amazonaws.socialmessaging#ListWhatsAppFlowAssetsOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/flow/assets", "code": 200 }, "smithy.api#paginated": { "items": "flowAssets" }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppFlowAssetsInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow whose assets to list.
", "smithy.api#httpQuery": "flowId", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.socialmessaging#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppFlowAssetsOutput": { "type": "structure", "members": { "flowAssets": { "target": "com.amazonaws.socialmessaging#MetaFlowAssetList", "traits": { "smithy.api#documentation": "A list of Flow assets with download URLs.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results, if any.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppFlows": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#ListWhatsAppFlowsInput" }, "output": { "target": "com.amazonaws.socialmessaging#ListWhatsAppFlowsOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/flow/list", "code": 200 }, "smithy.api#paginated": { "items": "flows" }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppFlowsInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account to list Flows for.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.socialmessaging#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppFlowsOutput": { "type": "structure", "members": { "flows": { "target": "com.amazonaws.socialmessaging#MetaFlowSummaryList", "traits": { "smithy.api#documentation": "A list of Flow summaries.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results, if any.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplates": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesInput" }, "output": { "target": "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Lists WhatsApp message templates for a specific WhatsApp Business Account.
", "smithy.api#http": { "method": "GET", "uri": "/v1/whatsapp/template/list", "code": 200 }, "smithy.api#paginated": { "items": "templates" }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account to list templates for.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.socialmessaging#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page (1-100).
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesOutput": { "type": "structure", "members": { "templates": { "target": "com.amazonaws.socialmessaging#TemplateSummaryList", "traits": { "smithy.api#documentation": "A list of template summaries.
" } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results, if any.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibrary": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryInput" }, "output": { "target": "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Lists templates available in Meta's template library for WhatsApp messaging.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/template/library", "code": 200 }, "smithy.api#paginated": { "items": "metaLibraryTemplates" }, "smithy.api#readonly": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results.
" } }, "maxResults": { "target": "com.amazonaws.socialmessaging#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page (1-100).
" } }, "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account to list library templates for.
", "smithy.api#httpQuery": "id", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "filters": { "target": "com.amazonaws.socialmessaging#Filter", "traits": { "smithy.api#documentation": "Map of filters to apply (searchKey, topic, usecase, industry, language).
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryOutput": { "type": "structure", "members": { "metaLibraryTemplates": { "target": "com.amazonaws.socialmessaging#MetaLibraryTemplatesList", "traits": { "smithy.api#documentation": "A list of templates from Meta's library.
" } }, "nextToken": { "target": "com.amazonaws.socialmessaging#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results, if any.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#MetaFlowApplicationId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#MetaFlowApplicationInfo": { "type": "structure", "members": { "link": { "target": "com.amazonaws.socialmessaging#MetaFlowApplicationLink", "traits": { "smithy.api#documentation": "The URL link for the Meta application.
" } }, "name": { "target": "com.amazonaws.socialmessaging#MetaFlowApplicationName", "traits": { "smithy.api#documentation": "The name of the Meta application.
", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.socialmessaging#MetaFlowApplicationId", "traits": { "smithy.api#documentation": "The unique identifier of the Meta application.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the Meta application metadata associated with a WhatsApp Flow.
" } }, "com.amazonaws.socialmessaging#MetaFlowApplicationLink": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.socialmessaging#MetaFlowApplicationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.socialmessaging#MetaFlowAsset": { "type": "structure", "members": { "name": { "target": "com.amazonaws.socialmessaging#MetaFlowAssetName", "traits": { "smithy.api#documentation": "The filename of the asset (for example, flow.json).
", "smithy.api#required": {} } }, "assetType": { "target": "com.amazonaws.socialmessaging#MetaFlowAssetType", "traits": { "smithy.api#documentation": "The type of asset. Currently the only supported value is FLOW_JSON.
", "smithy.api#required": {} } }, "downloadUrl": { "target": "com.amazonaws.socialmessaging#MetaFlowAssetDownloadUrl", "traits": { "smithy.api#documentation": "A presigned URL from Meta for downloading the asset. The URL expires after a short period.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a single asset file associated with a WhatsApp Flow, including a presigned download URL.
" } }, "com.amazonaws.socialmessaging#MetaFlowAssetDownloadUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.socialmessaging#MetaFlowAssetList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaFlowAsset" } }, "com.amazonaws.socialmessaging#MetaFlowAssetName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#MetaFlowAssetType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#MetaFlowCategory": { "type": "enum", "members": { "SIGN_UP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIGN_UP" } }, "SIGN_IN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIGN_IN" } }, "APPOINTMENT_BOOKING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPOINTMENT_BOOKING" } }, "LEAD_GENERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEAD_GENERATION" } }, "SHOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHOPPING" } }, "CONTACT_US": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTACT_US" } }, "CUSTOMER_SUPPORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_SUPPORT" } }, "SURVEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SURVEY" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } }, "traits": { "smithy.api#documentation": "The category that classifies the business purpose of a WhatsApp Flow.
" } }, "com.amazonaws.socialmessaging#MetaFlowCategoryList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaFlowCategory" }, "traits": { "smithy.api#length": { "min": 1, "max": 9 } } }, "com.amazonaws.socialmessaging#MetaFlowDataApiVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.socialmessaging#MetaFlowEndpointUri": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.socialmessaging#MetaFlowHealthEntity": { "type": "structure", "members": { "entityType": { "target": "com.amazonaws.socialmessaging#MetaFlowHealthEntityType", "traits": { "smithy.api#documentation": "The type of entity (for example, FLOW, WABA, BUSINESS, or APP).
", "smithy.api#required": {} } }, "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the entity.
", "smithy.api#required": {} } }, "canSendMessage": { "target": "com.amazonaws.socialmessaging#MetaFlowHealthStatusAvailability", "traits": { "smithy.api#documentation": "The messaging availability status for this entity (for example, AVAILABLE, LIMITED, or BLOCKED).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a single entity in the health status check for a WhatsApp Flow.
" } }, "com.amazonaws.socialmessaging#MetaFlowHealthEntityList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaFlowHealthEntity" } }, "com.amazonaws.socialmessaging#MetaFlowHealthEntityType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#MetaFlowHealthStatus": { "type": "structure", "members": { "canSendMessage": { "target": "com.amazonaws.socialmessaging#MetaFlowHealthStatusAvailability", "traits": { "smithy.api#documentation": "The overall messaging availability status (for example, AVAILABLE, LIMITED, or BLOCKED).
", "smithy.api#required": {} } }, "entities": { "target": "com.amazonaws.socialmessaging#MetaFlowHealthEntityList", "traits": { "smithy.api#documentation": "A list of health status entities with per-entity availability information.
" } } }, "traits": { "smithy.api#documentation": "Contains the overall health status and per-entity breakdown for a WhatsApp Flow.
" } }, "com.amazonaws.socialmessaging#MetaFlowHealthStatusAvailability": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#MetaFlowId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.socialmessaging#MetaFlowJsonBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 10485760 } } }, "com.amazonaws.socialmessaging#MetaFlowJsonVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.socialmessaging#MetaFlowName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.socialmessaging#MetaFlowPreviewInfo": { "type": "structure", "members": { "previewUrl": { "target": "com.amazonaws.socialmessaging#MetaFlowPreviewUrl", "traits": { "smithy.api#documentation": "The web URL for previewing the Flow. Can be shared with stakeholders for review.
", "smithy.api#required": {} } }, "expiresAt": { "target": "com.amazonaws.socialmessaging#MetaFlowTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the preview URL expires.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the preview URL for testing a WhatsApp Flow and its expiration timestamp.
" } }, "com.amazonaws.socialmessaging#MetaFlowPreviewUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.socialmessaging#MetaFlowStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#MetaFlowSummary": { "type": "structure", "members": { "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow assigned by Meta.
", "smithy.api#required": {} } }, "flowName": { "target": "com.amazonaws.socialmessaging#MetaFlowName", "traits": { "smithy.api#documentation": "The name of the Flow.
", "smithy.api#required": {} } }, "flowStatus": { "target": "com.amazonaws.socialmessaging#MetaFlowStatus", "traits": { "smithy.api#documentation": "The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED).
", "smithy.api#required": {} } }, "flowCategories": { "target": "com.amazonaws.socialmessaging#MetaFlowCategoryList", "traits": { "smithy.api#documentation": "The categories that classify the business purpose of the Flow.
", "smithy.api#required": {} } }, "validationErrors": { "target": "com.amazonaws.socialmessaging#ValidationErrorList", "traits": { "smithy.api#documentation": "A list of validation errors from Meta, if any.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains summary information about a WhatsApp Flow, including its ID, name, status, and categories.
" } }, "com.amazonaws.socialmessaging#MetaFlowSummaryList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaFlowSummary" } }, "com.amazonaws.socialmessaging#MetaFlowTimestamp": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#MetaFlowValidationError": { "type": "string", "traits": { "smithy.api#length": { "max": 1048576 } } }, "com.amazonaws.socialmessaging#MetaFlowWabaCurrency": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.socialmessaging#MetaFlowWabaTemplateNamespace": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.socialmessaging#MetaFlowWabaTimezoneId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.socialmessaging#MetaFlowWhatsAppBusinessAccountInfo": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The WhatsApp Business Account ID from Meta.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", "traits": { "smithy.api#documentation": "The name of the WhatsApp Business Account.
", "smithy.api#required": {} } }, "currency": { "target": "com.amazonaws.socialmessaging#MetaFlowWabaCurrency", "traits": { "smithy.api#documentation": "The currency code for the WhatsApp Business Account (for example, USD).
" } }, "timezoneId": { "target": "com.amazonaws.socialmessaging#MetaFlowWabaTimezoneId", "traits": { "smithy.api#documentation": "The timezone ID for the WhatsApp Business Account.
" } }, "messageTemplateNamespace": { "target": "com.amazonaws.socialmessaging#MetaFlowWabaTemplateNamespace", "traits": { "smithy.api#documentation": "The message template namespace for the WhatsApp Business Account.
" } } }, "traits": { "smithy.api#documentation": "Contains WhatsApp Business Account metadata associated with a Flow, as returned by Meta.
" } }, "com.amazonaws.socialmessaging#MetaIndustries": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaIndustry" } }, "com.amazonaws.socialmessaging#MetaIndustry": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.socialmessaging#MetaLibraryTemplate": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name to assign to the template.
", "smithy.api#required": {} } }, "libraryTemplateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name of the template in Meta's library.
", "smithy.api#required": {} } }, "templateCategory": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The category of the template (for example, UTILITY or MARKETING).
", "smithy.api#required": {} } }, "templateLanguage": { "target": "com.amazonaws.socialmessaging#MetaTemplateLanguage", "traits": { "smithy.api#documentation": "The language code for the template (for example, en_US).
", "smithy.api#required": {} } }, "libraryTemplateButtonInputs": { "target": "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonInputs", "traits": { "smithy.api#documentation": "Button customizations for the template.
" } }, "libraryTemplateBodyInputs": { "target": "com.amazonaws.socialmessaging#LibraryTemplateBodyInputs", "traits": { "smithy.api#documentation": "Body text customizations for the template.
" } } }, "traits": { "smithy.api#documentation": "Represents a template from Meta's library with customization options.
" } }, "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonInputs": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#LibraryTemplateButtonInput" } }, "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#LibraryTemplateButtonList" } }, "com.amazonaws.socialmessaging#MetaLibraryTemplateDefinition": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name of the template.
" } }, "templateLanguage": { "target": "com.amazonaws.socialmessaging#MetaTemplateLanguage", "traits": { "smithy.api#documentation": "The language code for the template (for example, en_US).
" } }, "templateCategory": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The category of the template (for example, UTILITY or MARKETING).
" } }, "templateTopic": { "target": "com.amazonaws.socialmessaging#MetaTemplateTopic", "traits": { "smithy.api#documentation": "The topic or subject matter of the template.
" } }, "templateUseCase": { "target": "com.amazonaws.socialmessaging#MetaTemplateUseCase", "traits": { "smithy.api#documentation": "The intended use case for the template.
" } }, "templateIndustry": { "target": "com.amazonaws.socialmessaging#MetaIndustries", "traits": { "smithy.api#documentation": "The industries the template is designed for.
" } }, "templateHeader": { "target": "com.amazonaws.socialmessaging#MetaTemplateHeader", "traits": { "smithy.api#documentation": "The header text of the template.
" } }, "templateBody": { "target": "com.amazonaws.socialmessaging#MetaTemplateBody", "traits": { "smithy.api#documentation": "The body text of the template.
" } }, "templateButtons": { "target": "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonList", "traits": { "smithy.api#documentation": "The buttons included in the template.
" } }, "templateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The ID of the template in Meta's library.
" } }, "templateBodyExampleParams": { "target": "com.amazonaws.socialmessaging#MetaTemplateBodyExampleParams", "traits": { "smithy.api#documentation": "Example parameter values for the template body, used to demonstrate how dynamic content appears in the template.
" } } }, "traits": { "smithy.api#documentation": "Defines the complete structure and content of a template in Meta's library.
" } }, "com.amazonaws.socialmessaging#MetaLibraryTemplatesList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaLibraryTemplateDefinition" } }, "com.amazonaws.socialmessaging#MetaParameterFormat": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 15 } } }, "com.amazonaws.socialmessaging#MetaTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6000 } } }, "com.amazonaws.socialmessaging#MetaTemplateBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.socialmessaging#MetaTemplateBodyExampleParams": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.socialmessaging#MetaTemplateCategory": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#MetaTemplateComponents": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 3000 } } }, "com.amazonaws.socialmessaging#MetaTemplateCtaLinkTrackingOptedOut": { "type": "boolean" }, "com.amazonaws.socialmessaging#MetaTemplateDefinition": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 6000 } } }, "com.amazonaws.socialmessaging#MetaTemplateHeader": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.socialmessaging#MetaTemplateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.socialmessaging#MetaTemplateLanguage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6 } } }, "com.amazonaws.socialmessaging#MetaTemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.socialmessaging#MetaTemplateQualityScore": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#MetaTemplateSource": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#MetaTemplateStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#MetaTemplateTopic": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#MetaTemplateUseCase": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "com.amazonaws.socialmessaging#MetaText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 } } }, "com.amazonaws.socialmessaging#MetaUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 400 } } }, "com.amazonaws.socialmessaging#MetaUrlWithSuffixExample": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 400 } } }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.socialmessaging#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 600 } } }, "com.amazonaws.socialmessaging#OtpType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.socialmessaging#PhoneNumber": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.socialmessaging#PostWhatsAppMessageMedia": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaInput" }, "output": { "target": "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Upload a media file to the WhatsApp service. Only the specified\n originationPhoneNumberId has the permissions to send the media file when\n using SendWhatsAppMessage. You must use either sourceS3File\n or sourceS3PresignedUrl for the source. If both or neither are specified then an\n InvalidParameterException is returned.
The ID of the phone number to associate with the WhatsApp media file. The phone number\n identifiers are formatted as phone-number-id-01234567890123456789012345678901.\n Use GetLinkedWhatsAppBusinessAccount \n to find a phone number's id.
The source presign url of the media file.
" } }, "sourceS3File": { "target": "com.amazonaws.socialmessaging#S3File", "traits": { "smithy.api#documentation": "The source S3 url for the media file.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaOutput": { "type": "structure", "members": { "mediaId": { "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", "traits": { "smithy.api#documentation": "The unique identifier of the posted WhatsApp message.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#PublishWhatsAppFlow": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#PublishWhatsAppFlowInput" }, "output": { "target": "com.amazonaws.socialmessaging#PublishWhatsAppFlowOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Publishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's validation. This is an irreversible operation.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/flow/publish", "code": 200 } } }, "com.amazonaws.socialmessaging#PublishWhatsAppFlowInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow to publish.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#PublishWhatsAppFlowOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinations": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsInput" }, "output": { "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "aws.iam#iamAction": { "requiredActions": [ "iam:PassRole" ] }, "smithy.api#documentation": "Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.
", "smithy.api#http": { "method": "PUT", "uri": "/v1/whatsapp/waba/eventdestinations", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as\n waba-01234567890123456789012345678901. Use\n ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
An array of WhatsAppBusinessAccountEventDestination event destinations.
Sets the business public key used to encrypt the data exchanged with the endpoint of a data exchange Flow.
", "smithy.api#http": { "method": "PUT", "uri": "/v1/whatsapp/business-public-key", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#PutWhatsAppBusinessPublicKeyInput": { "type": "structure", "members": { "originationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the phone number to associate with the business public key.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" } }, "businessPublicKey": { "target": "com.amazonaws.socialmessaging#BusinessPublicKeyPem", "traits": { "smithy.api#documentation": "The PEM-encoded 2048-bit RSA public key to set. Mutually exclusive with kmsKeyArn.
The ARN of a customer managed asymmetric RSA key in Amazon Web Services KMS. Mutually exclusive with businessPublicKey.
The resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.socialmessaging#RoleArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:.*:iam::\\d{12}:role\\/[a-zA-Z0-9+=,.@\\-_]+$" } }, "com.amazonaws.socialmessaging#S3File": { "type": "structure", "members": { "bucketName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The bucket name.
", "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]*[a-z0-9]$", "smithy.api#required": {} } }, "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The S3 key prefix that defines the storage location of your media files. The prefix works like a folder path in S3, \n and is combined with the WhatsApp mediaId to create the final file path.
\nFor example, if a media file's WhatsApp mediaId is 123.ogg, and the key is audio/example.ogg, \n the final file path is audio/example.ogg123.ogg.
For the same mediaId, a key of audio/ results in the file path audio/123.ogg.
Contains information for the S3 bucket that contains media files.
", "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#S3PresignedUrl": { "type": "structure", "members": { "url": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The presign url to the object.
", "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#pattern": "^https://(.*)s3(.*).amazonaws.com/(.*)$", "smithy.api#required": {} } }, "headers": { "target": "com.amazonaws.socialmessaging#Headers", "traits": { "smithy.api#documentation": "A map of headers and their values. You must specify the Content-Type header when using PostWhatsAppMessageMedia. For a list of common headers, see Common Request Headers in the Amazon S3\n API Reference\n
You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see Working with presigned URLs in the Amazon S3\n User Guide.
", "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#SendWhatsAppCallEvent": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#SendWhatsAppCallEventInput" }, "output": { "target": "com.amazonaws.socialmessaging#SendWhatsAppCallEventOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#ConflictException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Sends a WhatsApp calling event, such as connecting or terminating a call, for a business phone number. This operation passes the event through to Meta. To use this operation, the origination phone number must belong to a WhatsApp Business Account that is linked to your Amazon Web Services account.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/call/event", "code": 200 } } }, "com.amazonaws.socialmessaging#SendWhatsAppCallEventInput": { "type": "structure", "members": { "originationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the origination phone number for the call. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's ID.
The version of the Meta Graph API to use for the request.
", "smithy.api#required": {} } }, "callEvent": { "target": "com.amazonaws.socialmessaging#WhatsAppCallEventBlob", "traits": { "smithy.api#documentation": "The call event payload to send, as a JSON blob in the format defined by the Meta calling API.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#SendWhatsAppCallEventOutput": { "type": "structure", "members": { "callId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier that Meta assigns to the call.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#SendWhatsAppConversionEvent": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#SendWhatsAppConversionEventInput" }, "output": { "target": "com.amazonaws.socialmessaging#SendWhatsAppConversionEventOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Sends a conversion event to Meta's Conversions API for the specified WhatsApp Business Account dataset.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/waba/dataset/events", "code": 200 } } }, "com.amazonaws.socialmessaging#SendWhatsAppConversionEventInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with the dataset, formatted as waba-01234567890123456789012345678901.
The Meta-generated dataset ID to send the event to.
", "smithy.api#required": {} } }, "eventData": { "target": "com.amazonaws.socialmessaging#WhatsAppConversionEventBlob", "traits": { "smithy.api#documentation": "The raw Meta Conversions API event payload as a JSON blob. See Meta's server event parameters for the supported format.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#SendWhatsAppConversionEventOutput": { "type": "structure", "members": { "requestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier for the conversion event request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#SendWhatsAppMessage": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#SendWhatsAppMessageInput" }, "output": { "target": "com.amazonaws.socialmessaging#SendWhatsAppMessageOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Send a WhatsApp message. For examples of sending a message using the Amazon Web Services\n CLI, see Sending messages in the\n \n Amazon Web Services End User Messaging Social User Guide\n .
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/send", "code": 200 } } }, "com.amazonaws.socialmessaging#SendWhatsAppMessageInput": { "type": "structure", "members": { "originationPhoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The ID of the phone number used to send the WhatsApp message. If you are sending a media\n file only the originationPhoneNumberId used to upload the file can be used.\n Phone number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.
The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp\n Message object, see Messages in the WhatsApp Business Platform Cloud API\n Reference.
", "smithy.api#required": {} } }, "metaApiVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see \n Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.
The unique identifier of the message.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#SocialMessaging": { "type": "service", "version": "2024-01-01", "operations": [ { "target": "com.amazonaws.socialmessaging#ListTagsForResource" }, { "target": "com.amazonaws.socialmessaging#TagResource" }, { "target": "com.amazonaws.socialmessaging#UntagResource" } ], "resources": [ { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource" }, { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource" } ], "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedException" }, { "target": "com.amazonaws.socialmessaging#ValidationException" } ], "traits": { "aws.api#service": { "sdkId": "SocialMessaging", "arnNamespace": "social-messaging", "cloudTrailEventSource": "social-messaging.amazonaws.com", "endpointPrefix": "social-messaging" }, "aws.auth#sigv4": { "name": "social-messaging" }, "aws.iam#defineConditionKeys": { "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags associated with the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by the tag keys that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": { "origin": "*", "additionalAllowedHeaders": [ "authorization", "x-amz-date", "x-amz-security-token", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id", "content-length", "x-api-key", "amz-sdk-request", "amz-sdk-invocation-id", "Csrf-Token" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id", "Csrf-Token" ] }, "smithy.api#documentation": "\n Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables\n application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the\n Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.
\nThe Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.
\nIf you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is\n Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The\n Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use\n Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications.\n The guide also provides key information, such as integration with other Amazon Web Services\n services, and the quotas that apply to use of the service.
\n\n Regional availability\n
\nThe Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated endpoint for each of these Regions. For a list of\n all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see\n Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These Availability\n Zones enable us to provide very high levels of availability and redundancy, while also\n minimizing latency. To learn more about the number of Availability Zones that are available\n in each Region, see Amazon Web Services Global Infrastructure.\n
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#title": "AWS End User Messaging Social", "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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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://social-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.socialmessaging#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.socialmessaging#SupportedApp": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 30 } } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.socialmessaging#SupportedApps": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#SupportedApp" } }, "com.amazonaws.socialmessaging#Tag": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The tag key.
", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The tag value.
", "smithy.api#length": { "max": 256 } } } }, "traits": { "smithy.api#documentation": "The tag for a resource.
" } }, "com.amazonaws.socialmessaging#TagList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#Tag" } }, "com.amazonaws.socialmessaging#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#TagResourceInput" }, "output": { "target": "com.amazonaws.socialmessaging#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified resource. When you specify\n an existing tag key, the value is overwritten with the new value.
", "smithy.api#http": { "method": "POST", "uri": "/v1/tags/tag-resource", "code": 200 } } }, "com.amazonaws.socialmessaging#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.socialmessaging#Arn", "traits": { "aws.api#data": "tagging", "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.socialmessaging#TagList", "traits": { "smithy.api#documentation": "The tags to add to the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource", "ids": { "OriginationPhoneNumberId": "resourceArn" } }, { "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource", "ids": { "WabaId": "resourceArn" } } ] } }, "com.amazonaws.socialmessaging#TagResourceOutput": { "type": "structure", "members": { "statusCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The status code of the tag resource operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#TemplateSummary": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name of the template.
" } }, "metaTemplateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The numeric ID assigned to the template by Meta.
" } }, "templateStatus": { "target": "com.amazonaws.socialmessaging#MetaTemplateStatus", "traits": { "smithy.api#documentation": "The current status of the template (for example, APPROVED, PENDING, or REJECTED).
" } }, "templateQualityScore": { "target": "com.amazonaws.socialmessaging#MetaTemplateQualityScore", "traits": { "smithy.api#documentation": "The quality score assigned to the template by Meta.
" } }, "templateLanguage": { "target": "com.amazonaws.socialmessaging#MetaTemplateLanguage", "traits": { "smithy.api#documentation": "The language code of the template (for example, en_US).
" } }, "templateCategory": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The category of the template (for example, UTILITY or MARKETING).
" } }, "templateSource": { "target": "com.amazonaws.socialmessaging#MetaTemplateSource", "traits": { "smithy.api#documentation": "The source of the template. A value of AUTO_GENERATED indicates that the template was created automatically from a message that you sent. This field is not present for templates that you created manually.
" } }, "correctCategory": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The category that the template content actually belongs to, when it differs from the template's current category. This field is present only when the template has been flagged as miscategorized.
" } } }, "traits": { "smithy.api#documentation": "Provides a summary of a WhatsApp message template's key attributes.
" } }, "com.amazonaws.socialmessaging#TemplateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#TemplateSummary" } }, "com.amazonaws.socialmessaging#ThrottledRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.socialmessaging#TwoFactorPin": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6 }, "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#UntagResourceInput" }, "output": { "target": "com.amazonaws.socialmessaging#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Removes the specified tags from a resource.
", "smithy.api#http": { "method": "POST", "uri": "/v1/tags/untag-resource", "code": 200 } } }, "com.amazonaws.socialmessaging#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.socialmessaging#Arn", "traits": { "aws.api#data": "tagging", "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to remove tags from.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.socialmessaging#StringList", "traits": { "smithy.api#documentation": "The keys of the tags to remove from the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource", "ids": { "OriginationPhoneNumberId": "resourceArn" } }, { "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource", "ids": { "WabaId": "resourceArn" } } ] } }, "com.amazonaws.socialmessaging#UntagResourceOutput": { "type": "structure", "members": { "statusCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The status code of the untag resource operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#UpdateLinkedWhatsAppBusinessAccountPhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#UpdateLinkedWhatsAppBusinessAccountPhoneNumberInput" }, "output": { "target": "com.amazonaws.socialmessaging#UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Updates the calling settings for a linked WhatsApp business phone number, such as whether calling is enabled and the hours during which the business accepts calls.
", "smithy.api#http": { "method": "PUT", "uri": "/v1/whatsapp/waba/phone", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.socialmessaging#UpdateLinkedWhatsAppBusinessAccountPhoneNumberInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the phone number to update. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The calling settings to apply to the phone number.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput": { "type": "structure", "members": { "phoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The unique identifier of the phone number that was updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#UpdateWhatsAppFlow": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppFlowInput" }, "output": { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppFlowOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/flow/update", "code": 200 } } }, "com.amazonaws.socialmessaging#UpdateWhatsAppFlowAssets": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppFlowAssetsInput" }, "output": { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppFlowAssetsOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/flow/assets/update", "code": 200 } } }, "com.amazonaws.socialmessaging#UpdateWhatsAppFlowAssetsInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow whose assets to update.
", "smithy.api#required": {} } }, "flowJson": { "target": "com.amazonaws.socialmessaging#MetaFlowJsonBlob", "traits": { "smithy.api#documentation": "The updated Flow JSON definition. Maximum size is 10 MB.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#UpdateWhatsAppFlowAssetsOutput": { "type": "structure", "members": { "validationErrors": { "target": "com.amazonaws.socialmessaging#ValidationErrorList", "traits": { "smithy.api#documentation": "A list of validation errors returned by Meta, if any. Validation errors must be resolved before the Flow can be published.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#UpdateWhatsAppFlowInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this Flow.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "flowId": { "target": "com.amazonaws.socialmessaging#MetaFlowId", "traits": { "smithy.api#documentation": "The unique identifier of the Flow to update.
", "smithy.api#required": {} } }, "flowName": { "target": "com.amazonaws.socialmessaging#MetaFlowName", "traits": { "smithy.api#documentation": "The updated name for the Flow.
" } }, "categories": { "target": "com.amazonaws.socialmessaging#MetaFlowCategoryList", "traits": { "smithy.api#documentation": "The updated categories for the Flow.
" } }, "endpointUri": { "target": "com.amazonaws.socialmessaging#MetaFlowEndpointUri", "traits": { "smithy.api#documentation": "The updated HTTPS endpoint for a data exchange Flow.
" } }, "metaAppId": { "target": "com.amazonaws.socialmessaging#MetaFlowApplicationId", "traits": { "smithy.api#documentation": "The ID of the Meta application to attach to the Flow.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#UpdateWhatsAppFlowOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplate": { "type": "operation", "input": { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateInput" }, "output": { "target": "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, { "target": "com.amazonaws.socialmessaging#InternalServiceException" }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, { "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } ], "traits": { "smithy.api#documentation": "Updates an existing WhatsApp message template.
", "smithy.api#http": { "method": "POST", "uri": "/v1/whatsapp/template", "code": 200 } } }, "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateInput": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the WhatsApp Business Account associated with this template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "WabaId" } }, "metaTemplateId": { "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { "smithy.api#documentation": "The numeric ID of the template assigned by Meta.
" } }, "templateName": { "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { "smithy.api#documentation": "The name of the message template. Use together with templateLanguageCode as an alternative to metaTemplateId to identify a template.
The language code of the message template (for example, en or en_US). Use together with templateName as an alternative to metaTemplateId to identify a template.
The format specification for parameters in the template, this can be either 'named' or 'positional'.
" } }, "templateCategory": { "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { "smithy.api#documentation": "The new category for the template (for example, UTILITY or MARKETING).
" } }, "templateComponents": { "target": "com.amazonaws.socialmessaging#MetaTemplateComponents", "traits": { "smithy.api#documentation": "The updated components of the template as a JSON blob (maximum 3000 characters).
" } }, "ctaUrlLinkTrackingOptedOut": { "target": "com.amazonaws.socialmessaging#MetaTemplateCtaLinkTrackingOptedOut", "traits": { "smithy.api#documentation": "When true, disables click tracking for call-to-action URL buttons in the template.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.socialmessaging#ValidationErrorList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#MetaFlowValidationError" } }, "com.amazonaws.socialmessaging#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request contains an invalid parameter value.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalization": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumber", "traits": { "smithy.api#documentation": "The unique identifier of the originating phone number associated with the media. Phone\n number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use the \n GetLinkedWhatsAppBusinessAccount \n API action to find a phone number's id.
The PIN to use for two-step verification. To reset your PIN follow the directions in\n Updating PIN in the WhatsApp Business Platform Cloud API\n Reference.
", "smithy.api#required": {} } }, "dataLocalizationRegion": { "target": "com.amazonaws.socialmessaging#IsoCountryCode", "traits": { "smithy.api#documentation": "The two letter ISO region for the location of where Meta will store data.
\n\n Asia\u2013Pacific (APAC)\n
\nAustralia AU\n
\nIndonesia ID\n
\nIndia IN\n
\nJapan JP\n
\nSingapore SG\n
\nSouth Korea KR\n
\n\n Europe\n
\nGermany DE\n
\nSwitzerland CH\n
\nUnited Kingdom GB\n
\n\n Latin America (LATAM)\n
\nBrazil BR\n
\n\n Middle East and Africa (MEA)\n
\nBahrain BH\n
\nSouth Africa ZA\n
\nUnited Arab Emirates AE\n
\n\n North America (NORAM)\n
\nCanada CA\n
\nAn array of key and value pair tags.
" } } }, "traits": { "smithy.api#documentation": "The registration details for a linked phone number.
" } }, "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalizationList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalization" } }, "com.amazonaws.socialmessaging#WabaSetupFinalization": { "type": "structure", "members": { "id": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The event destinations for the linked WhatsApp Business Account.
" } }, "tags": { "target": "com.amazonaws.socialmessaging#TagList", "traits": { "smithy.api#documentation": "An array of key and value pair tags.
" } } }, "traits": { "smithy.api#documentation": "The registration details for a linked WhatsApp Business Account.
" } }, "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestination": { "type": "structure", "members": { "eventDestinationArn": { "target": "com.amazonaws.socialmessaging#EventDestinationArn", "traits": { "smithy.api#documentation": "The ARN of the event destination.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.socialmessaging#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role\n that is able to import phone numbers and write events.
" } } }, "traits": { "smithy.api#documentation": "Contains information on the event destination.
" } }, "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestination" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate": { "type": "timestamp" }, "com.amazonaws.socialmessaging#WhatsAppBusinessAccountMarketingMessagesOnboardingStatus": { "type": "string", "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName": { "type": "string", "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.socialmessaging#WhatsAppBusinessScopedUserId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#WhatsAppCallEventBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 2048000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#WhatsAppCallHours": { "type": "structure", "members": { "enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether call hours are enforced. When disabled, the business accepts calls at any time.
", "smithy.api#required": {} } }, "timezone": { "target": "com.amazonaws.socialmessaging#IanaTimezone", "traits": { "smithy.api#documentation": "The IANA time zone in which the operating hours are interpreted, such as America/New_York.
The weekly schedule of hours during which the business accepts calls.
", "smithy.api#required": {} } }, "holidaySchedule": { "target": "com.amazonaws.socialmessaging#WhatsAppHolidayScheduleList", "traits": { "smithy.api#documentation": "Date-specific overrides to the weekly operating hours, such as holidays.
" } } }, "traits": { "smithy.api#documentation": "The operating hours during which a business phone number accepts WhatsApp calls, including the time zone, weekly schedule, and any holiday overrides.
" } }, "com.amazonaws.socialmessaging#WhatsAppCallIconVisibility": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#WhatsAppCallPermission": { "type": "structure", "members": { "status": { "target": "com.amazonaws.socialmessaging#WhatsAppCallPermissionStatus", "traits": { "smithy.api#documentation": "The permission status for the end user.
", "smithy.api#required": {} } }, "expirationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when a temporary permission expires. This value is absent for permanent permissions and when there is no permission.
" } } }, "traits": { "smithy.api#documentation": "The current calling permission state for a business phone number and a specific WhatsApp end user.
" } }, "com.amazonaws.socialmessaging#WhatsAppCallPermissionAction": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.socialmessaging#WhatsAppCallPermissionActionName", "traits": { "smithy.api#documentation": "The name of the calling action.
", "smithy.api#required": {} } }, "canPerformAction": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the business can currently perform the action.
", "smithy.api#required": {} } }, "limits": { "target": "com.amazonaws.socialmessaging#WhatsAppCallPermissionLimitList", "traits": { "smithy.api#documentation": "The time-bound limits that apply to the action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a single calling action the business can take with an end user, including whether the action is currently allowed and any limits that apply to it. Returned as an item in the actions list from GetWhatsAppCallPermission.
The time period over which the limit applies, as an ISO 8601 duration.
", "smithy.api#required": {} } }, "maxAllowed": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of times the action is allowed within the time period.
", "smithy.api#required": {} } }, "currentUsage": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of times the action has been used within the current time period.
", "smithy.api#required": {} } }, "limitExpirationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the limit resets. This value is present only when the current usage has reached the maximum allowed.
" } } }, "traits": { "smithy.api#documentation": "A time-bound restriction on a calling action, such as the number of calls allowed within a time period.
" } }, "com.amazonaws.socialmessaging#WhatsAppCallPermissionLimitList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WhatsAppCallPermissionLimit" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.socialmessaging#WhatsAppCallPermissionStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#WhatsAppCallSettings": { "type": "structure", "members": { "callEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether calling is enabled for the phone number.
", "smithy.api#required": {} } }, "callHours": { "target": "com.amazonaws.socialmessaging#WhatsAppCallHours", "traits": { "smithy.api#documentation": "The hours during which the business accepts calls on the phone number.
" } }, "callIconVisibility": { "target": "com.amazonaws.socialmessaging#WhatsAppCallIconVisibility", "traits": { "smithy.api#documentation": "The visibility setting for the call icon shown to end users in WhatsApp.
" } }, "callbackPermissionStatus": { "target": "com.amazonaws.socialmessaging#WhatsAppCallbackPermissionStatus", "traits": { "smithy.api#documentation": "The callback permission status for the phone number.
" } } }, "traits": { "smithy.api#documentation": "The calling configuration for a WhatsApp business phone number.
" } }, "com.amazonaws.socialmessaging#WhatsAppCallbackPermissionStatus": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.socialmessaging#WhatsAppConversionEventBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 1024000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#WhatsAppDatasetId": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 20 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.socialmessaging#WhatsAppDate": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 10 }, "smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, "com.amazonaws.socialmessaging#WhatsAppDayOfWeek": { "type": "enum", "members": { "MONDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MONDAY" } }, "TUESDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TUESDAY" } }, "WEDNESDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEDNESDAY" } }, "THURSDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THURSDAY" } }, "FRIDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FRIDAY" } }, "SATURDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SATURDAY" } }, "SUNDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUNDAY" } } } }, "com.amazonaws.socialmessaging#WhatsAppDestinationPhoneNumber": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^\\+[1-9]\\d{1,14}$", "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#WhatsAppDisplayPhoneNumber": { "type": "string", "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.socialmessaging#WhatsAppHolidayScheduleEntry": { "type": "structure", "members": { "date": { "target": "com.amazonaws.socialmessaging#WhatsAppDate", "traits": { "smithy.api#documentation": "The date that the override applies to, in ISO 8601 format (YYYY-MM-DD).
The time of day when the business begins accepting calls on the override date.
", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.socialmessaging#WhatsAppTimeOfDay", "traits": { "smithy.api#documentation": "The time of day when the business stops accepting calls on the override date.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A date-specific override to the weekly operating hours, such as a holiday.
" } }, "com.amazonaws.socialmessaging#WhatsAppHolidayScheduleList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WhatsAppHolidayScheduleEntry" }, "traits": { "smithy.api#length": { "max": 20 } } }, "com.amazonaws.socialmessaging#WhatsAppMediaId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[A-Za-z0-9]+$" } }, "com.amazonaws.socialmessaging#WhatsAppMessageBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 2048000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumber": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetail": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn", "traits": { "smithy.api#documentation": "The ARN of the WhatsApp phone number.
", "smithy.api#required": {} } }, "phoneNumber": { "target": "com.amazonaws.socialmessaging#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number for sending WhatsApp.
", "smithy.api#required": {} } }, "phoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The phone number ID from Meta.
", "smithy.api#required": {} } }, "displayPhoneNumberName": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberName", "traits": { "smithy.api#documentation": "The display name for this phone number.
", "smithy.api#required": {} } }, "displayPhoneNumber": { "target": "com.amazonaws.socialmessaging#WhatsAppDisplayPhoneNumber", "traits": { "smithy.api#documentation": "The phone number that appears in the recipients display.
", "smithy.api#required": {} } }, "qualityRating": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberQualityRating", "traits": { "smithy.api#documentation": "The quality rating of the phone number.
", "smithy.api#required": {} } }, "dataLocalizationRegion": { "target": "com.amazonaws.socialmessaging#IsoCountryCode", "traits": { "smithy.api#documentation": "The geographic region where the WhatsApp phone number's data is stored and processed.
" } } }, "traits": { "smithy.api#documentation": "The details of your WhatsApp phone number.
" } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetailList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetail" } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 115 }, "smithy.api#pattern": "(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$)" } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberName": { "type": "string", "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberQualityRating": { "type": "string", "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn", "traits": { "smithy.api#documentation": "The full Amazon Resource Name (ARN) for the phone number.
", "smithy.api#required": {} } }, "phoneNumber": { "target": "com.amazonaws.socialmessaging#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number associated with the Linked WhatsApp Business Account.
", "smithy.api#required": {} } }, "phoneNumberId": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", "traits": { "smithy.api#documentation": "The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The phone number ID from Meta.
", "smithy.api#required": {} } }, "displayPhoneNumberName": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberName", "traits": { "smithy.api#documentation": "The display name for this phone number.
", "smithy.api#required": {} } }, "displayPhoneNumber": { "target": "com.amazonaws.socialmessaging#WhatsAppDisplayPhoneNumber", "traits": { "smithy.api#documentation": "The phone number that appears in the recipients display.
", "smithy.api#required": {} } }, "qualityRating": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberQualityRating", "traits": { "smithy.api#documentation": "The quality rating of the phone number. This is from Meta.
", "smithy.api#required": {} } }, "dataLocalizationRegion": { "target": "com.amazonaws.socialmessaging#IsoCountryCode", "traits": { "smithy.api#documentation": "The geographic region where the WhatsApp phone number's data is stored and processed.
" } } }, "traits": { "smithy.api#documentation": "The details of a linked phone number.
" } }, "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummaryList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummary" } }, "com.amazonaws.socialmessaging#WhatsAppSetupFinalization": { "type": "structure", "members": { "associateInProgressToken": { "target": "com.amazonaws.socialmessaging#AssociateInProgressToken", "traits": { "smithy.api#documentation": "An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.
", "smithy.api#required": {} } }, "phoneNumberParent": { "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { "smithy.api#documentation": "Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the waba field is present.
Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the phoneNumberParent field is present.
The details of linking a WhatsApp Business Account to your Amazon Web Services account.
" } }, "com.amazonaws.socialmessaging#WhatsAppSignupCallback": { "type": "structure", "members": { "accessToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The access token for your WhatsApp Business Account. The accessToken value is provided by Meta.
The URL where WhatsApp will send callback notifications for this account.
", "smithy.api#length": { "max": 100 } } } }, "traits": { "smithy.api#documentation": "Contains the accessToken provided by Meta during signup.
An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.
" } } }, "traits": { "smithy.api#documentation": "Contains the results of WhatsAppSignupCallback.
" } }, "com.amazonaws.socialmessaging#WhatsAppTimeOfDay": { "type": "structure", "members": { "hours": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The hour of the day, from 0 to 23.
", "smithy.api#range": { "min": 0, "max": 23 }, "smithy.api#required": {} } }, "minutes": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The minute of the hour, from 0 to 59.
", "smithy.api#range": { "min": 0, "max": 59 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A time of day, expressed as an hour and minute.
" } }, "com.amazonaws.socialmessaging#WhatsAppWeeklyOperatingHoursEntry": { "type": "structure", "members": { "dayOfWeek": { "target": "com.amazonaws.socialmessaging#WhatsAppDayOfWeek", "traits": { "smithy.api#documentation": "The day of the week that the entry applies to.
", "smithy.api#required": {} } }, "openTime": { "target": "com.amazonaws.socialmessaging#WhatsAppTimeOfDay", "traits": { "smithy.api#documentation": "The time of day when the business begins accepting calls.
", "smithy.api#required": {} } }, "closeTime": { "target": "com.amazonaws.socialmessaging#WhatsAppTimeOfDay", "traits": { "smithy.api#documentation": "The time of day when the business stops accepting calls.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A single entry in a weekly calling schedule, defining the open and close times for one day of the week.
" } }, "com.amazonaws.socialmessaging#WhatsAppWeeklyOperatingHoursList": { "type": "list", "member": { "target": "com.amazonaws.socialmessaging#WhatsAppWeeklyOperatingHoursEntry" }, "traits": { "smithy.api#length": { "max": 14 } } }, "com.amazonaws.socialmessaging#ZeroTapTermsAccepted": { "type": "boolean" } } }