Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
social-ug-011	social-ug.pdf	11	quality rating in WhatsApp The quality of your phone number and messages is determined by Meta. Your messaging quality score is based on how your messages have been received by customers over the past seven days, with more recent messages weighted more heavily. The messaging quality score is calculated based on a combination of quality signals from the conversations between you and your WhatsApp users. These signals include user feedback like blocks, reports, and the reasons users provide when they block a business. Meta evaluates the quality of your messages based on how well they are received by your customers on WhatsApp, with a focus on recent feedback and interactions. WhatsApp phone number quality ratings • Green: High quality • Yellow: Medium quality • Red: Low quality WhatsApp phone number status • Connected: You can send messages within your message quota. • Flagged: Your phone number quality is low and needs to be improved. If your quality doesn't improve in seven days, your phone number status is changed to Connected but your business- initiated conversation limit is lowered one tier. • Restricted: You have reached your business-initiated conversation limit for the current 24-hour period. You can still respond to incoming messages. Once the 24-hour period is over, you can send messages again. View a phone number quality rating Follow these directions to view a phone numbers quality. 1. Open the AWS End User Messaging Social console at https://console.aws.amazon.com/social- messaging/. Understanding phone number quality rating 26 AWS End User Messaging Social User Guide 2. In Business accounts, choose a WhatsApp Business Account (WABA). 3. On the Phone numbers tab, view your phone number, display name, quality rating, and the number of business-initiated conversations that you have left for the day. View a phone number quality rating 27 AWS End User Messaging Social User Guide Using message templates in AWS End User Messaging Social Important Starting on 4/1/2025 Meta will block marketing message templates sent to the US country code of +1. For more information, see Per-User Marketing Template Message Limits in the WhatsApp Business Platform Cloud API Reference. You can use message templates for message types that you use frequently, such as weekly newsletters or appointment reminders. Template messages are the only type of message that can be sent to customers who have yet to message you, or who have not sent you a message in the last 24 hours. Meta assigns each template a quality rating and status. The quality rating impacts a template's status and lowers a template's pacing or sending rate. Templates are associated with your WhatsApp Business Account (WABA), managed through the WhatsApp Manager, and reviewed by WhatsApp. You can send the following template types: • Text-based • Media-based • Interactive message • Location-based • Authentication templates with one-time password buttons • Multi-Product Message templates Meta provides pre-approved sample templates. To learn more, see Sample message templates. For more information on the types of message templates, see Message template in the WhatsApp Business Platform Cloud API Reference. 28 AWS End User Messaging Social User Guide Using message templates with WhatsApp Manager Use the WhatsApp Manager to create, modify, or check a templates status. 1. Open the AWS End User Messaging Social console at https://console.aws.amazon.com/social- messaging/. 2. Choose Business account, and then choose a WABA. 3. On the Message templates tab, choose Manage message templates. The WhatsApp manager opens in a new window where you can manage your templates by choosing Message templates. Next steps Once you've created or edited a template, you must submit it for review with WhatsApp. Meta's review can take up to 24 hours. Meta sends an email to your Business Manager admin and updates the template status in WhatsApp manager. Use the WhatsApp manager to check the status of your template. Understanding template pacing in WhatsApp Template pacing is a method, used by Meta, that allows time for early customer feedback on new or modiﬁed templates. It identiﬁes and pauses templates that receive poor engagement or feedback, giving you time to adjust the template content before sending it to too many customers. This reduces the risk of negative customer feedback impacting the business. For example, if too many customers "block" your message, or if your template has low read rates, then your template quality rating can be lowered. Template pacing aﬀects newly created templates, templates that have been unpaused, and templates without a high quality rating. Template pacing is often started by a previous history of low quality or paused templates. When a template is paced, messages using that template are sent normally up to a certain threshold determined by Meta. After that, subsequent messages are held to allow time for customer feedback. If the feedback is positive, the template pacing is then scaled up. If the feedback is negative, the template pacing
social-ug-012	social-ug.pdf	12	if your template has low read rates, then your template quality rating can be lowered. Template pacing aﬀects newly created templates, templates that have been unpaused, and templates without a high quality rating. Template pacing is often started by a previous history of low quality or paused templates. When a template is paced, messages using that template are sent normally up to a certain threshold determined by Meta. After that, subsequent messages are held to allow time for customer feedback. If the feedback is positive, the template pacing is then scaled up. If the feedback is negative, the template pacing is lowered, allowing you to adjust the template content. For more information, see Template pacing in the WhatsApp Business Platform Cloud API Reference. Using message templates with WhatsApp Manager 29 AWS End User Messaging Social User Guide Get feedback on a template's lowered status with WhatsApp Manager Meta provides information on the reason a template's status was lowered. Use the feedback from Meta to edit the template and submit it for reapproval, use a diﬀerent template, or change your application's behavior. If you edit the message template and it is reapproved, its quality rating will gradually improve as long as it doesn't receive frequent negative feedback or low read rates. 1. Open the AWS End User Messaging Social console at https://console.aws.amazon.com/social- messaging/. 2. Choose Business account, and then choose a WABA. 3. On the Message templates tab, choose Manage message templates. The WhatsApp manager opens in a new window. 4. Choose Message templates, and hover over the template. A tooltip should appear with feedback on why the rating was lowered. Understanding a template's status and quality rating in WhatsApp Each message template is assigned a quality rating based on usage, customer feedback, and customer engagement. A template can be used only if the status is Active, but the quality determines the template pacing. If a message template consistently receives negative feedback or experiences low engagement, it will cause a change in the template's status. Meta changes a template's status or quality rating automatically based on negative or positive feedback and engagement. If your template status changes, you will receive a WhatsApp Manager notiﬁcation, email, and event notiﬁcation. Use the WhatsApp manager to check the status of your template. If your template is rejected by WhatsApp, you can edit the template and resubmit for approval or ﬁle an appeal with WhatsApp. To learn more, see Appeals in the WhatsApp Business Platform Cloud API Reference. Get feedback on a templates lowered status 30 AWS End User Messaging Social User Guide Template status Quality rating Meaning In-Review Rejected Active Pending Active High Active Medium Active Low The message template is being reviewed. This can take up to 24 hours to complete. The message template was rejected, and you can ﬁle an appeal. The message template hasn't receive quality feedback or read rate information from customers, but the template can still be used to send messages. The message template has received little to no negative customer feedback and can be used to send messages. The message template has received negative feedback from customers, or low read rates, and may be paused or turned oﬀ. The message template has received negative feedback from customers, or low read rates. Message templates with this status can be used, but are at risk of being paused or disabled. When a template moves to the Active-Low status, its Template status and quality rating 31 AWS End User Messaging Social User Guide Template status Quality rating Meaning Paused Disabled Appeal Requested sending is paused. The ﬁrst pause is three hours, the second pause is six hours, and the next pause disables the template. The message template has been paused due to recurring negative feedback from customers, or low read rates. The message template has been disabled due to recurring negative feedback from customers. An appeal has been requested . Reasons why a template is rejected in WhatsApp If your message template is reviewed and rejected by Meta, you will receive an email explaining why the template was rejected. You can appeal the rejection or modify your message template. These are some of the common reasons Meta might reject a message template: • Variable parameters contain special characters, such as a #, $, or %. • Variable parameters are missing, have mismatched curly braces, or are not sequential. • The message template contains content that violates either WhatsApp Commerce Policy or WhatsApps Business Policy. For more information, see Common Rejection Reasons in the WhatsApp Business Platform Cloud API Reference. Reasons why a template is rejected 32 AWS End User Messaging Social User Guide Message and event destinations in AWS End User Messaging Social An event destination is an Amazon SNS topic or Amazon Connect instance that WhatsApp events are sent to.
social-ug-013	social-ug.pdf	13	template: • Variable parameters contain special characters, such as a #, $, or %. • Variable parameters are missing, have mismatched curly braces, or are not sequential. • The message template contains content that violates either WhatsApp Commerce Policy or WhatsApps Business Policy. For more information, see Common Rejection Reasons in the WhatsApp Business Platform Cloud API Reference. Reasons why a template is rejected 32 AWS End User Messaging Social User Guide Message and event destinations in AWS End User Messaging Social An event destination is an Amazon SNS topic or Amazon Connect instance that WhatsApp events are sent to. When you turn on event publishing, all of your send and receive events are sent to the message and event destination. Use events to monitor, track, and analyze the status of outbound messages and incoming customer communications. Each WhatsApp Business Account (WABA) can have one event destination. All events from all resources associated to the WhatsApp Business Account are logged to that event destination. For example, you could have a WhatsApp Business Account with three phone numbers associated to it and all events from those phone numbers are logged to the one event destination. Topics • Add a message and event destination to AWS End User Messaging Social • Message and event format in AWS End User Messaging Social • WhatsApp message status Add a message and event destination to AWS End User Messaging Social When you turn on message and event publishing, all of the events generated by your WhatsApp Business Account (WABA) are sent to the Amazon SNS topic. This includes events for each phone number associated to a WhatsApp Business Account. Your WABA can have one Amazon SNS topic associated with it. Prerequisites Before you begin, the following prerequisites must be met to use either an Amazon SNS topic or Amazon Connect instance as a message and event destination. Amazon SNS topic • An Amazon SNS topic has been created and permissions have been added. Add an event destination 33 AWS End User Messaging Social User Guide Note Amazon SNS FIFO topics are not supported. • (Optional) To use an Amazon SNS topic that is encrypted using AWS KMS keys you have to grant AWS End User Messaging Social permissions to the existing key policy. Amazon Connect instance • An Amazon Connect instances has been created and permissions have been added. Add a message and event destination 1. Open the AWS End User Messaging Social console at https://console.aws.amazon.com/social- messaging/. 2. Choose Business account, and then choose a WABA. 3. On the Event destination tab, choose Edit destination. 4. 5. To turn on an event destination, choose Enable. For Destination type choose either Amazon SNS or Amazon Connect a. To send your events to an Amazon SNS destination, enter an existing topic ARN in Topic ARN. For example IAM policies, see IAM policies for Amazon SNS topics. b. For Amazon Connect i. ii. For Connect instance choose an instance from the drop down. For Two-way channel role, choose either: A. Choose existing IAM role – Choose an existing IAM policy from the Existing IAM roles drop down. For example IAM policies, see IAM policies for Amazon Connect. B. Enter IAM role ARN – Enter the ARN of the IAM policy into Use existing IAM role Arn. For example IAM policies, see IAM policies for Amazon Connect. 6. Choose Save changes. Add a message and event destination 34 AWS End User Messaging Social User Guide Encrypted Amazon SNS topic policies You can use Amazon SNS topics that are encrypted using AWS KMS keys for an additional level of security. This added security can be helpful if your application handles private or sensitive data. For more information about encrypting Amazon SNS topics using AWS KMS keys, see Enable compatibility between event sources from AWS services and encrypted topics in the Amazon Simple Notiﬁcation Service Developer Guide. Note Amazon SNS FIFO topics are not supported. The example statement uses the, optional but recommended, SourceAccount and SourceArn conditions to avoid the confused deputy problem and only the AWS End User Messaging Social owner account has access. For more information on the confused deputy problem, see The confused deputy problem in the IAM user guide. The key that you use must be symmetric. Encrypted Amazon SNS topics don't support asymmetric AWS KMS keys. The key policy must be modiﬁed to allow AWS End User Messaging Social to use the key. Follow the directions in Changing a key policy, in the AWS Key Management Service Developer Guide, to add the following permissions to the existing key policy: { "Effect": "Allow", "Principal": { "Service": "social-messaging.amazonaws.com" }, "Action": [ "kms:GenerateDataKey", "kms:Decrypt" ], "Resource": "", "Condition": { "StringEquals": { "aws:SourceAccount": "{ACCOUNT_ID}" }, "ArnLike": { "aws:SourceArn": "arn:{PARTITION}:social-messaging:{REGION}:{ACCOUNT_ID}:*" Encrypted Amazon SNS topic policies 35 AWS End User Messaging Social
social-ug-014	social-ug.pdf	14	user guide. The key that you use must be symmetric. Encrypted Amazon SNS topics don't support asymmetric AWS KMS keys. The key policy must be modiﬁed to allow AWS End User Messaging Social to use the key. Follow the directions in Changing a key policy, in the AWS Key Management Service Developer Guide, to add the following permissions to the existing key policy: { "Effect": "Allow", "Principal": { "Service": "social-messaging.amazonaws.com" }, "Action": [ "kms:GenerateDataKey", "kms:Decrypt" ], "Resource": "", "Condition": { "StringEquals": { "aws:SourceAccount": "{ACCOUNT_ID}" }, "ArnLike": { "aws:SourceArn": "arn:{PARTITION}:social-messaging:{REGION}:{ACCOUNT_ID}:" Encrypted Amazon SNS topic policies 35 AWS End User Messaging Social User Guide } } } IAM policies for Amazon SNS topics To use an existing IAM role or to create a new role, attach the following policy to that role so that AWS End User Messaging Social can assume it. For information about how to modify the trust relationship of a role, see Modifying a Role in the IAM user guide. The following is the permission policy for the IAM role. The permission policy allows for publishing to Amazon SNS topics. In the following IAM permission policy, make the following changes: • Replace {PARTITION} with the AWS partition that you use AWS End User Messaging Social in. • Replace {REGION} with the AWS Region that you use AWS End User Messaging Social in. • Replace {ACCOUNT} with the unique ID for your AWS account. • Replace {TOPIC_NAME} with the Amazon SNS topics that will receive messages. { "Effect": "Allow", "Principal": { "Service": [ "social-messaging.amazonaws.com" ] }, "Action": "sns:Publish", "Resource": "arn:{PARTITION}:sns:{REGION}:{ACCOUNT}:{TOPIC_NAME}" } IAM policies for Amazon Connect If you want AWS End User Messaging Social to use an existing IAM role or if you create a new role, attach the following policies to that role so that AWS End User Messaging Social can assume it. For information about how to modify an existing trust relationship of a role, see Modifying a Role in the IAM user guide. This role is used for both sending events and importing phone numbers from AWS End User Messaging Social into Amazon Connect. IAM policies for Amazon SNS topics 36 AWS End User Messaging Social User Guide To create new IAM polices, do the following: 1. Create a new permission policy by following the directions in Creating policies using the JSON editor in the IAM User Guide. • In step 5 use the permission policy for the IAM role to allow for publishing to Amazon Connect. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowOperationsForEventDelivery", "Effect": "Allow", "Action": [ "connect:SendIntegrationEvent" ], "Resource": "" }, { "Sid": "AllowOperationsForPhoneNumberImport", "Effect": "Allow", "Action": [ "connect:ImportPhoneNumber", "social-messaging:GetLinkedWhatsAppBusinessAccountPhoneNumber", "social-messaging:TagResource" ], "Resource": "*" } ] } 2. Create a new trust policy by following the directions in Creating a role using custom trust policies in the IAM User Guide. a. In step 4 use the trust policy for the IAM role. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { IAM policies for Amazon Connect 37 AWS End User Messaging Social User Guide "Service": [ "social-messaging.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] } b. In step 10 add the permission policy that you created in the previous step. Next steps Once you have set up your Amazon SNS topic, you must subscribe an endpoint to the topic. The endpoint will start to receive messages published to the associated topic. For more information on subscribing to a topic, see Subscribing to an Amazon SNS topic in the Amazon SNS Developer Guide. Message and event format in AWS End User Messaging Social The JSON object for an event contains the AWS event header and WhatsApp JSON payload. For a list of the JSON WhatsApp notiﬁcation payload and values, see Webhooks Notiﬁcation Payload Reference and Message Status in the WhatsApp Business Platform Cloud API Reference. AWS End User Messaging Social event header The JSON object for an event contains the AWS event header and WhatsApp JSON. The header contains the AWS identiﬁers and ARNs of your WhatsApp Business Account (WABA) and phone number. { "context": { "MetaWabaIds": [ { "wabaId": "1234567890abcde", "arn": "arn:aws:social-messaging:us-east-1:123456789012:waba/ fb2594b8a7974770b128a409e2example" } ], "MetaPhoneNumberIds": [ { "metaPhoneNumberId": "abcde1234567890", Next steps 38 AWS End User Messaging Social User Guide "arn": "arn:aws:social-messaging:us-east-1:123456789012:phone-number- id/976c72a700aac43eaf573ae050example" } ] }, "whatsAppWebhookEntry": "{\"...JSON STRING....", "aws_account_id": "123456789012", "message_timestamp": "2025-01-08T23:30:43.271279391Z", "messageId": "6d69f07a-c317-4278-9d5c-6a84078419ec" } //Decoding the contents of whatsAppWebhookEntry { //WhatsApp notification payload } In the preceding example event: • 1234567890abcde is the WABA id from Meta. • abcde1234567890 is the phone number id from Meta. • fb2594b8a7974770b128a409e2example is the ID of the WhatsApp Business Account (WABA). • 976c72a700aac43eaf573ae050example is the ID of the phone number. Example WhatsApp JSON for receiving a message The following shows the event record for an incoming message from WhatsApp. The JSON received from WhatsApp in the whatsAppWebhookEntry is received as a JSON string and can be
social-ug-015	social-ug.pdf	15	] }, "whatsAppWebhookEntry": "{\"...JSON STRING....", "aws_account_id": "123456789012", "message_timestamp": "2025-01-08T23:30:43.271279391Z", "messageId": "6d69f07a-c317-4278-9d5c-6a84078419ec" } //Decoding the contents of whatsAppWebhookEntry { //WhatsApp notification payload } In the preceding example event: • 1234567890abcde is the WABA id from Meta. • abcde1234567890 is the phone number id from Meta. • fb2594b8a7974770b128a409e2example is the ID of the WhatsApp Business Account (WABA). • 976c72a700aac43eaf573ae050example is the ID of the phone number. Example WhatsApp JSON for receiving a message The following shows the event record for an incoming message from WhatsApp. The JSON received from WhatsApp in the whatsAppWebhookEntry is received as a JSON string and can be converted to JSON. For a list of ﬁelds and their meaning, see Webhooks Notiﬁcation Payload Reference in the WhatsApp Business Platform Cloud API Reference. { "context": { "MetaWabaIds": [ { "wabaId": "1234567890abcde", "arn": "arn:aws:social-messaging:us-east-1:123456789012:waba/ fb2594b8a7974770b128a409e2example" } ], "MetaPhoneNumberIds": [ Example WhatsApp JSON for a message 39 AWS End User Messaging Social { User Guide "metaPhoneNumberId": "abcde1234567890", "arn": "arn:aws:social-messaging:us-east-1:123456789012:phone-number- id/976c72a700aac43eaf573ae050example" } ] }, "whatsAppWebhookEntry": "{\"...JSON STRING....", "aws_account_id": "123456789012", "message_timestamp": "2025-01-08T23:30:43.271279391Z", "messageId": "6d69f07a-c317-4278-9d5c-6a84078419ec" } You can use a tool, such as jq, to convert the JSON string to JSON. The following is the whatsAppWebhookEntry in JSON form: { "id": "503131219501234", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "14255550123", "phone_number_id": "46271669example" }, "statuses": [ { "id": "wamid.HBgLMTkxNzM5OTI3MzkVAgARGBJBMTM4NDdGRENEREI5Rexample", "status": "sent", "timestamp": "1736379042", "recipient_id": "01234567890", "conversation": { "id": "62374592e84cb58e52bdaed31example", "expiration_timestamp": "1736461020", "origin": { "type": "utility" } }, "pricing": { "billable": true, "pricing_model": "CBP", "category": "utility" Example WhatsApp JSON for a message 40 AWS End User Messaging Social User Guide } } ] }, "field": "messages" } ] } Example WhatsApp JSON for receiving a media message The following shows the event record for an incoming media message. To retrieve the media ﬁle, use the GetWhatsAppMessageMedia API command. For a list of ﬁelds and their meaning, see Webhooks Notiﬁcation Payload Reference { //AWS End User Messaging Social header } //Decoding the contents of whatsAppWebhookEntry { "id": "365731266123456", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "12065550100", "phone_number_id": "321010217760100" }, "contacts": [ { "profile": { "name": "Diego" }, "wa_id": "12065550102" } ], "messages": [ { "from": "14255550150", "id": "wamid.HBgLMTQyNTY5ODgzMDIVAgASGCBDNzBDRjM5MDU2ODEwMDkwREY4ODBDRDE0RjVGRkexample", "timestamp": "1723506230", Example WhatsApp JSON for a media message 41 AWS End User Messaging Social User Guide "type": "image", "image": { "mime_type": "image/jpeg", "sha256": "BTD0xlqSZ7l02o+/upusiNStlEZhA/urkvKf143Uqjk=", "id": "530339869524171" } } ] }, "field": "messages" } ] } WhatsApp message status When you send a message, you receive status updates about the message. You have to enable event logging to receive these notiﬁcations, see Message and event destinations in AWS End User Messaging Social. Message statuses The following table contains possible message statuses. Status name deleted delivered failed read Description The customer deleted the message, and you should also delete the message if it was downloaded to your server. The message was successfully delivered to the customer. The message failed to send. The customer read the message. This status is only sent if the customer has read receipts turned on. Message status 42 AWS End User Messaging Social User Guide Status name sent warning Description The message has been sent but is still in transit. The message contains an item that is unavailable or doesn't exist. Additional resources For more information, see Message Status in the WhatsApp Business Platform Cloud API Reference. Additional resources 43 AWS End User Messaging Social User Guide Uploading media ﬁles to send with WhatsApp When you send or receive a media ﬁle, it has to be stored in an Amazon S3 bucket and uploaded or retrieved from WhatsApp. The Amazon S3 bucket must be in the same AWS account and AWS Region as your WhatsApp Business Account (WABA). These directions show how to create an Amazon S3 bucket, upload a ﬁle, and build the URL to the ﬁle. For more information on Amazon S3 commands, see Use high-level (s3) commands with the AWS CLI. For more information on conﬁguring the AWS CLI, see Conﬁgure the AWS CLI in the AWS Command Line Interface User Guide, and Creating a bucket, and Uploading objects in the Amazon S3 User Guide. Note WhatsApp stores media ﬁles for 30 days before deleting them, see Upload Media in the WhatsApp Business Platform Cloud API Reference. You can also create a presigned URL to the media ﬁle. With a presigned URL, you can grant time- limited access to objects and upload them without requiring another party to have AWS security credentials or permissions. 1. To create an Amazon S3 bucket, use the create-bucket AWS CLI command. At the command line, enter the following command: aws s3api create-bucket --region 'us-east-1' --bucket BucketName In the preceding command: • Replace us-east-1 with the AWS Region that your WABA is in. • Replace BucketName with the name of the new bucket. 2. To copy a ﬁle to the Amazon S3
social-ug-016	social-ug.pdf	16	You can also create a presigned URL to the media ﬁle. With a presigned URL, you can grant time- limited access to objects and upload them without requiring another party to have AWS security credentials or permissions. 1. To create an Amazon S3 bucket, use the create-bucket AWS CLI command. At the command line, enter the following command: aws s3api create-bucket --region 'us-east-1' --bucket BucketName In the preceding command: • Replace us-east-1 with the AWS Region that your WABA is in. • Replace BucketName with the name of the new bucket. 2. To copy a ﬁle to the Amazon S3 bucket, use the cp AWS CLI command. At the command line, enter the following command: aws s3 cp SourceFilePathAndName s3://BucketName/FileName In the preceding command: • Replace SourceFilePathAndName with the ﬁle path and name of the ﬁle to copy. 44 AWS End User Messaging Social User Guide • Replace BucketName with the name of the bucket. • Replace FileName with the name to use for the ﬁle. The url to use when sending is: s3://BucketName/FileName To create a presigned URL, replace the user input placeholders with your own information. aws s3 presign s3://amzn-s3-demo-bucket1/mydoc.txt --expires-in 604800 --region af- south-1 --endpoint-url https://s3.af-south-1.amazonaws.com The returned URL will be: https://amzn-s3-demo-bucket1.s3.af- south-1.amazonaws.com/mydoc.txt?{Headers} 3. Upload the media ﬁle to WhatsApp using the post-whatsapp-message-media command. On successful completion, the command will return the {MEDIA_ID}, which is required for sending the media message. aws socialmessaging post-whatsapp-message-media --origination- phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --source-s3-file bucketName={BUCKET},key={MEDIA_FILE} In the preceding command, do the following: • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. • Replace {BUCKET} with the name of the Amazon S3 bucket. • Replace {MEDIA_FILE} with the name of the media ﬁle. You can also upload using a presign url by using --source-s3-presigned-url instead of --source-s3-file. You must add Content-Type in the headers ﬁeld. If you use both then an InvalidParameterException is returned. --source-s3-presigned-url headers={"Name":"Value"},url=https://BUCKET.s3.REGION/ MEDIA_FILE 45 AWS End User Messaging Social User Guide 4. On successful completion the MEDIA_ID is returned. The MEDIA_ID is used to reference the media ﬁle when sending a media message. Supported media ﬁle types and sizes in WhatsApp When sending or receiving a media message, the ﬁle type must be supported and under the maximum ﬁle size. For more information, see Supported Media Types in the WhatsApp Business Platform Cloud API Reference. Media ﬁle types Audio formats Audio Type Extension MIME Type Max Size .aac .amr .mp3 .m4a .ogg AAC AMR MP3 MP4 Audio OGG Audio Document formats audio/aac audio/amr audio/mpeg audio/mp4 audio/ogg 16 MB 16 MB 16 MB 16 MB 16 MB Document Type Extension MIME Type Max Size Text .text text/plain Microsoft Excel .xls, .xlsx application/vnd.ms -excel, application/ vnd.openxmlform ats-oﬃcedocument .spreadsheetml.sheet 100 MB 100 MB Microsoft Word .doc, .docx application/msword , application/vnd.op 100 MB Supported media ﬁle types 46 AWS End User Messaging Social User Guide Document Type Extension MIME Type Max Size Microsoft PowerPoint .ppt, .pptx enxmlformats-oﬃc edocument.wordproc essingml.document application/vnd.ms- powerpoint, applicati on/vnd.openxmlform ats-oﬃcedocument .presentationml.pr esentation 100 MB PDF .pdf application/pdf 100 MB Image formats Image Type Extension MIME Type Max Size JPEG PNG .jpeg .png image/jpeg image/png 5 MB 5 MB Sticker formats Sticker Type Extension MIME Type Max Size Animated sticker .webp image/webp Static sticker .webp image/webp 500 KB 100 KB Video formats Video Type Extension MIME Type Max Size 3GPP MP4 Video Media ﬁle types .3gp .mp4 video/3gp video/mp4 16 MB 16 MB 47 AWS End User Messaging Social User Guide WhatsApp message types This topic lists the supported message types and a description of their use. For a list of message types, see Messages in the WhatsApp Business Platform Cloud API Reference. Message Type Description Text Media Reaction Template Location Contacts Interactive Send a text message or URL to your customer. Send an audio, document, image, sticker, or video ﬁle. You can also send links of the media ﬁle. Send an emoji as a reaction to a message, like a thumbs up. Send a template message. Send a location. Send a contact card. Send an interactive message. Additional resources For a list of WhatsApp message objects, see Messages in the WhatsApp Business Platform Cloud API Reference. Additional resources 48 AWS End User Messaging Social User Guide Sending messages through WhatsApp with AWS End User Messaging Social Before sending a message, you must set up your WhatsApp Business Account (WABA), and your user must opt in to receive messages from you. For more information, see Obtain permission. When a user messages you, a 24-hour timer called a customer service window starts or refreshes. All message types, except for template messages, can only be sent when a customer service window is open between you and the user. Template messages can be sent at any time, as long as the user has opted in to receive messages from you. For each message that you
social-ug-017	social-ug.pdf	17	AWS End User Messaging Social Before sending a message, you must set up your WhatsApp Business Account (WABA), and your user must opt in to receive messages from you. For more information, see Obtain permission. When a user messages you, a 24-hour timer called a customer service window starts or refreshes. All message types, except for template messages, can only be sent when a customer service window is open between you and the user. Template messages can be sent at any time, as long as the user has opted in to receive messages from you. For each message that you send or receive, a message status is generated and sent to the event destination. If your customer has not signed up for WhatsApp, an event is generated with a message status of fail. You must turn on a message and event destination to receive the message status. For a list of message types, see Messages in the WhatsApp Business Platform Cloud API Reference. Important Working with Meta/WhatsApp • Your use of the WhatsApp Business Solution is subject to the terms and conditions of the WhatsApp Business Terms of Service, the WhatsApp Business Solution Terms, the WhatsApp Business Messaging Policy, the WhatsApp Messaging Guidelines, and all other terms, policies, or guidelines incorporated therein by reference. These might be updated from time to time. • Meta or WhatsApp may at any time prohibit your use of the WhatsApp Business Solution. • In connection with your use of the WhatsApp Business Solution, you will not submit any content, information, or data that is subject to safeguarding or limitations on distribution pursuant to applicable laws or regulations. Topics • Example of sending a template message in AWS End User Messaging Social • Example of sending a media message in AWS End User Messaging Social 49 AWS End User Messaging Social User Guide Example of sending a template message in AWS End User Messaging Social For more information on the types of message templates that can be sent, see Message template in the WhatsApp Business Platform Cloud API Reference. For a list of message types that can be sent, see Messages in the WhatsApp Business Platform Cloud API Reference. The following example shows how to use a template to send a message to your customer using the AWS CLI. For more information on conﬁguring the AWS CLI, see Conﬁgure the AWS CLI in the AWS Command Line Interface User Guide. Note You must specify base64 encoding when you use the AWS CLI version 2. This can be done by adding the AWS CLI paramater --cli-binary-format raw-in-base64- out or changing the AWS CLI global conﬁguration ﬁle. For more information, see cli_binary_format in the AWS Command Line Interface User Guide for Version 2. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","to":"'{PHONE_NUMBER}'","type":"template","template": {"name":"statement","language":{"code":"en_US"},"components": [{"type":"body","parameters":[{"type":"text","text":"1000"}]}]}}' --origination-phone- number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 In the preceding command, do the following: • Replace {PHONE_NUMBER} with your customer's phone number. • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. The following example shows how to send a template message that doesn't contain any components. aws socialmessaging send-whatsapp-message --message '{"messaging_product": "whatsapp","to": "'{PHONE_NUMBER}'","type": "template","template": {"name":"simple_template","language": {"code": "en_US"}}}' --origination-phone-number- id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 Send a template message 50 AWS End User Messaging Social User Guide • Replace {PHONE_NUMBER} with your customer's phone number. • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. Example of sending a media message in AWS End User Messaging Social The following example shows how to send a media message to your customer using the AWS CLI. For more information on conﬁguring the AWS CLI, see Conﬁgure the AWS CLI in the AWS Command Line Interface User Guide. For a list of supported media ﬁle types, see Supported media ﬁle types and sizes in WhatsApp. Note WhatsApp stores media ﬁles for 30 days before deleting them, see Upload Media in the WhatsApp Business Platform Cloud API Reference. 1. Upload the media ﬁle to an Amazon S3 bucket. For more information, see Uploading media ﬁles to send with WhatsApp. 2. Upload the media ﬁle to WhatsApp using the post-whatsapp-message-media command. On successful completion, the command will return the {MEDIA_ID}, which is required for sending the media message. aws socialmessaging post-whatsapp-message-media --origination- phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --source-s3-file bucketName={BUCKET},key={MEDIA_FILE} In the preceding command, do the following: • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. • Replace {BUCKET} with the name of the Amazon S3 bucket. • Replace {MEDIA_FILE} with the name of the media ﬁle. You can also upload using a presign url by using --source-s3-presigned-url instead of --source-s3-file. You must add Content-Type in the headers ﬁeld. If you use both then an InvalidParameterException is returned. Sending a media message 51 AWS End User Messaging Social User Guide --source-s3-presigned-url headers={"Name":"Value"},url=https://BUCKET.s3.REGION/ MEDIA_FILE 3. Use the send-whatsapp-message command to send the media message. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","to":"'{PHONE_NUMBER}'","type":"image","image": {"id":"'{MEDIA_ID}'"}}' --origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 Note You
social-ug-018	social-ug.pdf	18	do the following: • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. • Replace {BUCKET} with the name of the Amazon S3 bucket. • Replace {MEDIA_FILE} with the name of the media ﬁle. You can also upload using a presign url by using --source-s3-presigned-url instead of --source-s3-file. You must add Content-Type in the headers ﬁeld. If you use both then an InvalidParameterException is returned. Sending a media message 51 AWS End User Messaging Social User Guide --source-s3-presigned-url headers={"Name":"Value"},url=https://BUCKET.s3.REGION/ MEDIA_FILE 3. Use the send-whatsapp-message command to send the media message. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","to":"'{PHONE_NUMBER}'","type":"image","image": {"id":"'{MEDIA_ID}'"}}' --origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 Note You must specify base64 encoding when you use the AWS CLI version 2. This can be done by adding the AWS CLI paramater --cli-binary-format raw-in-base64- out or changing the AWS CLI global conﬁguration ﬁle. For more information, see cli_binary_format in the AWS Command Line Interface User Guide for Version 2. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","to":"'{PHONE_NUMBER}'","type":"image","image": {"id":"'{MEDIA_ID}'"}}' --origination-phone-number- id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 --cli-binary- format raw-in-base64-out In the preceding command, do the following: • Replace {PHONE_NUMBER} with your customer's phone number. • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. • Replace {MEDIA_ID} with the media ID returned from the previous step. 4. When you no longer need the media ﬁle, you can delete it from WhatsApp using the delete- whatsapp-message-media command. This only removes the media ﬁle from WhatsApp and not your Amazon S3 bucket. aws socialmessaging delete-whatsapp-message-media --media-id {MEDIA_ID} -- origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} In the preceding command, do the following: Sending a media message 52 AWS End User Messaging Social User Guide • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. • Replace {MEDIA_ID} with the media ID. Sending a media message 53 AWS End User Messaging Social User Guide Responding to a message in AWS End User Messaging Social Before you can receive a text or media message, you must have set up your WhatsApp Business Account (WABA) and an event destination. When you receive an incoming message, an event is saved in the event destination Amazon SNS topic. To receive a notiﬁcation, you must subscribe to the Amazon SNS topics endpoint. For an example event of a received media message, see Example WhatsApp JSON for receiving a media message. For more information on conﬁguring the AWS CLI, see Conﬁgure the AWS CLI in the AWS Command Line Interface User Guide. For a list of supported media ﬁle types, see Supported media ﬁle types and sizes in WhatsApp. Important To receive incoming messages, you must have event destinations enabled for the WABA. For more information, see Add a message and event destination to AWS End User Messaging Social. Example of changing a message's status to read in AWS End User Messaging Social You can set the status of the message to read to show the end user two blue check marks on their screen. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","message_id":"'{MESSAGE_ID}'","status":"read"}' -- origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 In the preceding command, do the following: • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. • Replace {MESSAGE_ID} with the unique identiﬁer of the message. Use the value of the id ﬁeld in the message object of the Amazon SNS topic. Change a message's status to read 54 AWS End User Messaging Social User Guide Example of responding to a message with a reaction in AWS End User Messaging Social You can add a reaction to the message, like a thumbs up. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","recipient_type":"individual","to":"'{PHONE_NUMBER}'","type": "reaction","reaction": {"message_id": "'{MESSAGE_ID}'","emoji":"\uD83D\uDC4D"}}' -- origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 In the preceding command, do the following: • Replace {PHONE_NUMBER} with your customer's phone number. • Replace {MESSAGE_ID} with the unique identiﬁer of the message. Use the value of the id ﬁeld in the message object of the Amazon SNS topic. • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. Download a media ﬁle from WhatsApp to Amazon S3 To retrieve a media ﬁle and save it to an Amazon S3 bucket, use the get-whatsapp-message-media command. aws socialmessaging get-whatsapp-message-media --media-id {MEDIA_ID} -- origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --destination-s3-file bucketName={BUCKET},key=inbound_ { "mimeType": "image/jpeg", "fileSize": 78144 } In the preceding command, do the following: • Replace {BUCKET} with the name of the Amazon S3 bucket. • Replace {MEDIA_ID} with the value of the id ﬁeld from the received event. For an example incoming media event, see Example WhatsApp JSON for receiving a media message. • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. Respond with a reaction 55 AWS End User Messaging Social User Guide To retrieve the media from the Amazon S3 bucket, use the following command: aws s3 cp s3://{BUCKET}/inbound_{MEDIA_ID}.jpeg In the preceding command, do the following: • Replace {BUCKET} with the name of the Amazon S3 bucket. • Replace {MEDIA_ID} with the MEDIA_ID returned from the previous step. Example of responding to a message with a read receipt and reaction In this example, your customer, Diego, sent you
social-ug-019	social-ug.pdf	19	an example incoming media event, see Example WhatsApp JSON for receiving a media message. • Replace {ORIGINATION_PHONE_NUMBER_ID} with your phone number's ID. Respond with a reaction 55 AWS End User Messaging Social User Guide To retrieve the media from the Amazon S3 bucket, use the following command: aws s3 cp s3://{BUCKET}/inbound_{MEDIA_ID}.jpeg In the preceding command, do the following: • Replace {BUCKET} with the name of the Amazon S3 bucket. • Replace {MEDIA_ID} with the MEDIA_ID returned from the previous step. Example of responding to a message with a read receipt and reaction In this example, your customer, Diego, sent you a message saying "Hi" and you respond to him with a read receipt and hand wave emoji. Prerequisites To receive a notiﬁcation that Diego sent a message, you must have set up an event destination Amazon SNS topic and subscribed to a topic endpoint. Responding 1. When the message from Diego is received, an event is published to the endpoints of the topic. The following is a snippet of what the topic publishes. Note Because Diego initiated the conversation, it doesn't count against the quota for your business initiated conversations. The whatsAppWebhookEntry in this example is shown in JSON notation. For an example of converting the whatsAppWebhookEntry from JSON sting to JSON, see Example WhatsApp JSON for receiving a message. { "context": { "MetaWabaIds": [ { Example of responding to a message 56 AWS End User Messaging Social User Guide "wabaId": "1234567890abcde", "arn": "arn:aws:social-messaging:us-east-1:123456789012:waba/ fb2594b8a7974770b128a409e2example" } ], "MetaPhoneNumberIds": [ { "metaPhoneNumberId": "abcde1234567890", "arn": "arn:aws:social-messaging:us-east-1:123456789012:phone-number- id/976c72a700aac43eaf573ae050example" } ] }, "whatsAppWebhookEntry": "{\"...JSON STRING....", "aws_account_id": "123456789012", "message_timestamp": "2025-01-08T23:30:43.271279391Z" } //Decoding the contents of whatsAppWebhookEntry { "id": "365731266123456", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "12065550100", "phone_number_id": "321010217712345" }, "contacts": [ { "profile": { "name": "Diego" }, "wa_id": "12065550102" } ], "messages": [ { "from": "14255550150", "id": "wamid.HBgLMTQyNTY5ODgzMDIVAgASGCBDNzBDRjM5MDU2ODEwMDkwREY4ODBDRDE0RjVGRkexample", "timestamp": "1723506035", "text": { "body": "Hi" Responding 57 AWS End User Messaging Social User Guide }, "type": "text" } ] }, "field": "messages" } ] } 2. To show Diego you received the message, set the status to read. Diego will see two blue check marks next to the message on his device. Note You must specify base64 encoding when you use the AWS CLI version 2. This can be done by adding the AWS CLI paramater --cli-binary-format raw-in-base64- out or changing the AWS CLI global conﬁguration ﬁle. For more information, see cli_binary_format in the AWS Command Line Interface User Guide for Version 2. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","message_id":"'{MESSAGE_ID}'","status":"read"}' --origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 In the preceding command, do the following: • Replace {ORIGINATION_PHONE_NUMBER_ID} with the phone number ID that Diego sent his message to phone-number-id-976c72a700aac43eaf573ae050example. • Replace {MESSAGE_ID} with the unique identiﬁer of the message. This is the same value of the id ﬁeld in the received message wamid.HBgLMTQyNTY5ODgzMDIVAgASGCBDNzBDRjM5MDU2ODEwMDkwREY4ODBDRDE0RjVGRkexample. 3. You can send Diego a hand wave reaction. aws socialmessaging send-whatsapp-message --message '{"messaging_product":"whatsapp","recipient_type":"individual","to":"'{PHONE_NUMBER}'","type": "reaction","reaction": {"message_id": "'{MESSAGE_ID}'","emoji":"\uD83D\uDC4B"}}' Responding 58 AWS End User Messaging Social User Guide --origination-phone-number-id {ORIGINATION_PHONE_NUMBER_ID} --meta-api-version v20.0 In the preceding command, do the following: • Replace {PHONE_NUMBER} with Diego's phone number, 14255550150. • Replace {MESSAGE_ID} with the unique identiﬁer of the message. This is the same value of the id ﬁeld in the received message wamid.HBgLMTQyNTY5ODgzMDIVAgASGCBDNzBDRjM5MDU2ODEwMDkwREY4ODBDRDE0RjVGRkexample. • Replace {ORIGINATION_PHONE_NUMBER_ID} with the phone number ID that Diego sent his message to: phone-number-id-976c72a700aac43eaf573ae050example. Additional resources • Enable event destinations to log events and receive incoming messages. • For a list of WhatsApp message objects, see Messages in the WhatsApp Business Platform Cloud API Reference. Additional resources 59 AWS End User Messaging Social User Guide Understanding WhatsApp billing and usage reports for AWS End User Messaging Social The AWS End User Messaging Social channel generates a usage type that contains ﬁve ﬁelds in the following format: Region code–MessagingType–ISO–FeeDescription–FeeType. There are two possible billing items for each WhatsApp conversation the WhatsApp ConversationFee, and the AWS per MessageFee. When you initiate a conversation by sending a template message, you are billed for one WhatsApp ConversationFee and one AWS per MessageFee. This opens a 24-hour window where each message that you send or receive from the same customer is billed as an AWS per MessageFee. The WhatsApp Conversation type and pricing detail can be found at Conversation-Based Pricing in the WhatsApp Business Platform Developer Guide. The following table displays the possible values and descriptions for the ﬁelds in the usage type. For more information about AWS End User Messaging Social pricing, see WhatsApp in AWS End User Messaging Pricing. Field Options Description Region code • USE1 – US East (N. Virginia) Region • USE2 – US East (Ohio) Region • USW1 – US West (Oregon) Region • APS1 – Asia Paciﬁc (Mumbai) Region • APSE1 – Asia Paciﬁc (Singapore) Region • EUW1 – Europe (Ireland) Region • EUW2 – Europe (London) Region The AWS Region preﬁx that
social-ug-020	social-ug.pdf	20	Pricing in the WhatsApp Business Platform Developer Guide. The following table displays the possible values and descriptions for the ﬁelds in the usage type. For more information about AWS End User Messaging Social pricing, see WhatsApp in AWS End User Messaging Pricing. Field Options Description Region code • USE1 – US East (N. Virginia) Region • USE2 – US East (Ohio) Region • USW1 – US West (Oregon) Region • APS1 – Asia Paciﬁc (Mumbai) Region • APSE1 – Asia Paciﬁc (Singapore) Region • EUW1 – Europe (Ireland) Region • EUW2 – Europe (London) Region The AWS Region preﬁx that indicates where the WhatsApp message was sent or received from. 60 AWS End User Messaging Social User Guide Field Options Description MessagingType WhatsApp ISO See supported countries This ﬁeld identiﬁes the message type being sent. The two–digit ISO country code that the message was sent to. FeeDescription ConversationFee , This ﬁeld speciﬁes either MessageFee the WhatsApp Conversat ionFee or the AWS per MessageFee . 61 AWS End User Messaging Social User Guide Field FeeType Options Description Authentication , Authentication-Int This ﬁeld displays the type of conversation type was used, ernational , Marketing or speciﬁes standard for the , Service, Utility, per message fee Standard Business initiated ConversationFee categories • Marketing – Used to achieve a wide range of goals, from generating awareness to driving sales and retargeting customers . Examples include new product, service, or feature announcements, targeted promotions/oﬀers, and cart abandonment reminders. • Utility – Used to follow up on user actions or requests. Examples include opt-in conﬁrmation, order/ delivery management (for example a delivery update); account updates or alerts (for example a payment reminder); or feedback surveys. • Authentication – Used to authenticate users with one-time passcodes , potentially at multiple steps in the login process (for example account 62 AWS End User Messaging Social User Guide Field Options Description veriﬁcation, account recovery, and integrity challenges). • Authentication-Int – Used ernational the same as Authentic ation but your business is eligible for Authentic ation-International rates, based in another country, and the conversation was opened on or after the start time for the country. • Service – Used to resolve customer inquiries. User initiated Conversat ionFee categories • Service – Used to resolve customer inquiries. MessageFee categories • Standard – Per message sent or received fee. When you initiate a conversation by sending a template message, you are billed for one ConversationFee and one MessageFee. This opens a 24-hour window where each template message that you send to the same customer is billed as an individual MessageFee. During the 24- hour window, the template messages must be the same type or a new conversation is started. For example, if you send a marketing template message to a customer you are billed for the ConversationFee and MessageFee. 63 AWS End User Messaging Social User Guide Marketing Template Message 1: APS1-WhatsApp-CA-ConversationFee-Marketing Marketing Template Message 1: APS1-WhatsApp-CA-MessageFee-Standard Marketing Template Message 2: APS1-WhatsApp-CA-MessageFee-Standard If the customer sends you a message and you respond, then you are billed for opening a new Service conversation and message. Service Message 1: APS1-WhatsApp-CA-ConversationFee-Service Service Message 1: APS1-WhatsApp-CA-MessageFee-Standard Service Message 2: APS1-WhatsApp-CA-MessageFee-Standard Service Message 3: APS1-WhatsApp-CA-MessageFee-Standard When does the Authentication-International FeeType apply For a list of countries with an Authentication-International FeeType, see WhatsApp in AWS End User Messaging Pricing. If you open an Authentication conversation with a WhatsApp user whose country calling code has an Authentication-International FeeType, you will be billed that country's Authentication-International rate if: 1. Your business opens more than 750K conversations in a moving 30-day period across all of your WhatsApp Business Accounts with WhatsApp users whose country calling codes are for a country that has an Authentication-International rate. For more information, see Eligibility in the WhatsApp Business Platform Developer Guide. Important If Meta determines that your business is eligible for Authentication-International then they will attempt to send you an email notiﬁcation with applicable countries and moving 30-day period start times. 2. Your business is based in another country. For more information on managing your business's location, see Primary business location in the WhatsApp Business Platform Developer Guide. 3. The conversation was opened on or after your start time for that country When does the Authentication-International FeeType apply 64 AWS End User Messaging Social User Guide Example 1: Sending a Marketing template message For example, if you send a marketing template message to a customer, you are billed for one WhatsApp ConversationFee and one AWS per MessageFee. Marketing Template Message 1: APS1-WhatsApp-CA-ConversationFee-Marketing Marketing Template Message 1: APS1-WhatsApp-CA-MessageFee-Standard Example 2: Opening a Service conversation A service conversation fee applies when a business responds to a user's inbound message that falls outside of any active 24-hour conversation window initiated by the business. In this scenario, you are billed one WhatsApp ConversationFee and an AWS MessageFee for each
social-ug-021	social-ug.pdf	21	Authentication-International FeeType apply 64 AWS End User Messaging Social User Guide Example 1: Sending a Marketing template message For example, if you send a marketing template message to a customer, you are billed for one WhatsApp ConversationFee and one AWS per MessageFee. Marketing Template Message 1: APS1-WhatsApp-CA-ConversationFee-Marketing Marketing Template Message 1: APS1-WhatsApp-CA-MessageFee-Standard Example 2: Opening a Service conversation A service conversation fee applies when a business responds to a user's inbound message that falls outside of any active 24-hour conversation window initiated by the business. In this scenario, you are billed one WhatsApp ConversationFee and an AWS MessageFee for each inbound and outbound message. Service Message 1: APS1-WhatsApp-CA-ConversationFee-Service Service Message 1: APS1-WhatsApp-CA-MessageFee-Standard Service Message 2: APS1-WhatsApp-CA-MessageFee-Standard Service Message 3: APS1-WhatsApp-CA-MessageFee-Standard AWS End User Messaging Social billing ISO codes and WhatsApp Conversation Fee mapping Supported countries Two-digit ISO country code Country name WhatsApp conversation billing region AF AX AL DZ AS Afghanistan Rest of Asia Paciﬁc Aland Islands Other Albania Algeria Rest of Central & Eastern Europe Rest of Africa American Samoa Other Example 1: Sending a Marketing template message 65 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region AD AO AI AQ AG AR AM AW AC AU AT AZ BS BH BD BB BY BE Andorra Angola Anguilla Antarctica Antigua and Barbuda Argentina Armenia Aruba Ascension Island Australia Austria Azerbaijan Bahamas Bahrain Other Rest of Africa Other Other Other Argentina Rest of Central & Eastern Europe Other Other Rest of Asia Paciﬁc Rest of Western Europe Rest of Central & Eastern Europe Other Rest of Middle East Bangladesh Rest of Asia Paciﬁc Barbados Belarus Other Rest of Central & Eastern Europe Belgium Rest of Western Europe Billing ISO codes 66 AWS End User Messaging Social User Guide Two-digit ISO country code Country name BZ BJ BM BT BO BQ BA BW BV BR IO VG BN BG BF BI KH CM CA Belize Benin Bermuda Bhutan Bolivia Bonaire Bosnia and Herzegovina WhatsApp conversation billing region Other Rest of Africa Other Other Rest of Latin America Other Other Botswana Rest of Africa Bouvet Island Brazil Other Brazil British Indian Ocean Territory Other British Virgin Islands Brunei Darussalam Other Other Bulgaria BurkinaFaso Burundi Cambodia Cameroon Canada Rest of Central & Eastern Europe Rest of Africa Rest of Africa Rest of Asia Paciﬁc Rest of Africa North America Billing ISO codes 67 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region CV KY CF TD CL CN CX CC CO KM CK CR CI HR CW CY CZ CD Cape Verde Cayman Islands Other Other Central African Republic Other Chad Chile China Christmas Island Cocos(Keeling) Islands Colombia Comoros Cook Islands Costa Rica Rest of Africa Chile Rest of Asia Paciﬁc Other Other Colombia Other Other Rest of Latin America Cote d'Ivoire Rest of Africa Croatia Curacao Cyprus Rest of Central & Eastern Europe Other Other Czech Republic Rest of Central & Eastern Europe Democratic Republic of the Congo Rest of Africa Billing ISO codes 68 AWS End User Messaging Social User Guide Two-digit ISO country code Country name DK DJ DM DO EC EG SV GQ ER EE ET SZ FK FO FJ FI FR GF PF TF Denmark Djibouti Dominica WhatsApp conversation billing region Rest of Western Europe Other Other Dominican Republic Rest of Latin America Ecuador Egypt Rest of Latin America Egypt El Salvador Rest of Latin America Equatorial Guinea Other Eritrea Estonia Ethiopia Eswatini Falkland Islands Faroe Islands Fiji Finland France French Guiana French Polynesia Rest of Africa Other Rest of Africa Rest of Africa Other Other Other Rest of Western Europe France Other Other French Southern Territories Other Billing ISO codes 69 AWS End User Messaging Social User Guide Two-digit ISO country code Country name Gabon Gambia Georgia Germany Ghana Gibraltar Greece Greenland Grenada Guadeloupe Guam Guatemala Guernsey Guinea WhatsApp conversation billing region Rest of Africa Rest of Africa Rest of Central & Eastern Europe Germany Rest of Africa Other Rest of Central & Eastern Europe Other Other Other Other Rest of Latin America Other Other Guinea-Bissau Rest of Africa Guyana Haiti Other Rest of Latin America Heard and McDonald Islands Other Honduras Rest of Latin America Billing ISO codes 70 GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN AWS End User Messaging Social User Guide Two-digit ISO country code Country name HK HU IS IN ID IQ IE IM IL IT JM JP JE JO KZ KE KI XK KW Hong Kong Hungary Iceland India WhatsApp conversation billing region Rest of Asia Paciﬁc Rest of Central & Eastern Europe Other India Indonesia Indonesia Iraq Ireland Isle of Man Israel Italy Jamaica Japan Jersey Jordan Rest of Middle East Rest
social-ug-022	social-ug.pdf	22	Other Honduras Rest of Latin America Billing ISO codes 70 GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN AWS End User Messaging Social User Guide Two-digit ISO country code Country name HK HU IS IN ID IQ IE IM IL IT JM JP JE JO KZ KE KI XK KW Hong Kong Hungary Iceland India WhatsApp conversation billing region Rest of Asia Paciﬁc Rest of Central & Eastern Europe Other India Indonesia Indonesia Iraq Ireland Isle of Man Israel Italy Jamaica Japan Jersey Jordan Rest of Middle East Rest of Western Europe Other Israel Italy Rest of Latin America Rest of Asia Paciﬁc Other Rest of Middle East Kazakhstan Other Kenya Kiribati Kosovo Kuwait Rest of Africa Other Other Rest of Middle East Billing ISO codes 71 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT Kyrgyzstan Other Lao PDR Latvia Lebanon Lesotho Liberia Libya Rest of Asia Paciﬁc Rest of Central & Eastern Europe Rest of Middle East Rest of Africa Rest of Africa Rest of Africa Liechtenstein Other Lithuania Luxembourg Macao Macedonia Madagascar Malawi Malaysia Maldives Mali Malta Rest of Central & Eastern Europe Other Other Rest of Central & Eastern Europe Rest of Africa Rest of Africa Malaysia Other Rest of Africa Other Billing ISO codes 72 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia Moldova Monaco Mongolia Montenegro Montserrat Morocco Other Other Rest of Africa Other Other Mexico Other Rest of Central & Eastern Europe Other Rest of Asia Paciﬁc Other Other Rest of Africa Mozambique Rest of Africa Myanmar Namibia Nauru Nepal Other Rest of Africa Other Rest of Asia Paciﬁc Netherlands Netherlands Billing ISO codes 73 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN New Caledonia Other New Zealand Rest of Asia Paciﬁc Nicaragua Rest of Latin America Niger Nigeria Niue Norfolk Island Rest of Africa Nigeria Other Other Northern Mariana Islands Other Norway Oman Pakistan Palau Palestinian Territory Rest of Western Europe Rest of Middle East Pakistan Other Other Panama Rest of Latin America Papua New Guinea Rest of Asia Paciﬁc Paraguay Peru Philippines Pitcairn Rest of Latin America Peru Rest of Asia Paciﬁc Other Billing ISO codes 74 AWS End User Messaging Social User Guide Two-digit ISO country code Country name PL PT PR QA CG RE RO RU RW SH KN LC PM VC BL MF WS SM ST Poland Portugal Puerto Rico Qatar Republic of Congo Reunion Romania WhatsApp conversation billing region Rest of Central & Eastern Europe Rest of Western Europe Rest of Latin America Rest of Middle East Other Other Rest of Central & Eastern Europe Russian Federation Russia Rwanda Saint Helena Saint Kitts and Nevis Saint Lucia Rest of Africa Other Other Other Saint Pierre and Miquelon Other Saint Vincent and Grenadines Other Saint-Barthelemy Saint-Martin Samoa San Marino Sao Tome and Principe Other Other Other Other Other Billing ISO codes 75 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region SA SN RS SC SL SG SX SK SI SB SO ZA GS KR SS ES LK Saudi Arabia Saudi Arabia Senegal Serbia Rest of Africa Rest of Central & Eastern Europe Seychelles Other Sierra Leone Rest of Africa Singapore Rest of Asia Paciﬁc Sint Maarten Other Slovakia Slovenia Rest of Central & Eastern Europe Rest of Central & Eastern Europe Solomon Islands Other Somalia Rest of Africa South Africa South Africa South Georgia and the South Sandwich Islands Other South Korea Other South Sudan Rest of Africa Spain Sri Lanka Spain Rest of Asia Paciﬁc Billing ISO codes 76 AWS End User Messaging Social User Guide Two-digit ISO country code Country name WhatsApp conversation billing region SR SJ SE CH TW TJ TZ TH TL TG TK TO TT TA TN TR TM TC TV Suriname Svalbard and Jan Mayen Islands Other Other Sweden Rest of Western Europe Switzerland Rest of Western Europe Taiwan Tajikistan Tanzania Thailand Rest of Asia Paciﬁc Rest of Asia Paciﬁc Rest of Africa Rest of Asia Paciﬁc Timor-Leste Other Togo Tokelau Tonga Trinidad and Tobago Tristan da Cunha Tunisia Turkey Rest of Africa Other Other Other Other Rest of Africa Turkey Turkmenistan Rest of Asia Paciﬁc Turks and Caicos Islands Tuvalu Other
social-ug-023	social-ug.pdf	23	ISO country code Country name WhatsApp conversation billing region SR SJ SE CH TW TJ TZ TH TL TG TK TO TT TA TN TR TM TC TV Suriname Svalbard and Jan Mayen Islands Other Other Sweden Rest of Western Europe Switzerland Rest of Western Europe Taiwan Tajikistan Tanzania Thailand Rest of Asia Paciﬁc Rest of Asia Paciﬁc Rest of Africa Rest of Asia Paciﬁc Timor-Leste Other Togo Tokelau Tonga Trinidad and Tobago Tristan da Cunha Tunisia Turkey Rest of Africa Other Other Other Other Rest of Africa Turkey Turkmenistan Rest of Asia Paciﬁc Turks and Caicos Islands Tuvalu Other Other Billing ISO codes 77 AWS End User Messaging Social User Guide Two-digit ISO country code Country name UG UA AE GB US UY UM UZ VU VA VE VN VI WF EH YE ZM ZW Uganda Ukraine WhatsApp conversation billing region Rest of Africa Rest of Central & Eastern Europe United Arab Emirates United Arab Emirates United Kingdom United Kingdom United States North America Uruguay Rest of Latin America US Minor Outlying Islands Other Uzbekistan Vanuatu Vatican City State Venezuela Vietnam Rest of Asia Paciﬁc Other Other Rest of Latin America Rest of Asia Paciﬁc Virgin Islands Other Wallis and Futuna Islands Other Western Sahara Other Yemen Zambia Rest of Middle East Rest of Africa Zimbabwe Other Billing ISO codes 78 AWS End User Messaging Social User Guide Monitoring AWS End User Messaging Social Monitoring is an important part of maintaining the reliability, availability, and performance of AWS End User Messaging Social and your other AWS solutions. AWS provides the following monitoring tools to watch AWS End User Messaging Social, report when something is wrong, and take automatic actions when appropriate: • Amazon CloudWatch monitors your AWS resources and and the applications you run on AWS in real time. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a speciﬁed metric reaches a threshold that you specify. For example, you can have CloudWatch track CPU usage or other metrics of your Amazon EC2 instances and automatically launch new instances when needed. For more information, see the Amazon CloudWatch User Guide. • Amazon CloudWatch Logs enables you to monitor, store, and access your log ﬁles from Amazon EC2 instances, CloudTrail, and other sources. CloudWatch Logs can monitor information in the log ﬁles and notify you when certain thresholds are met. You can also archive your log data in highly durable storage. For more information, see the Amazon CloudWatch Logs User Guide. • AWS CloudTrail captures API calls and related events made by or on behalf of your AWS account and delivers the log ﬁles to an Amazon S3 bucket that you specify. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see the AWS CloudTrail User Guide. Monitoring AWS End User Messaging Social with Amazon CloudWatch You can monitor AWS End User Messaging Social using CloudWatch, which collects raw data and processes it into readable, near real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on how your web application or service is performing. You can also set alarms that watch for certain thresholds, and send notiﬁcations or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. For AWS End User Messaging Social, you might want to watch for WhatsAppMessageFeeCount, and also watch WhatsAppConversationFeeCount and trigger an alarm when a spend threshold has been reached. Monitoring with CloudWatch 79 AWS End User Messaging Social User Guide Note Before you can use the CloudWatch metrics you must create a service-link role. The following tables list the metrics and dimensions that AWS End User Messaging Social exports to the AWS/SocialMessaging namespace. Metric WhatsAppConversati onFeeCount Unit Count WhatsAppMessageFeeCount Count Description The count of WhatsApp conversation fees The count of WhatsApp message fees Dimension MessageFeeType Description Valid fee types are Service, Marketing, Utility, and Authentication DestinationCountryCode The two letter ISO code for the country WhatsAppPhoneNumberArn The arn of the phone number Logging AWS End User Messaging Social API calls using AWS CloudTrail AWS End User Messaging Social is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for AWS End User Messaging Social as events. The calls captured include calls from the AWS End User Messaging Social console and code calls to the AWS End User Messaging Social API operations. Using the information collected by CloudTrail, you can determine the request that was made to AWS End User Messaging Social, the IP address from which the request was made, when
social-ug-024	social-ug.pdf	24	API calls using AWS CloudTrail AWS End User Messaging Social is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for AWS End User Messaging Social as events. The calls captured include calls from the AWS End User Messaging Social console and code calls to the AWS End User Messaging Social API operations. Using the information collected by CloudTrail, you can determine the request that was made to AWS End User Messaging Social, the IP address from which the request was made, when it was made, and additional details. CloudTrail logs 80 AWS End User Messaging Social User Guide Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root user or user credentials. • Whether the request was made on behalf of an IAM Identity Center user. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail Event history. The CloudTrail Event history provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see Working with CloudTrail Event history in the AWS CloudTrail User Guide. There are no CloudTrail charges for viewing the Event history. For an ongoing record of events in your AWS account past 90 days, create a trail or a CloudTrail Lake event data store. CloudTrail trails A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. All trails created using the AWS Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the AWS CLI. Creating a multi-Region trail is recommended because you capture activity in all AWS Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's AWS Region. For more information about trails, see Creating a trail for your AWS account and Creating a trail for an organization in the AWS CloudTrail User Guide. You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. For information about Amazon S3 pricing, see Amazon S3 Pricing. CloudTrail Lake event data stores CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control which events persist CloudTrail logs 81 AWS End User Messaging Social User Guide and are available for you to query. For more information about CloudTrail Lake, see Working with AWS CloudTrail Lake in the AWS CloudTrail User Guide. CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the pricing option you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention period for the event data store. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. AWS End User Messaging Social data events in CloudTrail Data events provide information about the resource operations performed on or in a resource (for example, reading or writing to an Amazon S3 object). These are also known as data plane operations. Data events are often high-volume activities. By default, CloudTrail doesn’t log data events. The CloudTrail Event history doesn't record data events. Additional charges apply for data events. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. You can log data events for the AWS End User Messaging Social resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see Logging data events with the AWS Management Console and Logging data events with the AWS Command Line Interface in the AWS CloudTrail User Guide. The following table lists the AWS End User Messaging Social resource types for which you can log data events. The Data event type (console) column shows the value to choose from the Data event type list on the CloudTrail console. The resources.type value column shows the resources.type value, which you would
social-ug-025	social-ug.pdf	25	Messaging Social resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see Logging data events with the AWS Management Console and Logging data events with the AWS Command Line Interface in the AWS CloudTrail User Guide. The following table lists the AWS End User Messaging Social resource types for which you can log data events. The Data event type (console) column shows the value to choose from the Data event type list on the CloudTrail console. The resources.type value column shows the resources.type value, which you would specify when conﬁguring advanced event selectors using the AWS CLI or CloudTrail APIs. The Data APIs logged to CloudTrail column shows the API calls logged to CloudTrail for the resource type. Data event type (console) resources.type value Data APIs logged to CloudTrail Social-Messaging Phone Number ID AWS::SocialMessagi • DeleteWhatsAppMess ng::PhoneNumberId ageMedia • GetWhatsAppMessage Media AWS End User Messaging Social data events in CloudTrail 82 AWS End User Messaging Social User Guide Data event type (console) resources.type value Data APIs logged to CloudTrail • PostWhatsAppMessag eMedia • SendWhatsAppMessage You can conﬁgure advanced event selectors to ﬁlter on the eventName, readOnly, and resources.ARN ﬁelds to log only those events that are important to you. For more information about these ﬁelds, see AdvancedFieldSelector in the AWS CloudTrail API Reference. AWS End User Messaging Social management events in CloudTrail Management events provide information about management operations that are performed on resources in your AWS account. These are also known as control plane operations. By default, CloudTrail logs management events. AWS End User Messaging Social logs all AWS End User Messaging Social control plane operations as management events. For a list of the AWS End User Messaging Social control plane operations that AWS End User Messaging Social logs to CloudTrail, see the AWS End User Messaging Social API Reference. AWS End User Messaging Social event examples An event represents a single request from any source and includes information about the requested API operation, the date and time of the operation, request parameters, and so on. CloudTrail log ﬁles aren't an ordered stack trace of the public API calls, so events don't appear in any speciﬁc order. The following example shows a CloudTrail event that demonstrates the operation. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "GR632462JDSBDSHHGS39:session", "arn": "arn:aws:sts::123456789101:assumed-role/Role_name/Session_name", "accountId": "123456789101", "accessKeyId": "12345678901234567890", "sessionContext": { AWS End User Messaging Social management events in CloudTrail 83 AWS End User Messaging Social User Guide "sessionIssuer": { "type": "Role", "principalId": "GR632462JDSBDEXAMPLE", "arn": "arn:aws:sts::123456789101:assumed-role/Role_name/ Session_name", "accountId": "123456789101", "userName": "user" }, "attributes": { "creationDate": "2024-10-03T17:25:08Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-10-03T17:25:23Z", "eventSource": "social-messaging.amazonaws.com", "eventName": "SendWhatsAppMessage", "awsRegion": "us-east-1", "sourceIPAddress": "1.x.x.x", "userAgent": "agent", "requestParameters": { "originationPhoneNumberId": "phone-number-id- aa012345678901234567890123456789", "metaApiVersion": "v20.0", "message": "Hi" }, "responseElements": { "messageId": "message_id" }, "requestID": "request_id", "eventID": "event_id", "readOnly": false, "resources": [{ "accountId": "123456789101", "type": "AWS::SocialMessaging::PhoneNumberId", "ARN": "arn:aws:social-messaging:us-east-1:123456789101:phone-number-id/ phone-number-id-aa012345678901234567890123456789" }], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "123456789101", "eventCategory": "Data", "tlsDetails": { "clientProvidedHostHeader": "social-messaging.us-east-1.amazonaws.com" AWS End User Messaging Social event examples 84 AWS End User Messaging Social } } User Guide For information about CloudTrail record contents, see CloudTrail record contents in the AWS CloudTrail User Guide. AWS End User Messaging Social event examples 85 AWS End User Messaging Social User Guide Best practices for AWS End User Messaging Social This section describes several best practices that might help you improve your customer engagement and avoid account suspension. However, note that this section doesn't contain legal advice. Always consult an attorney to obtain legal advice. For the most recent list of WhatsApp best practices, see the WhatsApp Business Messaging Policy. Topics • Up-to-date business proﬁle • Obtain permission • Prohibited message content • Audit your customer lists • Adjust your sending based on engagement • Send at appropriate times Up-to-date business proﬁle Maintain an accurate and up-to-date WhatsApp Business proﬁle that includes customer support contact information, such as an email address, website address, or telephone number. Ensure that the information provided is truthful and does not misrepresent or impersonate another business. Obtain permission Never send messages to recipients who haven't explicitly asked to receive the speciﬁc types of messages that you plan to send. Maintain the following opt-in information: • The opt-in process must clearly inform the person that they are consenting to receive messages or calls from your business over WhatsApp. You must explicitly state the name of your business. • You are solely responsible for determining the method of obtaining opt-in consent. Ensure that the opt-in process complies with all applicable laws governing your communications. Provide all required notices and obtain all necessary permissions under relevant laws. For more information on WhatsApp Opt-in requirements, see Get Opt-in for WhatsApp Up-to-date business proﬁle 86 AWS End User Messaging Social User Guide If recipients can sign up to receive your
social-ug-026	social-ug.pdf	26	The opt-in process must clearly inform the person that they are consenting to receive messages or calls from your business over WhatsApp. You must explicitly state the name of your business. • You are solely responsible for determining the method of obtaining opt-in consent. Ensure that the opt-in process complies with all applicable laws governing your communications. Provide all required notices and obtain all necessary permissions under relevant laws. For more information on WhatsApp Opt-in requirements, see Get Opt-in for WhatsApp Up-to-date business proﬁle 86 AWS End User Messaging Social User Guide If recipients can sign up to receive your messages by using an online form, prevent automated scripts from subscribing people without their knowledge. Also limit the number of times a user can submit a phone number in a single session. Respect all requests made by a person, whether on or oﬀ WhatsApp, to block, discontinue, or otherwise opt out of communications, including removing that person from your contacts list. Maintain records that include the date, time, and source of each opt-in request and conﬁrmation. This can also help you perform routine audits of your customer list. Prohibited message content Important Working with Meta/WhatsApp • Your use of the WhatsApp Business Solution is subject to the terms and conditions of the WhatsApp Business Terms of Service, the WhatsApp Business Solution Terms, the WhatsApp Business Messaging Policy, the WhatsApp Messaging Guidelines, and all other terms, policies, or guidelines incorporated therein by reference (as each may be updated from time to time). • Meta or WhatsApp may at any time prohibit your use of the WhatsApp Business Solution. • In connection with your use of the WhatsApp Business Solution, you will not submit any content, information, or data that is subject to safeguarding or limitations on distribution according to applicable laws or regulation. If you violate the WhatsApp policy your account could be blocked from sending messages for a period of time, locked until you ﬁle an appeal, or permanently blocked. Meta will inform you if any of your accounts or assets have violated the policy, through email and the WhatsApp Business Manager. All appeals must be made to Meta. To view a policy violate or ﬁle an appeal with Meta, see View policy violation details for your WhatsApp Business account in the Meta Business Help Center. For the most recent list of prohibited message content, see the WhatsApp Business Messaging Policy. The following are prohibited content categories for all message types globally. When sending a message with WhatsApp, follow these guidelines: Prohibited message content 87 AWS End User Messaging Social User Guide Category Gambling Examples • Casinos • Sweepstakes • App/Websites High-risk ﬁnancial services • Payday loans • Short-term high-interest loans • Auto loans • Mortgage loans • Student loans • Debt collection • Stock alerts • Cryptocurrency • Debt consolidation • Debt reduction • Credit repair programs Debt forgiveness Get-rich-quick schemes • Work-from-home programs Illegal substances Phishing/smishing S.H.A.F.T. • Risk-investment opportunities • Pyramid or multi-level marketing schemes • Cannabis/CBD • Attempts to get users to reveal personal information or website login information. • Sex • Hate • Alcohol • Firearms • Tobacco/Vape Prohibited message content 88 AWS End User Messaging Social User Guide Category Examples Third-Party Lead Generation • Companies that buy, sell, or share consumer information Audit your customer lists If you send recurring WhatsApp messages, audit your customer lists on a regular basis. Auditing your customer lists helps to make sure that the only customers who receive your messages are those who want to receive them. When you audit your list, send each opted-in customer a message that reminds them that they're subscribed, and provides them with information about unsubscribing. Adjust your sending based on engagement Your customers' priorities can change over time. If customers no longer ﬁnd your messages to be useful, they might opt out of your messages entirely, or even report your messages as unsolicited. For these reasons, it's important that you adjust your sending practices based on customer engagement. For customers who rarely engage with your messages, you should adjust the frequency of your messages. For example, if you send weekly messages to engaged customers, you could create a separate monthly digest for customers who are less engaged. Finally, remove customers who are completely unengaged from your customer lists. This step prevents customers from becoming frustrated with your messages. It also saves you money and helps protect your reputation as a sender. Send at appropriate times Send messages during normal daytime business hours. If you send messages at dinner time or in the middle of the night, there's a good chance that your customers will unsubscribe from your lists to avoid being disturbed. You might want to avoid sending WhatsApp messages when your customers can't respond to them immediately. Audit your customer lists
social-ug-027	social-ug.pdf	27	customers who are less engaged. Finally, remove customers who are completely unengaged from your customer lists. This step prevents customers from becoming frustrated with your messages. It also saves you money and helps protect your reputation as a sender. Send at appropriate times Send messages during normal daytime business hours. If you send messages at dinner time or in the middle of the night, there's a good chance that your customers will unsubscribe from your lists to avoid being disturbed. You might want to avoid sending WhatsApp messages when your customers can't respond to them immediately. Audit your customer lists 89 AWS End User Messaging Social User Guide Security in AWS End User Messaging Social Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS End User Messaging Social, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using AWS End User Messaging Social. The following topics show you how to conﬁgure AWS End User Messaging Social to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your AWS End User Messaging Social resources. Topics • Data protection in AWS End User Messaging Social • Identity and access management for AWS End User Messaging Social • Compliance validation for AWS End User Messaging Social • Resilience in AWS End User Messaging Social • Infrastructure Security in AWS End User Messaging Social • Cross-service confused deputy prevention • Security best practices • Using service-linked roles for AWS End User Messaging Social 90 AWS End User Messaging Social User Guide Data protection in AWS End User Messaging Social The AWS shared responsibility model applies to data protection in AWS End User Messaging Social. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security conﬁguration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with AWS End User Messaging Social or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds used for names may be used for billing or diagnostic logs. If you provide a URL to an external server,
social-ug-028	social-ug.pdf	28	FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with AWS End User Messaging Social or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data protection 91 AWS End User Messaging Social User Guide Important WhatsApp uses the Signal protocol for secure communications. However, because AWS End User Messaging Social is a third party, WhatsApp does not consider these messages end- to-end encrypted. For more information on WhatsApp data protection, see Data Privacy & Security and WhatsApp Encryption Overview whitepaper. Data encryption AWS End User Messaging Social data is encrypted in transit and at rest within the AWS boundary. When you submit data to AWS End User Messaging Social, it encrypts the data as it's received and stores it. When you retrieve data from AWS End User Messaging Social, it transmits the data to you by using current security protocols. Encryption at rest AWS End User Messaging Social encrypts all the data that it stores for you within the AWS boundary. This includes conﬁguration data, registration data, and any data that you add into AWS End User Messaging Social. To encrypt your data, AWS End User Messaging Social uses internal AWS Key Management Service (AWS KMS) keys that the service owns and maintains on your behalf. For information about AWS KMS, see the AWS Key Management Service Developer Guide. Encryption in transit AWS End User Messaging Social uses HTTPS and Transport Layer Security (TLS) 1.2 to communicate with your clients, applications, and Meta. To communicate with other AWS services, AWS End User Messaging Social uses HTTPS and TLS 1.2. In addition, when you create and manage AWS End User Messaging Social resources by using the console, an AWS SDK, or the AWS Command Line Interface, all communications are secured using HTTPS and TLS 1.2. Key management To encrypt your data, AWS End User Messaging Social uses internal AWS KMS keys that the service owns and maintains on your behalf. We rotate these keys on a regular basis. You can't provision and use your own AWS KMS or other keys to encrypt data that you store in AWS End User Messaging Social. Data encryption 92 AWS End User Messaging Social User Guide Inter-network traﬃc privacy Internetwork traﬃc privacy refers to securing connections and traﬃc between AWS End User Messaging Social and your on-premises clients and applications, and between AWS End User Messaging Social and other AWS resources in the same AWS Region. The following features and practices can help you secure internetwork traﬃc privacy for AWS End User Messaging Social. Traﬃc between AWS End User Messaging Social and on-premises clients and applications To establish a private connection between AWS End User Messaging Social and clients and applications on your on-premises network, you can use AWS Direct Connect. This enables you to link your network to an AWS Direct Connect location by using a standard, ﬁber-optic Ethernet cable. One end of the cable is connected to your router. The other end is connected to an AWS Direct Connect router. For more information, see What is AWS Direct Connect? in the AWS Direct Connect User Guide. To help secure access to AWS End User Messaging Social through published APIs, we recommend that you comply with AWS End User Messaging Social requirements for API calls. AWS End User Messaging Social requires clients to use Transport Layer Security (TLS) 1.2 or later. Clients must also support cipher suites with perfect forward secrecy (PFS), such as Ephemeral Diﬃe-Hellman (DHE) or Elliptic Curve Diﬃe-Hellman Ephemeral (ECDHE). Most modern systems such as Java 7 and later support these modes. In addition, requests must be signed using an access key ID and a secret access key that's associated with an AWS Identity and Access Management (IAM) principal for your AWS account. Alternatively, you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Identity and access management for AWS End User Messaging Social AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS End User Messaging Social resources. IAM is an AWS service that you can use with no additional
social-ug-029	social-ug.pdf	29	secret access key that's associated with an AWS Identity and Access Management (IAM) principal for your AWS account. Alternatively, you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Identity and access management for AWS End User Messaging Social AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS End User Messaging Social resources. IAM is an AWS service that you can use with no additional charge. Topics Inter-network traﬃc privacy 93 User Guide AWS End User Messaging Social • Audience • Authenticating with identities • Managing access using policies • How AWS End User Messaging Social works with IAM • Identity-based policy examples for AWS End User Messaging Social • AWS managed policies for AWS End User Messaging Social • Troubleshooting AWS End User Messaging Social identity and access Audience How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in AWS End User Messaging Social. Service user – If you use the AWS End User Messaging Social service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS End User Messaging Social features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in AWS End User Messaging Social, see Troubleshooting AWS End User Messaging Social identity and access. Service administrator – If you're in charge of AWS End User Messaging Social resources at your company, you probably have full access to AWS End User Messaging Social. It's your job to determine which AWS End User Messaging Social features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with AWS End User Messaging Social, see How AWS End User Messaging Social works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to AWS End User Messaging Social. To view example AWS End User Messaging Social identity-based policies that you can use in IAM, see Identity-based policy examples for AWS End User Messaging Social. Audience 94 AWS End User Messaging Social User Guide Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to
social-ug-030	social-ug.pdf	30	authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Authenticating with identities 95 AWS End User Messaging Social Federated identity User Guide As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has speciﬁc permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have speciﬁc use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that speciﬁes a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are diﬀerent from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a Authenticating with identities 96 AWS End User Messaging Social User Guide role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS
social-ug-031	social-ug.pdf	31	identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the diﬀerence between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Authenticating with identities 97 AWS End User Messaging Social User Guide • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance proﬁle that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies
social-ug-032	social-ug.pdf	32	can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can Managing access using policies 98 AWS End User Messaging Social User Guide perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user Managing access using policies 99 AWS End User Messaging Social User Guide or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal ﬁeld are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy.
social-ug-033	social-ug.pdf	33	the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How AWS End User Messaging Social works with IAM Before you use IAM to manage access to AWS End User Messaging Social, learn what IAM features are available to use with AWS End User Messaging Social. How AWS End User Messaging Social works with IAM 100 AWS End User Messaging Social User Guide IAM features you can use with AWS End User Messaging Social IAM feature AWS End User Messaging Social support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys ACLs Yes No Yes Yes Yes No ABAC (tags in policies) Partial Temporary credentials Principal permissions Service roles Service-linked roles Yes Yes Yes Yes To get a high-level view of how AWS End User Messaging Social and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for AWS End User Messaging Social Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all How AWS End User Messaging Social works with IAM 101 AWS End User Messaging Social User Guide of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for AWS End User Messaging Social To view examples of AWS End User Messaging Social identity-based policies, see Identity-based policy examples for AWS End User Messaging Social. Resource-based policies within AWS End User Messaging Social Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in diﬀerent AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for AWS End User Messaging Social Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such
social-ug-034	social-ug.pdf	34	no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for AWS End User Messaging Social Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API How AWS End User Messaging Social works with IAM 102 AWS End User Messaging Social User Guide operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of AWS End User Messaging Social actions, see Actions Deﬁned by AWS End User Messaging Social in the Service Authorization Reference. Policy actions in AWS End User Messaging Social use the following preﬁx before the action: social-messaging To specify multiple actions in a single statement, separate them with commas. "Action": [ "social-messaging:action1", "social-messaging:action2" ] To view examples of AWS End User Messaging Social identity-based policies, see Identity-based policy examples for AWS End User Messaging Social. Policy resources for AWS End User Messaging Social Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a speciﬁc resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard () to indicate that the statement applies to all resources. "Resource": "" How AWS End User Messaging Social works with IAM 103 AWS End User Messaging Social User Guide To see a list of AWS End User Messaging Social resource types and their ARNs, see Resources Deﬁned by AWS End User Messaging Social in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Deﬁned by AWS End User Messaging Social . To view examples of AWS End User Messaging Social identity-based policies, see Identity-based policy examples for AWS End User Messaging Social. Policy condition keys for AWS End User Messaging Social Supports service-speciﬁc policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-speciﬁc condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of AWS End User Messaging Social condition keys, see Condition Keys for AWS End User Messaging Social in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions Deﬁned by AWS End User Messaging Social . To view examples of AWS End User Messaging Social identity-based policies, see Identity-based policy examples for AWS End User Messaging Social. How AWS End User Messaging Social works with IAM 104 AWS End User Messaging Social User Guide ACLs in AWS End User Messaging Social Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document
social-ug-035	social-ug.pdf	35	actions and resources you can use a condition key, see Actions Deﬁned by AWS End User Messaging Social . To view examples of AWS End User Messaging Social identity-based policies, see Identity-based policy examples for AWS End User Messaging Social. How AWS End User Messaging Social works with IAM 104 AWS End User Messaging Social User Guide ACLs in AWS End User Messaging Social Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with AWS End User Messaging Social Supports ABAC (tags in policies): Partial Attribute-based access control (ABAC) is an authorization strategy that deﬁnes permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the ﬁrst step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Deﬁne permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with AWS End User Messaging Social Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. How AWS End User Messaging Social works with IAM 105 AWS End User Messaging Social User Guide You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for AWS End User Messaging Social Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for AWS End User Messaging Social Supports service roles: Yes A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break AWS End User Messaging Social functionality. Edit service roles only when AWS End User Messaging Social provides guidance to do so. How AWS End User Messaging Social works with IAM 106 AWS End User Messaging Social User Guide Service-linked roles for AWS End User Messaging Social Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles,
social-ug-036	social-ug.pdf	36	User Messaging Social provides guidance to do so. How AWS End User Messaging Social works with IAM 106 AWS End User Messaging Social User Guide Service-linked roles for AWS End User Messaging Social Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for AWS End User Messaging Social By default, users and roles don't have permission to create or modify AWS End User Messaging Social resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types deﬁned by AWS End User Messaging Social, including the format of the ARNs for each of the resource types, see Actions, Resources, and Condition Keys for AWS End User Messaging Social in the Service Authorization Reference. Topics • Policy best practices • Using the AWS End User Messaging Social console • Allow users to view their own permissions Policy best practices Identity-based policies determine whether someone can create, access, or delete AWS End User Messaging Social resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: Identity-based policy examples 107 AWS End User Messaging Social User Guide • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the AWS End User Messaging Social console To access the AWS End User Messaging Social console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS End User Messaging Social resources in your AWS account. If you create an identity-based policy that is more Identity-based policy examples
social-ug-037	social-ug.pdf	37	are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the AWS End User Messaging Social console To access the AWS End User Messaging Social console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS End User Messaging Social resources in your AWS account. If you create an identity-based policy that is more Identity-based policy examples 108 AWS End User Messaging Social User Guide restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can still use the AWS End User Messaging Social console, also attach the AWS End User Messaging Social ConsoleAccess or ReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", Identity-based policy examples 109 AWS End User Messaging Social User Guide "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } AWS managed policies for AWS End User Messaging Social To add permissions to users, groups, and roles, it is easier to use AWS managed policies than to write policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. To get started quickly, you can use our AWS managed policies. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide. AWS End User Messaging Social updates to AWS managed policies AWS managed policies 110 AWS End User Messaging Social User Guide View details about updates to AWS managed policies for AWS End User Messaging Social since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the AWS End User Messaging Social Document history page. Change Description Date AWS End User Messaging Social started tracking AWS End User Messaging Social started tracking changes changes for its AWS managed October 10, 2024 policies. Troubleshooting AWS End User Messaging Social identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with AWS End User Messaging Social and IAM. Topics • I am not authorized to perform an action in AWS End User Messaging Social • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my AWS End User Messaging Social resources I am not authorized to perform an action in AWS End User Messaging Social If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a ﬁctional my-example-widget resource but doesn't
social-ug-038	social-ug.pdf	38	an action in AWS End User Messaging Social • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my AWS End User Messaging Social resources I am not authorized to perform an action in AWS End User Messaging Social If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a ﬁctional my-example-widget resource but doesn't have the ﬁctional social-messaging:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: social- messaging:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the social-messaging:GetWidget action. Troubleshooting 111 AWS End User Messaging Social User Guide If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to AWS End User Messaging Social. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in AWS End User Messaging Social. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my AWS End User Messaging Social resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether AWS End User Messaging Social supports these features, see How AWS End User Messaging Social works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. Troubleshooting 112 AWS End User Messaging Social User Guide • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance validation for AWS End User Messaging Social To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how
social-ug-039	social-ug.pdf	39	Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your Compliance validation 113 AWS End User Messaging Social User Guide compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in AWS End User Messaging Social The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. In addition to the AWS global infrastructure, AWS End User Messaging Social oﬀers several features to help support your data resiliency and backup needs. Infrastructure Security in AWS End User Messaging Social As a managed service, AWS End User Messaging Social is protected by the AWS global network security procedures that are described in the Amazon Web Services: Overview of Security Processes whitepaper. You use AWS published API calls to access AWS End User Messaging Social through the network. Clients must support Transport Layer Security (TLS) 1.0 or later. We recommend TLS 1.2 or later. Clients must also support cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Resilience 114 AWS End User Messaging Social User Guide Cross-service confused deputy prevention The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action. In AWS, cross-service impersonation can result in the confused deputy problem. Cross-service impersonation can occur when one service (the calling service) calls another service (the called service). The calling service can be manipulated to use its permissions to act on another customer's resources in a way it should not otherwise have permission to access. To prevent this, AWS provides tools that help you protect your data for all services with service principals that have been given access to resources in your account. We recommend using the aws:SourceArn and aws:SourceAccount global condition context keys in resource policies to limit the permissions that Social Messaging gives another service to the resource. Use aws:SourceArn if you want only one resource to be associated with the cross- service access. Use aws:SourceAccount if you want to allow any resource in that account to be associated with the cross-service use. The most eﬀective way to protect against the confused deputy problem is to use the aws:SourceArn global condition context key with the full ARN of the resource. If you don't know the full ARN of the resource or if you are specifying multiple resources, use the aws:SourceArn global context condition key with wildcard characters () for the unknown portions of the ARN. For example, arn:aws:social-messaging::123456789012:*. If the aws:SourceArn value does not contain the account ID, such as an Amazon S3 bucket ARN, you must use both global condition context keys to limit permissions. The value of aws:SourceArn must be ResourceDescription. The following example shows
social-ug-040	social-ug.pdf	40	to protect against the confused deputy problem is to use the aws:SourceArn global condition context key with the full ARN of the resource. If you don't know the full ARN of the resource or if you are specifying multiple resources, use the aws:SourceArn global context condition key with wildcard characters () for the unknown portions of the ARN. For example, arn:aws:social-messaging::123456789012:. If the aws:SourceArn value does not contain the account ID, such as an Amazon S3 bucket ARN, you must use both global condition context keys to limit permissions. The value of aws:SourceArn must be ResourceDescription. The following example shows how you can use the aws:SourceArn and aws:SourceAccount global condition context keys in Social Messaging to prevent the confused deputy problem. { "Version": "2012-10-17", "Statement": { "Sid": "ConfusedDeputyPreventionExamplePolicy", "Effect": "Allow", "Principal": { "Service": "social-messaging.amazonaws.com" }, "Action": "social-messaging:ActionName", Cross-service confused deputy prevention 115 AWS End User Messaging Social "Resource": [ "arn:aws:social-messaging:::ResourceName/" ], "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:social-messaging::123456789012:" }, "StringEquals": { "aws:SourceAccount": "123456789012" User Guide } } } } Security best practices AWS End User Messaging Social provides a number of security features to consider as you develop and implement your own security policies. The following best practices are general guidelines and don’t represent a complete security solution. Because these best practices might not be appropriate or suﬃcient for your environment, treat them as helpful considerations rather than prescriptions. • Create an individual user for each person who manages AWS End User Messaging Social resources, including yourself. Don't use AWS root credentials to manage AWS End User Messaging Social resources. • Grant each user the minimum set of permissions required to perform his or her duties. • Use IAM groups to eﬀectively manage permissions for multiple users. • Rotate your IAM credentials regularly. Using service-linked roles for AWS End User Messaging Social AWS End User Messaging Social uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to AWS End User Messaging Social. Service-linked roles are predeﬁned by AWS End User Messaging Social and include all the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up AWS End User Messaging Social easier because you don’t have to manually add the necessary permissions. AWS End User Messaging Social deﬁnes the Security best practices 116 AWS End User Messaging Social User Guide permissions of its service-linked roles, and unless deﬁned otherwise, only AWS End User Messaging Social can assume its roles. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete a service-linked role only after ﬁrst deleting their related resources. This protects your AWS End User Messaging Social resources because you can't inadvertently remove permission to access the resources. For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked roles column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for AWS End User Messaging Social AWS End User Messaging Social uses the service-linked role named AWSServiceRoleForSocialMessaging – To publish metrics and provide insights for your social message sending. The AWSServiceRoleForSocialMessaging service-linked role trusts the following services to assume the role: • social-messaging.amazonaws.com The role permissions policy named AWSSocialMessagingServiceRolePolicy allows AWS End User Messaging Social to complete the following actions on the speciﬁed resources: • Action: "cloudwatch:PutMetricData" on all AWS resources in the AWS/ SocialMessaging namespace. You must conﬁgure permissions to allow your users, groups, or roles to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. For updates to the policy, see AWS End User Messaging Social updates to AWS managed policies. Creating a service-linked role for AWS End User Messaging Social You can use the IAM console to create a service-linked role with the AWSEndUserMessagingSocial - Metrics use case. In the AWS CLI or the AWS API, create a service-linked role with the social- messaging.amazonaws.com service name. For more information, see Creating a service-linked Service-linked role permissions for AWS End User Messaging Social 117 AWS End User Messaging Social User Guide role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again. You can create the service-linked role for AWS End User Messaging Social with the following AWS CLI command: aws iam create-service-linked-role --aws-service-name social-messaging.amazonaws.com Editing a service-linked role for AWS End User Messaging Social AWS End User Messaging Social does not allow you to edit the AWSServiceRoleForSocialMessaging service-linked role. After you create a service-linked role, you cannot change the name of the
social-ug-041	social-ug.pdf	41	role permissions for AWS End User Messaging Social 117 AWS End User Messaging Social User Guide role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again. You can create the service-linked role for AWS End User Messaging Social with the following AWS CLI command: aws iam create-service-linked-role --aws-service-name social-messaging.amazonaws.com Editing a service-linked role for AWS End User Messaging Social AWS End User Messaging Social does not allow you to edit the AWSServiceRoleForSocialMessaging service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide. Deleting a service-linked role for AWS End User Messaging Social If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up the resources for your service-linked role before you can manually delete it. Note If the AWS End User Messaging Social service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again. To remove AWS End User Messaging Social resources used by the AWSServiceRoleForSocialMessaging 1. Call list-linked-whatsapp-business-accounts API to see the resources you have. 2. For each linked Whats App Business Account, call the disassociate-whatsapp-business- account API to remove the resource from SocialMessaging service. 3. Verify no resources are returned by calling the list-linked-whatsapp-business- accounts API again. Editing a service-linked role for AWS End User Messaging Social 118 AWS End User Messaging Social User Guide To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForSocialMessaging service-linked role. For more information, see Deleting a service-linked role in the IAM User Guide. Supported Regions for AWS End User Messaging Social service-linked roles AWS End User Messaging Social supports using service-linked roles in all of the Regions where the service is available. For more information, see AWS Regions and endpoints. Supported Regions for AWS End User Messaging Social service-linked roles 119 AWS End User Messaging Social User Guide Access AWS End User Messaging Social using an interface endpoint (AWS PrivateLink) You can use AWS PrivateLink to create a private connection between your VPC and AWS End User Messaging Social. You can access AWS End User Messaging Social as if it were in your VPC, without the use of an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to access AWS End User Messaging Social. You establish this private connection by creating an interface endpoint, powered by AWS PrivateLink. We create an endpoint network interface in each subnet that you enable for the interface endpoint. These are requester-managed network interfaces that serve as the entry point for traﬃc destined for AWS End User Messaging Social. For more information, see Access AWS services through AWS PrivateLink in the AWS PrivateLink Guide. Considerations for AWS End User Messaging Social Before you set up an interface endpoint for AWS End User Messaging Social, review Considerations in the AWS PrivateLink Guide. AWS End User Messaging Social supports making calls to all of its API actions through the interface endpoint. VPC endpoint policies are not supported for AWS End User Messaging Social. By default, full access to AWS End User Messaging Social is allowed through the interface endpoint. Alternatively, you can associate a security group with the endpoint network interfaces to control traﬃc to AWS End User Messaging Social through the interface endpoint. Create an interface endpoint for AWS End User Messaging Social You can create an interface endpoint for AWS End User Messaging Social using either the Amazon VPC console or the AWS Command Line Interface (AWS CLI). For more information, see Create an interface endpoint in the AWS PrivateLink Guide. Create an interface endpoint for AWS End User Messaging Social using the following service name: Considerations 120 AWS End User Messaging Social User Guide • com.amazonaws.region.social-messaging If you enable private DNS for the interface endpoint, you can make API requests to AWS End User Messaging Social using its default Regional DNS name. For example, service-name.us- east-1.amazonaws.com. Create an endpoint policy for your interface endpoint An endpoint policy is an IAM resource that you can attach to an interface endpoint. The default endpoint policy allows full access to AWS End User Messaging Social through the interface endpoint. To control the access allowed to AWS End User Messaging Social from your
social-ug-042	social-ug.pdf	42	Social using the following service name: Considerations 120 AWS End User Messaging Social User Guide • com.amazonaws.region.social-messaging If you enable private DNS for the interface endpoint, you can make API requests to AWS End User Messaging Social using its default Regional DNS name. For example, service-name.us- east-1.amazonaws.com. Create an endpoint policy for your interface endpoint An endpoint policy is an IAM resource that you can attach to an interface endpoint. The default endpoint policy allows full access to AWS End User Messaging Social through the interface endpoint. To control the access allowed to AWS End User Messaging Social from your VPC, attach a custom endpoint policy to the interface endpoint. An endpoint policy speciﬁes the following information: • The principals that can perform actions (AWS accounts, IAM users, and IAM roles). • The actions that can be performed. • The resources on which the actions can be performed. For more information, see Control access to services using endpoint policies in the AWS PrivateLink Guide. Example: VPC endpoint policy for AWS End User Messaging Social actions The following is an example of a custom endpoint policy. When you attach this policy to your interface endpoint, it grants access to the listed AWS End User Messaging Social actions for all principals on all resources. { "Statement": [ { "Principal": "", "Effect": "Allow", "Action": [ "social-messaging:DeleteWhatsAppMessageMedia", "social-messaging:PostWhatsAppMessageMedia", "social-messaging:SendWhatsAppMessage" ], Create an endpoint policy 121 AWS End User Messaging Social "Resource":"" } ] } User Guide Create an endpoint policy 122 AWS End User Messaging Social User Guide Quotas for AWS End User Messaging Social Your AWS account has default quotas, formerly referred to as limits, for each AWS service. Unless otherwise noted, each quota is Region-speciﬁc. You can request increases for some quotas, and other quotas cannot be increased. Your AWS account has the following quotas related to AWS End User Messaging Social. Resource Default WhatsApp Business Account (WABA) 25 per Region AWS End User Messaging Social implements quotas that restrict the number of requests that you can make to the AWS End User Messaging Social API from your AWS account. Operation Default quota rate (requests per second) SendWhatsAppMessage PostWhatsAppMessageMedia GetWhatsAppMessageMedia DeleteWhatsAppMessageMedia DisassociateWhatsAppBusinessAccount ListWhatsAppBusinessAccount TagResource UntagResourceRate ListTagsForResourceRate 1,000 100 100 100 10 10 10 10 10 123 AWS End User Messaging Social User Guide Document history for the AWS End User Messaging Social User Guide The following table describes the documentation releases for AWS End User Messaging Social. Change Description Date Regional availability Added support for Europe (Frankfurt) region. For more information, see Regional availability. December 5, 2024 Add a message and event destination Added support for Amazon Connect as an event destinati December 1, 2024 AWS PrivateLink on. For more information, see Add a message and event destination. Added support for AWS PrivateLink. For more information, see AWS PrivateLink. October 22, 2024 Initial release Initial release of the AWS End User Messaging Social User October 10, 2024 Guide 124
space-ag-001	space-ag.pdf	1	re:Post Private Administration Guide AWS re:Post Private Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS re:Post Private re:Post Private Administration Guide AWS re:Post Private: re:Post Private Administration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS re:Post Private re:Post Private Administration Guide Table of Contents What is AWS re:Post Private? ......................................................................................................... 1 Access re:Post Private .................................................................................................................................. 1 re:Post Private pricing ................................................................................................................................. 1 How to get started with re:Post Private ................................................................................................. 1 Conﬁgure your private re:Post ....................................................................................................... 2 Customize appearance ................................................................................................................................. 2 Add custom tags, custom topics, and blocked terminology ................................................................ 2 Choose your topics of interest .................................................................................................................. 4 Complete your proﬁle ..................................................................................................................... 6 Manage your private re:Post ........................................................................................................... 7 Update your branding ................................................................................................................................. 7 Deactivate a user account .......................................................................................................................... 8 Activate a user account ............................................................................................................................... 8 Add custom tags ........................................................................................................................................... 9 Add custom topics ..................................................................................................................................... 10 Add blocked terminologies ...................................................................................................................... 11 Update custom tags .................................................................................................................................. 11 Update custom topics ............................................................................................................................... 12 Delete custom tags .................................................................................................................................... 12 Delete custom topics ................................................................................................................................. 13 Delete blocked terminology .................................................................................................................... 13 Choose your topics of interest ................................................................................................................ 14 User roles ....................................................................................................................................... 15 Document history .......................................................................................................................... 16 iii AWS re:Post Private re:Post Private Administration Guide What is AWS re:Post Private? AWS re:Post Private is a private version of AWS re:Post for enterprises with Enterprise Support or Enterprise On-Ramp Support plans. It provides access to knowledge and experts to accelerate cloud adoption and increase developer productivity. With your organization-speciﬁc private re:Post, you can build an organization-speciﬁc developer community that drives eﬃciencies at scale and provides access to valuable knowledge resources. Additionally, re:Post Private centralizes trusted AWS technical content and oﬀers private discussion forums to improve how your teams collaborate internally and with AWS to remove technical obstacles, accelerate innovation, and scale more eﬃciently in the cloud. For more information, see AWS re:Post Private. Access re:Post Private re:Post Private application administrators use their private re:Post application administration page to customize user interface and launch it for your organization. Administrators for the private re:Post application can customize branding, add tags to classify content, and select topics of interest for their developers to automatically populate training and technical content. They can also invite users to join their private re:Post for increased collaboration. For more information, see Manage your private re:Post. re:Post Private pricing For information on the pricing tiers for re:Post Private, see Pricing. How to get started with re:Post Private Only your AWS re:Post Private console administrator can invite you to join a private re:Post as an application administrator. Your re:Post Private console administrator creates the private re:Post and then invites you and other users to join the private re:Post. Your console administrator sends you an email message with the information that you need to launch the private re:Post. Access re:Post Private 1 AWS re:Post Private re:Post Private Administration Guide Conﬁgure your private re:Post When you use your IAM Identity Center credentials to sign in to your private re:Post application for the ﬁrst time, choose Start setting up on the Welcome to your private re:Post page. This section explains how you can conﬁgure your new private re:Post. Topics • Customize appearance for your private re:Post • Add custom tags, custom topics, and blocked terminology for your private re:Post • Choose your topics of interest for selections Customize appearance for your private re:Post Follow these steps to customize appearance for your private re:Post: 1. On the Customize appearance page, for Title, enter a title for your private re:Post. This is the title that shows at the top of your private re:Post home page. 2. For Description, enter a welcome message to greet your re:Post Private users. When a user signs in to your private re:Post, this message is displayed on the re:Post Private home page. 3. Under Logo, choose Change logo, and then upload an image. The maximum size for this image is 2 MiB. The supported ﬁle types are .jpg, .peg, and .png. This logo appears on the top-left of your private re:Post and has a resolution of 150 X 50. 4. Under Color scheme, for Primary color and Button color, choose the colors. The primary color that you choose is used as the header color for your private re:Post. The button color that you choose is used as the color for the buttons within your private re:Post. 5. Choose Save and continue. Add custom tags, custom topics, and
space-ag-002	space-ag.pdf	2	logo, and then upload an image. The maximum size for this image is 2 MiB. The supported ﬁle types are .jpg, .peg, and .png. This logo appears on the top-left of your private re:Post and has a resolution of 150 X 50. 4. Under Color scheme, for Primary color and Button color, choose the colors. The primary color that you choose is used as the header color for your private re:Post. The button color that you choose is used as the color for the buttons within your private re:Post. 5. Choose Save and continue. Add custom tags, custom topics, and blocked terminology for your private re:Post As an administrator for your private re:Post, you can add custom tags, custom topics, and blocked terminology for your private re:Post. To add custom tags that apply to your private re:Post, follow these steps: Customize appearance 2 AWS re:Post Private re:Post Private Administration Guide 1. On the Add custom tags, topics and blocked terminology page, choose Tags, and then choose Create tag. 2. In the Create tag? dialog box, enter the tag. Then, choose Create. Note • You can't start the tags with AWS or Amazon. • You can't enter duplicate tags. The tags that you added are displayed in the list under the Tags section. The users of your private re:Post can add these custom tags in questions, articles, and selections that they post in the private re:Post. To add custom topics to your private re:Post, follow these steps: 1. On the Add custom tags, topics and blocked terminology page, choose Topics, and then choose Create topic. 2. In the Create new topic dialog box, do the following: For Name, enter a name for the custom topic. Note • You can't start the topics with AWS or Amazon. • You can't enter duplicate topics. For Brief description, enter a description for your topic. For Full description, enter a detailed description for your topic. For Included tags, select all tags that you want to include in this topic. You can only choose custom tags to include in a custom topic. Choose Create. Add custom tags, custom topics, and blocked terminology 3 AWS re:Post Private re:Post Private Administration Guide The topics that you added are displayed in the list under the Topics section. If a user posts a question, article, or selection with the tag that you included in the custom topic, then your private re:Post adds the topic to this content. To add blocked terminology to your private re:Post, follow these steps: 1. Choose Blocked terminology. Then, choose Add blocked terminology. 2. In the Add blocked terminology? dialog box, enter the text that you want to block your private re:Post users from using. Then, choose Add. The terms that you added are displayed in the list under the Blocked terminology section. When users try to use the blocked term in their private re:Post content, they get a warning message that asks them to edit the content and remove the term. 3. Choose Continue. Choose your topics of interest for selections A selection is a learning path or a curated set of content assets that are relevant to a use case, technology domain, industry, or speciﬁc problem area. It's a collection of knowledge assets speciﬁc to your organization's cloud use case within AWS services and contains high-quality content from AWS sources, such as AWS re:Post, Knowledge Center, AWS Blogs, and AWS Documentation. To choose your topics of interest for selections, follow these steps: 1. On the Select topics of interest page, select your topics of interest for selections that you want to display on the home page of your private re:Post. You can also use the dropdown list to select topics of your interest. 2. Choose Launch your private re:Post. All selections with the selected topics are added to the home page for your private re:Post. Important Your private re:Post is launched and ready for use after the console administrator onboards users to it. For more information, see Invite users and groups to your private re:Post. The Choose your topics of interest 4 AWS re:Post Private re:Post Private Administration Guide users of your private re:Post use the information in the onboarding email to sign in to your private re:Post after it's launched. Choose your topics of interest 5 AWS re:Post Private re:Post Private Administration Guide Complete your private re:Post proﬁle After you conﬁgure and launch your private re:Post, you must complete your proﬁle. Follow these steps to complete your proﬁle: 1. Choose Complete your proﬁle on the home page banner. 2. For Screen name, enter a display name. This name is displayed on all your posts. 3. For Email for notiﬁcations, enter your email address. Note Make sure that you use one of your corporate email addresses that's allowlisted by your organization. 4. (Optional) For
space-ag-003	space-ag.pdf	3	to your private re:Post after it's launched. Choose your topics of interest 5 AWS re:Post Private re:Post Private Administration Guide Complete your private re:Post proﬁle After you conﬁgure and launch your private re:Post, you must complete your proﬁle. Follow these steps to complete your proﬁle: 1. Choose Complete your proﬁle on the home page banner. 2. For Screen name, enter a display name. This name is displayed on all your posts. 3. For Email for notiﬁcations, enter your email address. Note Make sure that you use one of your corporate email addresses that's allowlisted by your organization. 4. (Optional) For First name and Last name, enter your ﬁrst name and last name. 5. For Interface and notiﬁcations language, select a language. 6. For Content language, select additional language options for your content on re:Post Private. 7. Choose Complete proﬁle. After you complete your proﬁle, you receive a veriﬁcation email. In the email, choose Verify E-mail. In your private re:Post, choose Continue to service to start working with your private re:Post. Note To update your proﬁle, choose your user proﬁle, choose Settings, update as needed, and then choose Update your proﬁle. 6 AWS re:Post Private re:Post Private Administration Guide Manage your private re:Post in AWS re:Post Private This section explains how you can administer your private re:Post. Topics • Update branding for your private re:Post • Deactivate a user account in your private re:Post • Activate a user account in your private re:Post • Add custom tags in your private re:Post • Add custom topics in your private re:Post • Add blocked terminologies in your private re:Post • Update custom tags in your private re:Post • Update custom topics in your private re:Post • Delete custom tags from your private re:Post • Delete custom topics from your private re:Post • Delete blocked terminology from your private re:Post • Choose your topics of interest for selections in your private re:Post Update branding for your private re:Post To update the existing branding for your private re:Post, follow these steps: 1. In your private re:Post application, choose your proﬁle, and then choose Administration. 2. Choose the Branding tab. 3. For Title, enter a title. This updates the title that shows at the top of your private re:Post. home page. 4. For Description, enter a message to greet your re:Post Private users. When a user signs in to your private re:Post, this message is displayed on the home page. 5. Under Logo, choose Change logo, and then upload an image. The maximum size for the image is 2 MiB. The supported ﬁle types are .jpg, .peg, and .png. This logo appears on the top-left of your private re:Post and has a resolution of 150 X 50. Update your branding 7 AWS re:Post Private re:Post Private Administration Guide 6. Under Color scheme, for Primary color and Button color, choose the colors. The primary color that you choose is used as the header color for your private re:Post. The button color that you choose is used as the color for the buttons within your private re:Post. 7. Choose Update preferences. Deactivate a user account in your private re:Post Note You can deactivate only the users who already signed in to your private re:Post. Follow these steps to deactivate a user account in your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Permissions to view the list of users in your private re:Post. 3. Select the user that you want to deactivate. You can use the search bar to search for a user. 4. Choose Manage permissions, and then choose Deactivate account. You can still view the deactivated user under the Set user permissions section. This user is marked as DEACTIVATED. After you deactivate a user, the user can no longer sign in to your private re:Post. The user isn't included in the subsequent months' billing. After the user is signed out, their private re:Post session might continue for up to 8 hours. If you need to immediately remove the user from your private re:Post, you must use the IAM Identity Center. For more information, see Remove users or groups from your private re:Post Activate a user account in your private re:Post Note You can activate only a user that you already deactivated in your private re:Post. Deactivate a user account 8 AWS re:Post Private re:Post Private Administration Guide Follow these steps to activate a deactivated user account in your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Permissions to view the list of users in your private re:Post. The users that you deactivated are marked as DEACTIVATED. 3. Select the user that you want to activate. You can use the search bar to search for a user.
space-ag-004	space-ag.pdf	4	in your private re:Post Note You can activate only a user that you already deactivated in your private re:Post. Deactivate a user account 8 AWS re:Post Private re:Post Private Administration Guide Follow these steps to activate a deactivated user account in your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Permissions to view the list of users in your private re:Post. The users that you deactivated are marked as DEACTIVATED. 3. Select the user that you want to activate. You can use the search bar to search for a user. 4. Choose Manage permissions, and then choose Activate account. The selected user is immediately activated. You can choose to notify the user that their account is activated in your private re:Post. The user can sign in to your private re:Post and access all resources. The user is included in the current and subsequent months' billing. Add custom tags in your private re:Post As an private re:Post administrator, you can add custom tags that the users in your private re:Post can use. A tag is a label that you and your users can assign to content that's posted in your private re:Post. After you tag your content, you can ﬁnd it easily using the Tags menu. You can use a tag to ﬁlter your search results. You can also follow a speciﬁc tag to stay informed on the latest updates about related content. Follow these steps to add tags to your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. Choose Tags, and then choose Create tag. 4. In the Create tag? dialog box, enter the tag. Then, choose Create. Note • You can't start the tags with AWS or Amazon. • You can't enter duplicate tags. Add custom tags 9 AWS re:Post Private re:Post Private Administration Guide The tags that you added are displayed in the list under the Tags section. The users of your private re:Post can add these custom tags in questions, articles, and selections that they post in the private re:Post. Add custom topics in your private re:Post As an private re:Post administrator, you can add custom topics that the users in your private re:Post can use. A topic is a curated domain that you and your users can assign to content that's posted in your private re:Post. Topics provide you access to content that's aggregated from a set of related tags. Follow these steps to add topics to your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. Choose Topics, and then choose Create topic. 4. In the Create new topic dialog box, do the following: For Name, enter a name for the custom topic. Note • You can't start the topics with AWS or Amazon. • You can't enter duplicate topics. For Brief description, enter a description for your topic. For Full description, enter a detailed description for your topic. For Included tags, select all tags that you want to include in this topic. You can only choose custom tags to include in a custom topic. Choose Create. Add custom topics 10 AWS re:Post Private re:Post Private Administration Guide The topics that you added are displayed in the list under the Topics section. If a user posts a question, article, or selection with the tag that you included in the custom topic, then your private re:Post adds the topic to this content. Also, a new community group is created for the custom topic that you added. You can see this new community group under the Community groups tab. Add blocked terminologies in your private re:Post As an private re:Post administrator, you can block terms that you want to restrict your users from using in their content. Follow these steps to add blocked terminology to your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. Choose Blocked terminology. Then, choose Add blocked terminology. 4. In the Add blocked terminology? dialog box, enter the text that you want to block your private re:Post users from using. Then, choose Add. The term that you added is displayed in the list under the Blocked terminology section. When users try to use the blocked term in their private re:Post content, they get a warning message that asks them to edit the content and remove the term. Update custom tags in your private re:Post As an AWS re:Post Private administrator, you can update the custom tags in your private re:Post. Follow these steps to update the tags in your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration.
space-ag-005	space-ag.pdf	5	private re:Post users from using. Then, choose Add. The term that you added is displayed in the list under the Blocked terminology section. When users try to use the blocked term in their private re:Post content, they get a warning message that asks them to edit the content and remove the term. Update custom tags in your private re:Post As an AWS re:Post Private administrator, you can update the custom tags in your private re:Post. Follow these steps to update the tags in your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. From the list, select the tag that you want to update. 4. Choose Edit tag. 5. In the Edit tag dialog box, delete the existing tag, and then enter the new tag. Then, choose Save changes. Add blocked terminologies 11 AWS re:Post Private Note • You can't start the tags with AWS or Amazon. • You can't enter duplicate tags. re:Post Private Administration Guide The updated tags are displayed under the Tags section. Update custom topics in your private re:Post As an AWS re:Post Private administrator, you can update the custom topics in your private re:Post. Follow these steps to update the topics in your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. Choose Topics. 4. From the list, select the topic that you want to update. 5. Choose Edit topic. 6. In the Edit topic dialog box, update the topic details as needed. Then, choose Save changes. Note • You can't start the topics with AWS or Amazon. • You can't enter duplicate topics. The updated topics are displayed under the Topics section. Delete custom tags from your private re:Post As an AWS re:Post Private administrator, you can delete the custom tags from your private re:Post. Follow these steps to delete existing tags from your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. Update custom topics 12 AWS re:Post Private re:Post Private Administration Guide 2. Choose Content classiﬁcation. 3. Choose Tags. 4. From the list, select the tags that you want to delete from the private re:Post. 5. Choose Delete tag. The tags that you deleted are no longer displayed under the Tags section. Delete custom topics from your private re:Post As an AWS re:Post Private administrator, you can delete existing custom topics from your private re:Post. Follow these steps to delete custom topics from your private re:Post: 1. In your re:Post Private web application, choose your proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. Choose Topics. 4. From the list, select the topics that you want to delete from the private re:Post. 5. Choose Delete topic. The topics that you deleted are no longer displayed under the Topics section. Delete blocked terminology from your private re:Post As an AWS re:Post Private administrator, you can delete blocked terminologies from your private re:Post. Follow these steps to delete blocked terms from your private re:Post: 1. In your re:Post Private web application, choose the user proﬁle, and then choose Administration. 2. Choose Content classiﬁcation. 3. Choose Blocked terminology. 4. From the list, select the terms that you want to delete from the private re:Post. 5. Choose Remove blocked terminology. Delete custom topics 13 AWS re:Post Private re:Post Private Administration Guide The blocked terms that you removed are no longer displayed in the list under the Blocked terminology section. Choose your topics of interest for selections in your private re:Post To choose your topics of interest for selections, follow these steps: 1. In your private re:Post application, choose the user proﬁle, and then choose Administration. 2. Choose Topics of interest. 3. From the list, select your topics of interest for selections that you want to display on the home page. You can also use the dropdown list to select topics of your interest. 4. Choose Update. All selections with the selected topics are added to the home page for your private re:Post. Choose your topics of interest 14 AWS re:Post Private re:Post Private Administration Guide User roles in AWS re:Post Private AWS re:Post Private deﬁnes the following user roles: • re:Post Private console administrator: A user who has administrative permissions in re:Post Private to create and delete private re:Posts. Console administrators can also add or remove re:Post Private users, and add or remove the roles for these users. For more information, see Assign a role to a user in your private re:Post. • re:Post Private application administrator: A user who has administrative permissions for a speciﬁc private re:Post within re:Post Private. re:Post Private administrators can customize private re:Post settings and deactivate users in their private re:Post. re:Post Private administrators can also add or delete
space-ag-006	space-ag.pdf	6	deﬁnes the following user roles: • re:Post Private console administrator: A user who has administrative permissions in re:Post Private to create and delete private re:Posts. Console administrators can also add or remove re:Post Private users, and add or remove the roles for these users. For more information, see Assign a role to a user in your private re:Post. • re:Post Private application administrator: A user who has administrative permissions for a speciﬁc private re:Post within re:Post Private. re:Post Private administrators can customize private re:Post settings and deactivate users in their private re:Post. re:Post Private administrators can also add or delete custom tags within their private re:Post. • User: A user who can view all the content and collaborate with others in a private re:Post. Based on the user permissions set by the re:Post Private administrator, some users have permissions to publish articles, create selections, and create cases to Support. For more information, see Assign a role to a user in your private re:Post. 15 AWS re:Post Private re:Post Private Administration Guide Document history for the re:Post Private Administration Guide The following table describes the documentation releases for AWS re:Post Private: Change Update Description Date Added a section on how to add, update, and delete custom topics in a private re:Post October 22, 2024 Guide structure review and improvements The structure of the guide was reviewed and improveme September 6, 2024 nts were made to improve the customer experience related to ﬁnding information for speciﬁc scenarios. Added a section on how to deactivate and activate users in a private re:Post May 7, 2024 Initial release of the re:Post Private Administration Guide November 26, 2023 Update Initial release 16
space-api-001	space-api.pdf	1	Welcome AWS re:Post Private API Version 2022-05-13 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS re:Post Private Welcome AWS re:Post Private: Welcome Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS re:Post Private Table of Contents Welcome Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 BatchAddRole ................................................................................................................................................ 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 4 Response Elements ................................................................................................................................. 4 Errors .......................................................................................................................................................... 5 See Also ..................................................................................................................................................... 5 BatchRemoveRole ......................................................................................................................................... 7 Request Syntax ........................................................................................................................................ 7 URI Request Parameters ........................................................................................................................ 7 Request Body ........................................................................................................................................... 7 Response Syntax ...................................................................................................................................... 8 Response Elements ................................................................................................................................. 8 Errors .......................................................................................................................................................... 9 See Also ..................................................................................................................................................... 9 CreateSpace ................................................................................................................................................. 11 Request Syntax ...................................................................................................................................... 11 URI Request Parameters ...................................................................................................................... 11 Request Body ......................................................................................................................................... 11 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 13 See Also .................................................................................................................................................. 14 DeleteSpace ................................................................................................................................................. 16 Request Syntax ...................................................................................................................................... 16 URI Request Parameters ...................................................................................................................... 16 Request Body ......................................................................................................................................... 16 Response Syntax ................................................................................................................................... 16 Response Elements ............................................................................................................................... 16 Errors ....................................................................................................................................................... 16 See Also .................................................................................................................................................. 17 API Version 2022-05-13 iii AWS re:Post Private Welcome DeregisterAdmin ......................................................................................................................................... 18 Request Syntax ...................................................................................................................................... 18 URI Request Parameters ...................................................................................................................... 18 Request Body ......................................................................................................................................... 18 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 See Also .................................................................................................................................................. 19 GetSpace ...................................................................................................................................................... 21 Request Syntax ...................................................................................................................................... 21 URI Request Parameters ...................................................................................................................... 21 Request Body ......................................................................................................................................... 21 Response Syntax ................................................................................................................................... 21 Response Elements ............................................................................................................................... 22 Errors ....................................................................................................................................................... 25 See Also .................................................................................................................................................. 26 ListSpaces ..................................................................................................................................................... 27 Request Syntax ...................................................................................................................................... 27 URI Request Parameters ...................................................................................................................... 27 Request Body ......................................................................................................................................... 27 Response Syntax ................................................................................................................................... 27 Response Elements ............................................................................................................................... 28 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 29 ListTagsForResource ................................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 URI Request Parameters ...................................................................................................................... 30 Request Body ......................................................................................................................................... 30 Response Syntax ................................................................................................................................... 30 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 32 RegisterAdmin ............................................................................................................................................. 33 Request Syntax ...................................................................................................................................... 33 URI Request Parameters ...................................................................................................................... 33 Request Body ......................................................................................................................................... 33 API Version 2022-05-13 iv AWS re:Post Private Welcome Response Syntax ................................................................................................................................... 33 Response Elements ............................................................................................................................... 33 Errors ....................................................................................................................................................... 33 See Also .................................................................................................................................................. 34 SendInvites ................................................................................................................................................... 36 Request Syntax ...................................................................................................................................... 36 URI Request Parameters ...................................................................................................................... 36 Request Body ......................................................................................................................................... 36 Response Syntax ................................................................................................................................... 37 Response Elements ............................................................................................................................... 37 Errors ....................................................................................................................................................... 37 See Also .................................................................................................................................................. 38 TagResource ................................................................................................................................................. 39 Request Syntax ...................................................................................................................................... 39 URI Request Parameters ...................................................................................................................... 39 Request Body ......................................................................................................................................... 39 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 40 Errors ....................................................................................................................................................... 40 See Also .................................................................................................................................................. 41 UntagResource ............................................................................................................................................ 42 Request Syntax ...................................................................................................................................... 42 URI Request Parameters ...................................................................................................................... 42 Request Body ......................................................................................................................................... 42 Response Syntax ................................................................................................................................... 42 Response Elements ............................................................................................................................... 43 Errors ....................................................................................................................................................... 43 See Also .................................................................................................................................................. 43 UpdateSpace ................................................................................................................................................ 45 Request Syntax ...................................................................................................................................... 45 URI Request Parameters ...................................................................................................................... 45 Request Body ......................................................................................................................................... 45 Response Syntax ................................................................................................................................... 46 Response Elements ............................................................................................................................... 46 Errors ....................................................................................................................................................... 46 See Also .................................................................................................................................................. 47 API Version 2022-05-13 v AWS re:Post Private Welcome Data Types ..................................................................................................................................... 48 BatchError .................................................................................................................................................... 49 Contents .................................................................................................................................................. 49 See Also .................................................................................................................................................. 49 SpaceData .................................................................................................................................................... 50 Contents .................................................................................................................................................. 50 See Also .................................................................................................................................................. 53 ValidationExceptionField ........................................................................................................................... 54 Contents .................................................................................................................................................. 54 See Also .................................................................................................................................................. 54 Common Parameters ..................................................................................................................... 55 Common Errors .............................................................................................................................. 58 API Version 2022-05-13 vi AWS re:Post Private Welcome Welcome AWS re:Post Private is a private version of AWS re:Post for enterprises with Enterprise Support or Enterprise On-Ramp Support plans. It provides access to knowledge and experts to accelerate cloud adoption and increase developer productivity. With your organization-speciﬁc private re:Post, you can build an organization-speciﬁc developer community that drives eﬃciencies at scale and provides access to valuable knowledge resources. Additionally, re:Post Private centralizes trusted AWS technical content and oﬀers private discussion forums to improve how your teams collaborate internally and with AWS to remove technical obstacles, accelerate innovation, and scale more eﬃciently in the cloud. This document was last published on May 21, 2025. API Version 2022-05-13 1 AWS re:Post Private Actions The following actions are supported: • BatchAddRole • BatchRemoveRole • CreateSpace • DeleteSpace • DeregisterAdmin • GetSpace • ListSpaces • ListTagsForResource • RegisterAdmin • SendInvites • TagResource • UntagResource • UpdateSpace Welcome API Version 2022-05-13 2 AWS re:Post Private BatchAddRole Add role to multiple users or groups in a private re:Post. Welcome Request Syntax POST /spaces/spaceId/roles HTTP/1.1 Content-type: application/json { "accessorIds": [ "string" ], "role": "string" } URI Request Parameters The request uses the following URI parameters. spaceId The unique ID of the private re:Post. Required: Yes Request
space-api-002	space-api.pdf	2	on May 21, 2025. API Version 2022-05-13 1 AWS re:Post Private Actions The following actions are supported: • BatchAddRole • BatchRemoveRole • CreateSpace • DeleteSpace • DeregisterAdmin • GetSpace • ListSpaces • ListTagsForResource • RegisterAdmin • SendInvites • TagResource • UntagResource • UpdateSpace Welcome API Version 2022-05-13 2 AWS re:Post Private BatchAddRole Add role to multiple users or groups in a private re:Post. Welcome Request Syntax POST /spaces/spaceId/roles HTTP/1.1 Content-type: application/json { "accessorIds": [ "string" ], "role": "string" } URI Request Parameters The request uses the following URI parameters. spaceId The unique ID of the private re:Post. Required: Yes Request Body The request accepts the following data in JSON format. accessorIds The user or group accessor identiﬁers to add the role to. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1000 items. Required: Yes role The role to add to the users or groups. BatchAddRole API Version 2022-05-13 3 AWS re:Post Private Type: String Welcome Valid Values: EXPERT \| MODERATOR \| ADMINISTRATOR \| SUPPORTREQUESTOR Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "addedAccessorIds": [ "string" ], "errors": [ { "accessorId": "string", "error": number, "message": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. addedAccessorIds An array of successfully updated accessor identiﬁers. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1000 items. errors An array of errors that occurred when roles were added. Type: Array of BatchError objects Response Syntax API Version 2022-05-13 4 AWS re:Post Private Errors Welcome For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2022-05-13 5 AWS re:Post Private • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2022-05-13 6 AWS re:Post Private BatchRemoveRole Remove role from multiple users or groups in a private re:Post. Welcome Request Syntax PATCH /spaces/spaceId/roles HTTP/1.1 Content-type: application/json { "accessorIds": [ "string" ], "role": "string" } URI Request Parameters The request uses the following URI parameters. spaceId The unique ID of the private re:Post. Required: Yes Request Body The request accepts the following data in JSON format. accessorIds The user or group accessor identiﬁers to remove the role from. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1000 items. Required: Yes role The role to remove from the users or groups. BatchRemoveRole API Version 2022-05-13 7 AWS re:Post Private Type: String Welcome Valid Values: EXPERT \| MODERATOR \| ADMINISTRATOR \| SUPPORTREQUESTOR Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "errors": [ { "accessorId": "string", "error": number, "message": "string" } ], "removedAccessorIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. errors An array of errors that occurred when roles were removed. Type: Array of BatchError objects removedAccessorIds An array of successfully updated accessor identiﬁers. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1000 items. Response Syntax API Version 2022-05-13 8 AWS re:Post Private Errors Welcome For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2022-05-13 9 AWS re:Post Private • AWS SDK
space-api-003	space-api.pdf	3	processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2022-05-13 9 AWS re:Post Private • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2022-05-13 10 Welcome AWS re:Post Private CreateSpace Creates an AWS re:Post Private private re:Post. Request Syntax POST /spaces HTTP/1.1 Content-type: application/json { "description": "string", "name": "string", "roleArn": "string", "subdomain": "string", "tags": { "string" : "string" }, "tier": "string", "userKMSKey": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. description A description for the private re:Post. This is used only to help you identify this private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No name The name for the private re:Post. This must be unique in your account. CreateSpace API Version 2022-05-13 11 AWS re:Post Private Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 30. Required: Yes roleArn The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No subdomain The subdomain that you use to access your AWS re:Post Private private re:Post. All custom subdomains must be approved by AWS before use. In addition to your custom subdomain, all private re:Posts are issued an AWS generated subdomain for immediate use. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: Yes tags The list of tags associated with the private re:Post. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No tier The pricing tier for the private re:Post. Type: String Request Body API Version 2022-05-13 12 AWS re:Post Private Welcome Valid Values: BASIC \| STANDARD Required: Yes userKMSKey The AWS KMS key ARN that’s used for the AWS KMS encryption. If you don't provide a key, your data is encrypted by default with a key that AWS owns and manages for you. Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "spaceId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. spaceId The unique ID of the private re:Post. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. Response Syntax API Version 2022-05-13 13 AWS re:Post Private HTTP Status Code: 403 ConﬂictException Updating or deleting a resource can cause an inconsistent state. Welcome HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ServiceQuotaExceededException Request would cause a service quota to be exceeded. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2022-05-13 14 Welcome AWS re:Post Private • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 15 Welcome AWS re:Post Private DeleteSpace Deletes an AWS re:Post Private private re:Post. Request Syntax DELETE /spaces/spaceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. spaceId The unique ID of the private re:Post. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors
space-api-004	space-api.pdf	4	• AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 15 Welcome AWS re:Post Private DeleteSpace Deletes an AWS re:Post Private private re:Post. Request Syntax DELETE /spaces/spaceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. spaceId The unique ID of the private re:Post. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 DeleteSpace API Version 2022-05-13 16 Welcome AWS re:Post Private InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 17 AWS re:Post Private DeregisterAdmin Welcome Removes the user or group from the list of administrators of the private re:Post. Request Syntax DELETE /spaces/spaceId/admins/adminId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. adminId The ID of the admin to remove. Required: Yes spaceId The ID of the private re:Post to remove the admin from. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeregisterAdmin API Version 2022-05-13 18 AWS re:Post Private AccessDeniedException User does not have suﬃcient access to perform this action. Welcome HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2022-05-13 19 AWS re:Post Private • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2022-05-13 20 AWS re:Post Private GetSpace Welcome Displays information about the AWS re:Post Private private re:Post. Request Syntax GET /spaces/spaceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. spaceId The ID of the private re:Post. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "clientId": "string", "configurationStatus": "string", "contentSize": number, "createDateTime": "string", "customerRoleArn": "string", "deleteDateTime": "string", "description": "string", "groupAdmins": [ "string" ], "name": "string", "randomDomain": "string", "roles": { GetSpace API Version 2022-05-13 21 AWS re:Post Private Welcome "string" : [ "string" ] }, "spaceId": "string", "status": "string", "storageLimit": number, "tier": "string", "userAdmins": [ "string" ], "userCount": number, "userKMSKey": "string", "vanityDomain": "string", "vanityDomainStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn The ARN of the private re:Post. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. clientId The Identity Center identiﬁer for the Application Instance. Type: String conﬁgurationStatus The conﬁguration status of the private re:Post. Type: String Valid Values: CONFIGURED \| UNCONFIGURED contentSize The content size of the private re:Post. Type: Long Response Elements API Version 2022-05-13 22 AWS re:Post Private createDateTime The date when the private re:Post was created. Type: Timestamp customerRoleArn Welcome The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. deleteDateTime The date when the private re:Post was deleted. Type:
space-api-005	space-api.pdf	5	of 2048. clientId The Identity Center identiﬁer for the Application Instance. Type: String conﬁgurationStatus The conﬁguration status of the private re:Post. Type: String Valid Values: CONFIGURED \| UNCONFIGURED contentSize The content size of the private re:Post. Type: Long Response Elements API Version 2022-05-13 22 AWS re:Post Private createDateTime The date when the private re:Post was created. Type: Timestamp customerRoleArn Welcome The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. deleteDateTime The date when the private re:Post was deleted. Type: Timestamp description The description of the private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. groupAdmins This parameter has been deprecated. The list of groups that are administrators of the private re:Post. Type: Array of strings name The name of the private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. randomDomain The AWS generated subdomain of the private re:Post Response Elements API Version 2022-05-13 23 AWS re:Post Private Type: String roles A map of accessor identiﬁers and their roles. Type: String to array of strings map Welcome Valid Values: EXPERT \| MODERATOR \| ADMINISTRATOR \| SUPPORTREQUESTOR spaceId The unique ID of the private re:Post. Type: String status The creation or deletion status of the private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. storageLimit The storage limit of the private re:Post. Type: Long tier The pricing tier of the private re:Post. Type: String Valid Values: BASIC \| STANDARD userAdmins This parameter has been deprecated. The list of users that are administrators of the private re:Post. Type: Array of strings userCount The number of users that have onboarded to the private re:Post. Response Elements API Version 2022-05-13 24 AWS re:Post Private Type: Integer userKMSKey Welcome The custom AWS KMS key ARN that’s used for the AWS KMS encryption. Type: String vanityDomain The custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use. Type: String vanityDomainStatus The approval status of the custom subdomain. Type: String Valid Values: PENDING \| APPROVED \| UNAPPROVED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 Errors API Version 2022-05-13 25 Welcome AWS re:Post Private ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 26 AWS re:Post Private ListSpaces Welcome Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post. Request Syntax GET /spaces?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of private re:Posts to include in the results. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "spaces": [ { "arn": "string", "configurationStatus": "string", "contentSize": number, "createDateTime": "string", ListSpaces API Version 2022-05-13 27 AWS re:Post Private Welcome "deleteDateTime": "string", "description": "string", "name": "string", "randomDomain": "string", "spaceId": "string", "status": "string", "storageLimit": number, "tier": "string", "userCount": number, "userKMSKey": "string", "vanityDomain": "string", "vanityDomainStatus": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The token that you use when you request the next set of private re:Posts. Type: String spaces An array of structures that contain some information about the private re:Posts in the account. Type: Array of SpaceData objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 Response Elements API Version 2022-05-13 28 Welcome AWS re:Post Private InternalServerException Unexpected error during processing of request. HTTP Status Code: 500
space-api-006	space-api.pdf	6	The following data is returned in JSON format by the service. nextToken The token that you use when you request the next set of private re:Posts. Type: String spaces An array of structures that contain some information about the private re:Posts in the account. Type: Array of SpaceData objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 Response Elements API Version 2022-05-13 28 Welcome AWS re:Post Private InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 29 AWS re:Post Private ListTagsForResource Welcome Returns the tags that are associated with the AWS re:Post Private resource speciﬁed by the resourceArn. The only resource that can be tagged is a private re:Post. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource that the tags are associated with. Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. ListTagsForResource API Version 2022-05-13 30 AWS re:Post Private Welcome The following data is returned in JSON format by the service. tags The list of tags that are associated with the resource. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. Errors API Version 2022-05-13 31 AWS re:Post Private HTTP Status Code: 400 See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 32 AWS re:Post Private RegisterAdmin Welcome Adds a user or group to the list of administrators of the private re:Post. Request Syntax POST /spaces/spaceId/admins/adminId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. adminId The ID of the administrator. Required: Yes spaceId The ID of the private re:Post. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. RegisterAdmin API Version 2022-05-13 33 AWS re:Post Private AccessDeniedException User does not have suﬃcient access to perform this action. Welcome HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2022-05-13 34 AWS re:Post Private • AWS SDK for PHP
space-api-007	space-api.pdf	7	ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2022-05-13 34 AWS re:Post Private • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2022-05-13 35 AWS re:Post Private SendInvites Sends an invitation email to selected users and groups. Welcome Request Syntax POST /spaces/spaceId/invite HTTP/1.1 Content-type: application/json { "accessorIds": [ "string" ], "body": "string", "title": "string" } URI Request Parameters The request uses the following URI parameters. spaceId The ID of the private re:Post. Required: Yes Request Body The request accepts the following data in JSON format. accessorIds The array of identiﬁers for the users and groups. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1000 items. Required: Yes body The body of the invite. SendInvites API Version 2022-05-13 36 AWS re:Post Private Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 600. Required: Yes title The title of the invite. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. Response Syntax API Version 2022-05-13 37 AWS re:Post Private HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException Welcome The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 38 AWS re:Post Private TagResource Welcome Associates tags with an AWS re:Post Private resource. Currently, the only resource that can be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is appended to the list of tags that are associated with the resource. If you specify a tag key that’s already associated with the resource, the new tag value that you specify replaces the previous value for that tag. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource that the tag is associated with. Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes Request Body The request accepts the following data in JSON format. tags The list of tag keys and values that must be associated with the resource. You can associate tag keys only, tags (key and values) only, or a combination of tag keys and tags. TagResource API Version 2022-05-13 39 AWS re:Post Private Type: String to string map Welcome Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. Response Syntax API Version 2022-05-13 40 AWS re:Post Private HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. Welcome HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
space-api-008	space-api.pdf	8	actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. Response Syntax API Version 2022-05-13 40 AWS re:Post Private HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. Welcome HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 41 AWS re:Post Private UntagResource Welcome Removes the association of the tag with the AWS re:Post Private resource. Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes tagKeys The key values of the tag. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 UntagResource API Version 2022-05-13 42 AWS re:Post Private Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Unexpected error during processing of request. HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2022-05-13 43 Welcome AWS re:Post Private • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 44 AWS re:Post Private UpdateSpace Modiﬁes an existing AWS re:Post Private private re:Post. Welcome Request Syntax PUT /spaces/spaceId HTTP/1.1 Content-type: application/json { "description": "string", "roleArn": "string", "tier": "string" } URI Request Parameters The request uses the following URI parameters. spaceId The unique ID of this private re:Post. Required: Yes Request Body The request accepts the following data in JSON format. description A description for the private re:Post. This is used only to help you identify this private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No roleArn The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets. UpdateSpace API Version 2022-05-13 45 AWS re:Post Private Type: String Welcome Length Constraints: Minimum length of 20. Maximum length of 2048. Required: No tier The pricing tier of this private re:Post. Type: String Valid Values: BASIC \| STANDARD Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 409 InternalServerException Unexpected error during processing of request. Response Syntax API Version 2022-05-13 46 Welcome AWS re:Post Private HTTP Status Code: 500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin
space-api-009	space-api.pdf	9	500 ResourceNotFoundException Request references a resource which does not exist. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-05-13 47 AWS re:Post Private Data Types Welcome The AWS re:Post Private API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • BatchError • SpaceData • ValidationExceptionField API Version 2022-05-13 48 AWS re:Post Private BatchError An error that occurred during a batch operation. Contents accessorId The accessor identiﬁer that's related to the error. Welcome Type: String Required: Yes error The error code. Type: Integer Required: Yes message Description of the error. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BatchError API Version 2022-05-13 49 AWS re:Post Private SpaceData Welcome A structure that contains some information about a private re:Post in the account. Contents arn The ARN of the private re:Post. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes conﬁgurationStatus The conﬁguration status of the private re:Post. Type: String Valid Values: CONFIGURED \| UNCONFIGURED Required: Yes createDateTime The date when the private re:Post was created. Type: Timestamp Required: Yes name The name for the private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Required: Yes randomDomain The AWS generated subdomain of the private re:Post. SpaceData API Version 2022-05-13 50 Welcome AWS re:Post Private Type: String Required: Yes spaceId The unique ID of the private re:Post. Type: String Required: Yes status The creation/deletion status of the private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Required: Yes storageLimit The storage limit of the private re:Post. Type: Long Required: Yes tier The pricing tier of the private re:Post. Type: String Valid Values: BASIC \| STANDARD Required: Yes vanityDomain This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use. Type: String Required: Yes Contents API Version 2022-05-13 51 Welcome AWS re:Post Private vanityDomainStatus This approval status of the custom subdomain. Type: String Valid Values: PENDING \| APPROVED \| UNAPPROVED Required: Yes contentSize The content size of the private re:Post. Type: Long Required: No deleteDateTime The date when the private re:Post was deleted. Type: Timestamp Required: No description The description for the private re:Post. This is used only to help you identify this private re:Post. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No userCount The number of onboarded users to the private re:Post. Type: Integer Required: No userKMSKey The custom AWS KMS key ARN that’s used for the AWS KMS encryption. Contents API Version 2022-05-13 52 AWS re:Post Private Type: String Required: No See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-05-13 53 AWS re:Post Private Welcome ValidationExceptionField Stores information about a ﬁeld that’s passed inside a request that resulted in an exception. Contents message The name of the ﬁeld. Type: String Required: Yes name Message describing why the ﬁeld failed validation. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2022-05-13 54 AWS re:Post Private Welcome Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for,
space-api-010	space-api.pdf	10	SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2022-05-13 54 AWS re:Post Private Welcome Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2022-05-13 55 AWS re:Post Private Welcome For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2022-05-13 56 AWS re:Post Private Type: string Required: Conditional X-Amz-SignedHeaders Welcome Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2022-05-13 57 AWS re:Post Private Welcome Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2022-05-13 58 AWS re:Post Private HTTP Status Code: 403 RequestAbortedException Welcome Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the
space-api-011	space-api.pdf	11	RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2022-05-13 59 AWS re:Post Private UnknownOperationException Welcome The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2022-05-13 60
space-cag-001	space-cag.pdf	1	Console Administration Guide AWS re:Post Private Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS re:Post Private Console Administration Guide AWS re:Post Private: Console Administration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS re:Post Private Console Administration Guide Table of Contents What is AWS re:Post Private? ......................................................................................................... 1 Access re:Post Private .................................................................................................................................. 1 Pricing ............................................................................................................................................................. 2 Prerequisites .................................................................................................................................................. 2 Onboard to re:Post Private ............................................................................................................. 3 Security ............................................................................................................................................. 4 Data protection ............................................................................................................................................. 4 Protecting data with encryption .......................................................................................................... 5 Encryption in transit ............................................................................................................................... 6 Key management .................................................................................................................................... 6 How re:Post Private works with IAM ........................................................................................................ 6 re:Post Private identity-based policies ............................................................................................... 6 re:Post Private resource-based policies .............................................................................................. 8 Authorization based on tags ................................................................................................................ 8 re:Post Private IAM roles ....................................................................................................................... 8 Service-linked roles ................................................................................................................................. 8 Service roles ............................................................................................................................................. 9 Using service-linked roles ...................................................................................................................... 9 Identity-based policy examples ......................................................................................................... 12 Inline policies ......................................................................................................................................... 15 AWS managed policies ........................................................................................................................ 17 Troubleshooting .................................................................................................................................... 20 Compliance validation ............................................................................................................................... 21 Resilience ...................................................................................................................................................... 22 Infrastructure Security .............................................................................................................................. 23 Quotas ............................................................................................................................................ 24 Service quotas ............................................................................................................................................. 24 API throttling limits ................................................................................................................................... 24 Create, conﬁgure, and customize your private re:Post ............................................................... 26 Create a new private re:Post ................................................................................................................... 26 Manage Support case creation and management .............................................................................. 28 Use or create a managed policy ........................................................................................................ 29 Example IAM policy .............................................................................................................................. 30 Create an IAM role ............................................................................................................................... 31 iii AWS re:Post Private Console Administration Guide Troubleshooting .................................................................................................................................... 32 Set up and manage user access .............................................................................................................. 33 Customize your private re:Post ............................................................................................................... 33 Invite users to your private re:Post ........................................................................................................ 34 Manage your private re:Post ......................................................................................................... 35 Add users ..................................................................................................................................................... 35 Add groups .................................................................................................................................................. 36 Add users to a group ................................................................................................................................ 36 Invite users and groups ............................................................................................................................ 36 Assign a role to a user .............................................................................................................................. 37 Remove users .............................................................................................................................................. 38 Remove groups ........................................................................................................................................... 38 Add or remove an AWS employee ......................................................................................................... 39 Delete a private re:Post ............................................................................................................................ 39 Monitoring re:Post Private ............................................................................................................ 40 Monitoring with CloudWatch ................................................................................................................... 40 Logging re:Post Private API calls using AWS CloudTrail .................................................................... 41 re:Post Private information in CloudTrail ........................................................................................ 41 Understanding re:Post Private log ﬁle entries ................................................................................ 43 Troubleshooting ............................................................................................................................. 49 Can't set up my private re:Post in a speciﬁc AWS Region ................................................................. 49 Can't set up private re:Post in my account ........................................................................................... 49 Can't manage users or groups in a private re:Post ............................................................................. 49 Document history .......................................................................................................................... 50 iv AWS re:Post Private Console Administration Guide What is AWS re:Post Private? AWS re:Post Private is a private version of AWS re:Post for enterprises with Enterprise Support or Enterprise On-Ramp Support plans. It provides access to knowledge and experts to accelerate cloud adoption and increase developer productivity. With your organization-speciﬁc private re:Post, you can build an organization-speciﬁc developer community that drives eﬃciencies at scale and provides access to valuable knowledge resources. Additionally, re:Post Private centralizes trusted AWS technical content and oﬀers private discussion forums to improve how your teams collaborate internally and with AWS to remove technical obstacles, accelerate innovation, and scale more eﬃciently in the cloud. For more information, see AWS re:Post Private. Access re:Post Private Administrators use the AWS re:Post Private console to create their organization-speciﬁc private re:Post. When administrators create a private re:Post, they can name their private re:Post and deﬁne a subdomain under *.private.repost.aws. Administrators for an organization’s private re:Post can conﬁgure user access using AWS IAM Identity Center and specify one of the following identity sources for authentication: Identity Center directory, Active Directory, or an external identity provider. After conﬁguring the users, console administrators can assign a re:Post Private admin role to one or more users. re:Post Private administrators can customize their private re:Post application in line with organizational branding and knowledge needs. The AWS account team members, such as Technical Account Managers, who are familiar with the organization’s architecture and workloads are automatically added to the organization's private re:Post for collaboration. Administrators for the re:Post Private application can customize branding, add tags to classify content, and select topics of interest for their developers to automatically populate training and technical content. They can also invite users to join their private re:Post for increased collaboration. For more information, see AWS re:Post Private Administration Guide. Non-administrative users use the re:Post Private application to sign in using credentials that are conﬁgured by their administrator. After signing in to a private re:Post, users can browse or search existing content, including tailored training and technical content that are scoped to
space-cag-002	space-cag.pdf	2	to the organization's private re:Post for collaboration. Administrators for the re:Post Private application can customize branding, add tags to classify content, and select topics of interest for their developers to automatically populate training and technical content. They can also invite users to join their private re:Post for increased collaboration. For more information, see AWS re:Post Private Administration Guide. Non-administrative users use the re:Post Private application to sign in using credentials that are conﬁgured by their administrator. After signing in to a private re:Post, users can browse or search existing content, including tailored training and technical content that are scoped to their topics of interest. Users can also search AWS public technical content directly from their private re:Post and create private threads for internal discussions on AWS public content. Users can collaboratively Access re:Post Private 1 AWS re:Post Private Console Administration Guide solve AWS technical problems and get technical guidance from other users of the private re:Post by asking a question, providing a response, or publishing an article. Users can also convert a discussion thread into an Support case. Users can choose to add the responses from Support to the private re:Post. For more information, see AWS re:Post Private User Guide. Pricing Only customers with Enterprise Support (ES) and Enterprise On-Ramp (EOP) Support plans can subscribe to the re:Post Private service. You can choose from the two available pricing tiers - Free tier and Standard tier. The Free tier provides you the ability to explore and try out Standard tier capabilities to full extent for six months before you can seamlessly transition to a paid tier. If you use the Standard tier, then you can pay a monthly subscription per user charge to use re:Post Private. For more information, see Pricing. Prerequisites You must meet the following prerequisites before you can create a new private re:Post or manage an existing private re:Post in AWS re:Post Private: • You must sign up for an Enterprise or Enterprise On-Ramp Support Plan. • You must enable AWS IAM Identity Center in the same Region where you want to set up your private re:Post. • You must create an AWS Identity and Access Management role that has the required permissions to create, manage, and resolve Support cases for you. The re:Post Private service uses this role to make API calls to Support. For more information, see Manage access to Support case creation and management in re:Post Private. Pricing 2 AWS re:Post Private Console Administration Guide Onboard to re:Post Private through IAM Identity Center re:Post Private integrates with AWS IAM Identity Center to provide identity federation for your workforce. Through IAM Identity Center, users are redirected to their existing company directory to sign in with their existing credentials. Then, they're seamlessly signed in to their private re:Post. This makes sure that security settings such as password policies and two-factor authentication are enforced. Using IAM Identity Center doesn’t impact your existing IAM conﬁguration. If you don’t have an existing user directory or prefer not to federate, then IAM Identity Center oﬀers an integrated user directory that you can use to create users and groups for re:Post Private. re:Post Private doesn’t support the use of IAM users and roles to assign permissions within a private re:Post. User permissions within a private re:Post are conﬁgured by an administrator on their private re:Post application. For more information about IAM Identity Center, see What is AWS IAM Identity Center (successor to AWS Single Sign-On). For more information about getting started with IAM Identity Center, see Getting started. To use IAM Identity Center, you must also have AWS Organizations activated for the account. Important re:Post Private supports only organization instances of IAM Identity Center. 3 AWS re:Post Private Console Administration Guide Security in re:Post Private Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS re:Post Private, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors, including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility
space-cag-003	space-cag.pdf	3	Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS re:Post Private, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors, including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using re:Post Private. The following topics show you how to conﬁgure re:Post Private to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your re:Post Private resources. Topics • Data protection in AWS re:Post Private • How re:Post Private works with IAM • Compliance validation for AWS re:Post Private • Resilience in AWS re:Post Private • Infrastructure Security in AWS re:Post Private Data protection in AWS re:Post Private The AWS shared responsibility model applies to data protection in AWS re:Post Private. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on Data protection 4 AWS re:Post Private Console Administration Guide this infrastructure. You are also responsible for the security conﬁguration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with re:Post Private or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Protecting data with encryption Encryption at rest re:Post Private uses Amazon Simple Storage Service buckets, Amazon DynamoDB databases, Amazon Neptune databases, and Amazon OpenSearch Service domains that are encrypted at rest using either Amazon managed keys or customer managed keys. Protecting data with encryption 5 AWS re:Post Private Console Administration Guide Encryption in transit re:Post Private uses the HTTPS protocol to communicate with your client application. It uses HTTPS and AWS signatures to communicate with other services on your application's behalf. Key management re:Post Private is integrated with AWS Key Management Service and supports AWS KMS keys. You can customize the data encryption settings for your private re:Post when you create it. To do so, you can either choose an existing AWS KMS key or create a new AWS KMS key. How re:Post Private works with IAM Before you use IAM to manage access to AWS re:Post Private, you must understand which IAM features are available to use with re:Post Private. To get a high-level view of how re:Post Private and other AWS services work with IAM, see AWS services that work with IAM in the IAM User Guide. re:Post Private identity-based policies With IAM identity-based policies, you can specify allowed or denied actions. re:Post Private supports speciﬁc actions. To learn about the elements that you use in a JSON
space-cag-004	space-cag.pdf	4	existing AWS KMS key or create a new AWS KMS key. How re:Post Private works with IAM Before you use IAM to manage access to AWS re:Post Private, you must understand which IAM features are available to use with re:Post Private. To get a high-level view of how re:Post Private and other AWS services work with IAM, see AWS services that work with IAM in the IAM User Guide. re:Post Private identity-based policies With IAM identity-based policies, you can specify allowed or denied actions. re:Post Private supports speciﬁc actions. To learn about the elements that you use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Actions Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. Policy actions in re:Post Private use the following preﬁx before the action: repostspace:. For example, to grant someone permission to run the re:Post Private CreateSpace API operation, Encryption in transit 6 AWS re:Post Private Console Administration Guide you include the repostspace:CreateSpace action in their policy. Policy statements must include either an Action or NotAction element. re:Post Private deﬁnes its own set of actions that describe tasks that you can perform with this service. To specify multiple actions in a single statement, separate them with commas as follows: "Action": [ "repostspace:CreateSpace", "repostspace:DeleteSpace" You can specify multiple actions using wildcards (). For example, to specify all actions that begin with the word Describe, include the following action: "Action": "repostspace:Describe" To see a list of re:Post Private actions, see Actions deﬁned by re:Post Private in the IAM User Guide. Resources Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a speciﬁc resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard () to indicate that the statement applies to all resources. "Resource": "" Condition keys re:Post Private doesn't provide any service-speciﬁc condition keys, but it supports using global condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. re:Post Private identity-based policies 7 AWS re:Post Private Examples Console Administration Guide To view examples of re:Post Private identity-based policies, see AWS re:Post Private identity-based policy examples. re:Post Private resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. re:Post Private doesn't support resource-based policies. Authorization based on tags re:Post Private supports tagging resources or controlling access based on tags. For more information, see Controlling access to AWS resources using tags. re:Post Private IAM roles An IAM role is an entity within your AWS account that has speciﬁc permissions. Using temporary credentials with re:Post Private We strongly recommend using temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken. re:Post Private supports using temporary credentials. Service-linked roles Service-linked roles allow AWS services to access resources in other services to complete an action for you. Service-linked roles appear in your IAM account and are owned by the service. An IAM administrator can view but not edit the permissions for service-linked roles. re:Post Private resource-based policies 8 AWS re:Post Private Service roles Console Administration
space-cag-005	space-cag.pdf	5	We strongly recommend using temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken. re:Post Private supports using temporary credentials. Service-linked roles Service-linked roles allow AWS services to access resources in other services to complete an action for you. Service-linked roles appear in your IAM account and are owned by the service. An IAM administrator can view but not edit the permissions for service-linked roles. re:Post Private resource-based policies 8 AWS re:Post Private Service roles Console Administration Guide This feature allows a service to assume a service role for you. This role allows the service to access resources in other services to complete an action for you. For more information, see Creating a role to delegate permissions to an AWS service. Service roles appear in your IAM account and are owned by the account. This means that an IAM administrator can change the permissions for this role. However, doing so might break the functionality of the service. Using service-linked roles for re:Post Private AWS re:Post Private uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that's linked directly to re:Post Private. Service- linked roles are predeﬁned by re:Post Private and include all the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up re:Post Private easier because you don’t have to manually add the necessary permissions. re:Post Private deﬁnes the permissions of its service-linked roles, and unless deﬁned otherwise, only re:Post Private can assume its roles. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy can't be attached to any other IAM entity. For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked roles column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for re:Post Private re:Post Private uses the service-linked role named AWSServiceRoleForrePostPrivate. re:Post Private uses this service-linked role to publish data to CloudWatch. The AWSServiceRoleForrePostPrivate service-linked role trusts the following services to assume the role: • repostspace.amazonaws.com The role permissions policy named AWSrePostPrivateCloudWatchAccess allows re:Post Private to complete the following actions on the speciﬁed resources: • Action on cloudwatch: PutMetricData Service roles 9 AWS re:Post Private Console Administration Guide You must conﬁgure permissions to allow your users, groups, or roles to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide. For more information, see AWSrePostPrivateCloudWatchAccess. Creating a service-linked role for re:Post Private You don't need to manually create a service-linked role. When you create your ﬁrst private re:Post in the AWS Management Console, the AWS CLI, or the AWS API, re:Post Private creates the service- linked role for you. Important This service-linked role can appear in your account if you completed an action in another service that uses the features supported by this role. Also, if you were using the re:Post Private service before December 1, 2023, when it began supporting service-linked roles, then re:Post Private created the AWSServiceRoleForrePostPrivate role in your account. To learn more, see A new role appeared in my AWS account. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create your ﬁrst private re:Post, re:Post Private creates the service-linked role for you again. In the AWS CLI or the AWS API, create a service-linked role with the repostspace.amazonaws.com service name. For more information, see Creating a service-linked role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again. Editing a service-linked role for re:Post Private re:Post Private doesn't allow you to edit the AWSServiceRoleForrePostPrivate service-linked role. After you create a service-linked role, you can't change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide. Using service-linked roles 10 AWS re:Post Private Console Administration Guide Deleting a service-linked role for re:Post Private You don't need to manually delete the AWSServiceRoleForrePostPrivate role. When you delete your private re:Post in the AWS Management Console, the AWS CLI, or the AWS API, re:Post Private deletes the service-linked role for you. You can also use the IAM console, the AWS CLI, or the AWS API to manually delete the service- linked role. To manually delete the service-linked role using IAM Use the IAM console, the
space-cag-006	space-cag.pdf	6	IAM. For more information, see Editing a service-linked role in the IAM User Guide. Using service-linked roles 10 AWS re:Post Private Console Administration Guide Deleting a service-linked role for re:Post Private You don't need to manually delete the AWSServiceRoleForrePostPrivate role. When you delete your private re:Post in the AWS Management Console, the AWS CLI, or the AWS API, re:Post Private deletes the service-linked role for you. You can also use the IAM console, the AWS CLI, or the AWS API to manually delete the service- linked role. To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForrePostPrivate service-linked role. For more information, see Deleting a service-linked role in the IAM User Guide. Supported Regions for re:Post Private service-linked roles re:Post Private supports using service-linked roles in the AWS Regions where the service is available. Region name Region identity Support in re:Post Private US East (N. Virginia) US East (Ohio) US West (N. California) US West (Oregon) Africa (Cape Town) Asia Paciﬁc (Hong Kong) us-east-1 us-east-2 us-west-1 us-west-2 af-south-1 ap-east-1 Asia Paciﬁc (Jakarta) ap-southeast-3 Asia Paciﬁc (Mumbai) Asia Paciﬁc (Osaka) Asia Paciﬁc (Seoul) ap-south-1 ap-northeast-3 ap-northeast-2 Yes No No Yes No No No No No No Using service-linked roles 11 AWS re:Post Private Region name Asia Paciﬁc (Singapore) Asia Paciﬁc (Sydney) Asia Paciﬁc (Tokyo) Canada (Central) Europe (Frankfurt) Europe (Ireland) Europe (London) Europe (Milan) Europe (Paris) Europe (Stockholm) Middle East (Bahrain) Middle East (UAE) South America (São Paulo) Region identity ap-southeast-1 ap-southeast-2 ap-northeast-1 ca-central-1 eu-central-1 eu-west-1 eu-west-2 eu-south-1 eu-west-3 eu-north-1 me-south-1 me-central-1 sa-east-1 Console Administration Guide Support in re:Post Private Yes Yes No Yes Yes Yes No No No No No No No AWS re:Post Private identity-based policy examples Note For greater security, create federated users instead of IAM users whenever possible. By default, AWS Identity and Access Management users and roles don't have permission to create or modify AWS re:Post Private resources. They also can't perform tasks using the AWS Management Console, AWS CLI, or AWS API. An IAM administrator must create IAM policies that grant users and roles permission to perform speciﬁc API operations on the speciﬁed resources they need. Identity-based policy examples 12 AWS re:Post Private Console Administration Guide The administrator must then attach those policies to the IAM users or groups that require those permissions. To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating IAM policies in the IAM User Guide. Topics • Policy best practices • Allow users to view their own permissions Policy best practices Identity-based policies determine whether someone can create, access, or delete re:Post Private resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and Identity-based policy examples 13 AWS re:Post Private Console Administration Guide functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in
space-cag-007	space-cag.pdf	7	to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and Identity-based policy examples 13 AWS re:Post Private Console Administration Guide functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", Identity-based policy examples 14 AWS re:Post Private Console Administration Guide "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Inline policies Inline policies are policies that you create and manage. You can embed inline policies directly into a user, group, or role. The following policy examples show how to assign permissions to perform AWS re:Post Private actions. For general information about inline policies, see Managing IAM policies in the AWS IAM User Guide. You can use the AWS Management Console, AWS Command Line Interface (AWS CLI), or the AWS Identity and Access Management API to create and embed inline policies. Topics • Read-only access to re:Post Private • Full access to re:Post Private Read-only access to re:Post Private The following policy grants read access to a user for IAM Identity Center and re:Post Private console. This policy allows the user to perform re:Post Private actions that are read only. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "organizations:DescribeOrganization", "organizations:DescribeAccount", "sso:DescribeRegisteredRegions", "sso:ListDirectoryAssociations", "sso:GetSSOStatus", "sso:GetManagedApplicationInstance", Inline policies 15 AWS re:Post Private Console Administration Guide "sso:ListProfiles", "sso:GetProfile", "sso:ListProfileAssociations", "sso-directory:DescribeDirectory", "sso-directory:SearchUsers", "sso-directory:SearchGroups", "repostspace:GetSpace", "repostspace:ListSpaces", "repostspace:ListTagsForResource" ], "Resource": "" } ] } Full access to re:Post Private The following policy grants full access to a user for IAM Identity Center and re:Post Private console. This policy allows the user to perform all re:Post Private actions. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "organizations:DescribeOrganization", "organizations:DescribeAccount", "sso:DescribeRegisteredRegions", "sso:ListDirectoryAssociations", "sso:GetSSOStatus", "sso:GetManagedApplicationInstance", "sso:ListProfiles", "sso:GetProfile", "sso:ListProfileAssociations", "sso:CreateManagedApplicationInstance", Inline policies 16 AWS re:Post Private Console Administration Guide "sso:DeleteManagedApplicationInstance", "sso:AssociateProfile", "sso:DisassociateProfile", "sso-directory:DescribeDirectory", "sso-directory:SearchUsers", "sso-directory:SearchGroups", "kms:ListAliases", "kms:DescribeKey", "kms:CreateGrant", "kms:RetireGrant", "repostspace:" ], "Resource": "*" } ] } AWS managed policies for AWS re:Post Private Using AWS managed policies makes adding permissions to users, groups, and roles easier than writing policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. Use AWS managed policies to get started quickly. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services might occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services don't remove permissions from an AWS managed policy, so policy updates don't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For more information, see AWS managed policies in the IAM User Guide. AWS managed policies 17 AWS re:Post Private Topics • AWS managed policy: AWSRepostSpaceSupportOperationsPolicy • AWS managed policy: AWSrePostPrivateCloudWatchAccess • AWS re:Post Private updates to AWS managed policies Console Administration Guide AWS managed policy: AWSRepostSpaceSupportOperationsPolicy This policy allows the AWS re:Post Private service to create, manage, and resolve Support cases that are created through the re:Post Private web application. { "Version":
space-cag-008	space-cag.pdf	8	AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For more information, see AWS managed policies in the IAM User Guide. AWS managed policies 17 AWS re:Post Private Topics • AWS managed policy: AWSRepostSpaceSupportOperationsPolicy • AWS managed policy: AWSrePostPrivateCloudWatchAccess • AWS re:Post Private updates to AWS managed policies Console Administration Guide AWS managed policy: AWSRepostSpaceSupportOperationsPolicy This policy allows the AWS re:Post Private service to create, manage, and resolve Support cases that are created through the re:Post Private web application. { "Version": "2012-10-17", "Statement": [ { "Sid": "RepostSpaceSupportOperations", "Effect": "Allow", "Action": [ "support:AddAttachmentsToSet", "support:AddCommunicationToCase", "support:CreateCase", "support:DescribeCases", "support:DescribeCommunications", "support:ResolveCase" ], "Resource": "" } ] } AWS managed policy: AWSrePostPrivateCloudWatchAccess This policy allows the re:Post Private service to publish data to CloudWatch. { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchPublishMetrics", "Effect": "Allow", AWS managed policies 18 Console Administration Guide AWS re:Post Private "Action": [ "cloudwatch:PutMetricData" ], "Resource": "", "Condition": { "StringEquals": { "cloudwatch:namespace": [ "AWS/rePostPrivate", "AWS/Usage" ] } } } ] } AWS re:Post Private updates to AWS managed policies View details about updates to AWS managed policies for re:Post Private since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Document history page. The following table describes important updates to the re:Post Private managed policies since November 26, 2023. Change Description Date New policy - AWSrePost PrivateCloudWatchAccess New managed policy for publishing data to CloudWatc h November 26, 2023 New policy - AWSRepost SpaceSupportOperationsPolic y New managed policy for the AWS Support feature in AWS re:Post Private November 26, 2023 re:Post Private started tracking changes re:Post Private started tracking changes for its AWS November 26, 2023 managed policies AWS managed policies 19 AWS re:Post Private Console Administration Guide Troubleshooting AWS re:Post Private identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with re:Post Private and IAM. Topics • I am not authorized to perform an action in re:Post Private • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my re:Post Private resources I am not authorized to perform an action in re:Post Private If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a ﬁctional my-example-widget resource but doesn't have the ﬁctional repostPrivate:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: repostPrivate:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the repostPrivate:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to re:Post Private. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in re:Post Private. However, the action requires the service to have Troubleshooting 20 AWS re:Post Private Console Administration Guide permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my re:Post Private resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether re:Post Private supports these features, see How re:Post Private works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User
space-cag-009	space-cag.pdf	9	people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether re:Post Private supports these features, see How re:Post Private works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance validation for AWS re:Post Private To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. Compliance validation 21 AWS re:Post Private Console Administration Guide You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in AWS re:Post Private The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with Resilience 22 AWS re:Post Private Console Administration Guide low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Infrastructure Security in AWS re:Post Private As a managed service, AWS re:Post Private is protected by the AWS global network security procedures that are described in the Amazon Web Services: Overview of Security Processes whitepaper. You use AWS published API calls to access re:Post Private through the network. Clients must support Transport Layer Security (TLS) 1.0 or later. We recommend TLS 1.2 or later. Clients must also support cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe- Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an AWS Identity and Access Management principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Infrastructure Security
space-cag-010	space-cag.pdf	10	network. Clients must support Transport Layer Security (TLS) 1.0 or later. We recommend TLS 1.2 or later. Clients must also support cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe- Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an AWS Identity and Access Management principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Infrastructure Security 23 AWS re:Post Private Console Administration Guide re:Post Private quotas AWS re:Post Private provides private re:Posts that you can use in your account in a given AWS Region. When you sign up for re:Post Private, AWS sets default quotas (formerly referred to as limits) on the number of private re:Posts that you can create and size of the private re:Posts. Service quotas The following are the default quotas for re:Post Private for your AWS account. You can use the Service Quotas console to view the default quota. None of these quotas are adjustable. You can't request a quota increase. Resource Default Description Adjustable Number of private re:Posts 3 Free private re:Post size 10 Standard private re:Post size 100 API throttling limits No The maximum number of private re:Posts in this account in the current Region. The maximum size (in GB) of a free private No re:Post. The maximum size (in GB) of a standard No private re:Post. The following throttling limits apply per account, per Region in re:Post Private. These quotas can't be increased. Actions Token reﬁll rate Rate of requests CreateSpace 1 1 Service quotas 24 AWS re:Post Private Console Administration Guide Actions Token reﬁll rate Rate of requests ListSpaces GetSpace UpdateSpace DeleteSpace RegisterAdmin DeRegisterAdmin SendInvites TagResource UnTagResource ListTagsForResource 10 10 10 1 10 10 1 10 10 10 10 10 10 1 100 100 1 10 10 10 API throttling limits 25 AWS re:Post Private Console Administration Guide Create, conﬁgure, and customize your private re:Post This section explains how you can create, conﬁgure, and customize your private re:Post in the AWS re:Post Private console. Topics • Create a new private re:Post • Manage access to Support case creation and management in re:Post Private • Set up and manage user access using AWS IAM Identity Center • Customize your private re:Post • Invite users to your private re:Post Create a new private re:Post To create a new private re:Post, follow these steps: 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. On the console's homepage, choose Create private re:Post. 3. If you don’t have IAM Identity Center conﬁgured for your account yet, then choose Open Identity Center. Follow the instructions in Getting started in the AWS IAM Identity Center User Guide. 4. On the Create private re:Post page, for Pricing, select Free tier or Standard tier based on your use case. If you already used Free Tier for your account, then Free tier option isn't available to you. 5. Under Details, do the following: For Name, enter a unique name for your private re:Post. (Optional) For Description, enter a brief description for your private re:Post. For Custom subdomain, enter a custom name for your subdomain. 6. (Optional) To customize your data encryption settings, under Data encryption, select Customize encryption settings. Then, do either of the following actions: Create a new private re:Post 26 AWS re:Post Private Console Administration Guide For Choose an AWS KMS key, select an AWS Key Management Service key or an Amazon Resource Name (ARN). -or- Choose Create an AWS KMS key. Then, create the AWS KMS key. 7. (Optional) Under Service access for Support case integration, select Enable service access for this re:Post. Note You can also turn on this option after you create the private re:Post. For Please select an existing IAM role below or create a new role in IAM console, use the search bar to ﬁnd your existing IAM role. -or- Choose create a new role in IAM console. If you choose to create a new role, then follow the instructions in Create an IAM role. If you choose to use an existing service role, then in the search bar, enter the ARN of the role that you want to use. Choose the role from the dropdown list. For more information, see Manage access to Support case creation and management in re:Post Private. 8. (Optional) Under Tags, choose Add new tag. Then enter the following information: For Key, enter your custom tag key. For Value, enter your custom tag value. To add more tags, choose Add new tag. 9. Choose Create this re:Post. Create a new private re:Post 27 AWS re:Post Private Console Administration Guide A conﬁrmation page will let you know
space-cag-011	space-cag.pdf	11	existing service role, then in the search bar, enter the ARN of the role that you want to use. Choose the role from the dropdown list. For more information, see Manage access to Support case creation and management in re:Post Private. 8. (Optional) Under Tags, choose Add new tag. Then enter the following information: For Key, enter your custom tag key. For Value, enter your custom tag value. To add more tags, choose Add new tag. 9. Choose Create this re:Post. Create a new private re:Post 27 AWS re:Post Private Console Administration Guide A conﬁrmation page will let you know that your private re:Post is being created. You can view the status of the private re:Post in the Status ﬁeld. When your private re:Post is created, the Status ﬁeld displays Creating. It takes approximately 30 minutes for the private re:Post to be created. When your private re:Post is ready, the Status ﬁeld displays Online. You can use the AWS generated subdomain for your private re:Post that's listed under the Settings tab to access your private re:Post. You can view the Custom subdomain for your private re:Post under the Settings tab after the review is completed. Note From April 18, 2025, all new re:Post Private instances support dual stack networking with both IPv4 and IPv6 connectivity. Manage access to Support case creation and management in re:Post Private You must create an AWS Identity and Access Management (IAM) role to manage access to Support case creation and management from AWS re:Post Private. This role performs the following Support actions for you: • CreateCase • AddCommunicationToCase • ResolveCase After you create the IAM role, attach an IAM policy to this role so that the role has the required permissions to complete these actions. You choose this role when you create your private re:Post in the re:Post Private console. Users in your private re:Post have the same permissions that you grant to the IAM role. Important If you change the IAM role or the IAM policy, then your changes apply to the private re:Post that you conﬁgured. Manage Support case creation and management 28 AWS re:Post Private Console Administration Guide Follow these procedures to create your IAM role and policy. Topics • Use an AWS managed policy or create a customer managed policy • Example IAM policy • Create an IAM role • Troubleshooting Use an AWS managed policy or create a customer managed policy To grant your role permissions, you can use either an AWS managed policy or a customer managed policy. Tip If you don't want to create a policy manually, then we recommend that you use an AWS managed policy instead and skip this procedure. Managed policies automatically have the required permissions for Support. You don't need to update the policies manually. For more information, see AWS managed policy: AWSRepostSpaceSupportOperationsPolicy. Follow this procedure to create a customer managed policy for your role. This procedure uses the JSON policy editor in the IAM console. To create a customer managed policy for re:Post Private 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. In the navigation pane, choose Policies. 3. Choose Create policy. 4. Choose the JSON tab. 5. Enter your JSON, and then replace the default JSON in the editor. You can use the example policy. 6. Choose Next: Tags. 7. (Optional) You can use tags as key–value pairs to add metadata to the policy. Use or create a managed policy 29 AWS re:Post Private 8. Choose Next: Review. Console Administration Guide 9. On the Review policy page, enter a Name, such as rePostPrivateSupportPolicy, and a Description (optional). 10. Review the Summary page to see the permissions that the policy allows, and then choose Create policy. This policy deﬁnes the actions that the role can take. For more information, see Creating IAM policies (console) in the IAM User Guide. Example IAM policy You can attach the following example policy to your IAM role. This policy allows the role to have full permissions to all required actions for Support. After you conﬁgure a private re:Post with the role, any user in your private re:Post has the same permissions. { "Version": "2012-10-17", "Statement": [ { "Sid": "RepostSpaceSupportOperations", "Effect": "Allow", "Action": [ "support:AddAttachmentsToSet", "support:AddCommunicationToCase", "support:CreateCase", "support:DescribeCases", "support:DescribeCommunications", "support:ResolveCase" ], "Resource": "*" } ] } Note For a list of AWS managed policies for re:Post Private, see AWS managed policies for AWS re:Post Private. Example IAM policy 30 AWS re:Post Private Console Administration Guide You can update the policy to remove a permission from Support. For descriptions for each action, see the following topics in the Service Authorization Reference: • Actions, resources, and condition keys for AWS Support • Actions, resources, and condition keys for Service Quotas • Actions, resources, and condition keys for AWS Identity and Access
space-cag-012	space-cag.pdf	12	"RepostSpaceSupportOperations", "Effect": "Allow", "Action": [ "support:AddAttachmentsToSet", "support:AddCommunicationToCase", "support:CreateCase", "support:DescribeCases", "support:DescribeCommunications", "support:ResolveCase" ], "Resource": "*" } ] } Note For a list of AWS managed policies for re:Post Private, see AWS managed policies for AWS re:Post Private. Example IAM policy 30 AWS re:Post Private Console Administration Guide You can update the policy to remove a permission from Support. For descriptions for each action, see the following topics in the Service Authorization Reference: • Actions, resources, and condition keys for AWS Support • Actions, resources, and condition keys for Service Quotas • Actions, resources, and condition keys for AWS Identity and Access Management Create an IAM role After you create the policy, you must create an IAM role, and then attach the policy to that role. You choose this role when you create a private re:Post in the re:Post Private console. To create a role for Support case creation and management 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. 3. 4. In the navigation pane, choose Roles, and then choose Create role. For Trusted entity type, choose Custom trust policy. For Custom trust policy, enter the following: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "repostspace.amazonaws.com" }, "Action": [ "sts:AssumeRole", "sts:SetSourceIdentity" ] } ] } 5. Choose Next. Create an IAM role 31 AWS re:Post Private Console Administration Guide 6. Under Permissions policies, in the search bar, enter the AWS managed policy or a customer managed policy that you created, such as rePostPrivateSupportPolicy. Select the check box that's next to the permissions policies that you want the service to have. 7. Choose Next. 8. On the Name, review, and create page, for Role name, enter a name, such as rePostPrivateSupportRole. 9. (Optional) For Description, enter a description for the role. 10. Review the trust policy and permissions. 11. (Optional) You can use tags as key–value pairs to add metadata to the role. For more information about using tags in IAM, see Tagging IAM resources. 12. Choose Create role. You can now choose this role when you conﬁgure a private re:Post in the re:Post Private console. See Create a new private re:Post. For more information, see Creating a role for an AWS service (console) in the IAM User Guide. Troubleshooting See the following topics to manage access to re:Post Private. Contents • I want to restrict speciﬁc users in my private re:Post from speciﬁc actions • When I conﬁgure a private re:Post, I don't see the IAM role that I created • My IAM role is missing a permission • An error says that my IAM role isn't valid I want to restrict speciﬁc users in my private re:Post from speciﬁc actions By default, users in your private re:Post have the same permissions speciﬁed in the IAM policy that you attach to the IAM role that you create. This means that anyone in the private re:Post has read or write access to create and manage Support cases, whether or not they have an AWS account or an IAM user. We recommend the following best practices: • Use an IAM policy that has the minimum required permissions to the Support. See AWS managed policy: AWSRepostSpaceSupportOperationsPolicy. Troubleshooting 32 AWS re:Post Private Console Administration Guide When I conﬁgure a private re:Post, I don't see the IAM role that I created If your IAM role doesn't appear in the IAM role for re:Post Private; list, this means that the role doesn't have re:Post Private as a trusted entity, or that the role was deleted. You can update the existing role, or create another one. See Create an IAM role. My IAM role is missing a permission The IAM role that you create for your private re:Post needs permissions to perform the actions that you want. For example, if you want your users in the private re:Post to create support cases, the role must have the support:CreateCase permission. re:Post Private assumes this role to perform these actions for you. If you receive an error about a missing permission for Support, verify that the policy attached to your role has the required permission. See the previous Example IAM policy. An error says that my IAM role isn't valid Verify that you chose the correct role for your private re:Post conﬁguration. Set up and manage user access using AWS IAM Identity Center re:Post Private integrates with AWS IAM Identity Center to provide identity federation for your organization's workforce. Use IAM Identity Center to create or connect users from your organization and centrally manage their access across all their AWS accounts and applications. For more information about IAM Identity Center, see What is AWS IAM Identity Center (successor to AWS Single Sign-On). For more information about getting started with IAM Identity Center, see Getting started. To use IAM Identity
space-cag-013	space-cag.pdf	13	valid Verify that you chose the correct role for your private re:Post conﬁguration. Set up and manage user access using AWS IAM Identity Center re:Post Private integrates with AWS IAM Identity Center to provide identity federation for your organization's workforce. Use IAM Identity Center to create or connect users from your organization and centrally manage their access across all their AWS accounts and applications. For more information about IAM Identity Center, see What is AWS IAM Identity Center (successor to AWS Single Sign-On). For more information about getting started with IAM Identity Center, see Getting started. To use IAM Identity Center, you must also have AWS Organizations activated for the account. Customize your private re:Post You can add one or more administrators to your private re:Post after you create it. Administrators use the re:Post Private application to launch the private re:Post and manage users within it. They can customize branding for the private re:Post, add tags to classify content, and select topics of interest for automatic population of content. For more information, see AWS re:Post Private Administration Guide. Set up and manage user access 33 AWS re:Post Private Console Administration Guide Invite users to your private re:Post You can add one or more users to your private re:Post after you create it. You can invite users to collaborate within your private re:Post. Users use the re:Post Private application to sign in using credentials that you conﬁgured. After signing in to a private re:Post, users can browse or search existing content, including tailored training and technical content that are scoped to their topics of interest. For more information, see AWS re:Post Private User Guide. Invite users to your private re:Post 34 AWS re:Post Private Console Administration Guide Manage your private re:Post in the re:Post Private console This section explains how you can manage your private re:Post in the AWS re:Post Private console. Topics • Add users to your private re:Post • Add groups to your private re:Post • Add users to a group in your private re:Post • Invite users and groups to your private re:Post • Assign a role to a user in your private re:Post • Remove users from your private re:Post • Remove groups from your private re:Post • Add or remove an AWS employee from your private re:Post • Delete your private re:Post Add users to your private re:Post If you're an administrator, you can add users to your private re:Post. 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage. 4. Choose the Users tab. 5. Under Users, choose Add users and groups. 6. From the list, select the users that you want to add to your private re:Post. Then, choose Assign. The selected users are added to your private re:Post and listed under the Users tab. The users that you've added will receive an onboarding email from your private re:Post. Your private re:Post reviews the list of users and groups once every day to make sure that an onboarding Add users 35 AWS re:Post Private Console Administration Guide email is sent to those that didn't already receive one. The onboarding email contains information on how to sign in to your private re:Post. Add groups to your private re:Post If you're an administrator, you can add groups to your private re:Post. 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage. 4. Choose the Groups tab. 5. Choose Add users and groups. 6. From the list, select the groups that you want to add to your private re:Post. Then, choose Assign. The selected groups are added to your private re:Post and listed under the Groups tab. The groups that you've added will receive an onboarding email from your private re:Post. Your private re:Post reviews the list of users and groups once every day to make sure that an onboarding email is sent to those that didn't already receive one. The onboarding email contains information on how to sign in to your private re:Post. Add users to a group in your private re:Post Use IAM Identity Center to add new users to an existing group in your private re:Post. For more information, see Add users to groups in the AWS IAM Identity Center User Guide. Invite users and groups to your private re:Post Note Inviting users and groups to your private re:Post is optional. The users and groups that you've added will receive an onboarding email from your private re:Post. Your private re:Post reviews the list of users and groups once every day to make sure that an onboarding email is sent to those that didn't already receive one. Add groups
space-cag-014	space-cag.pdf	14	private re:Post Use IAM Identity Center to add new users to an existing group in your private re:Post. For more information, see Add users to groups in the AWS IAM Identity Center User Guide. Invite users and groups to your private re:Post Note Inviting users and groups to your private re:Post is optional. The users and groups that you've added will receive an onboarding email from your private re:Post. Your private re:Post reviews the list of users and groups once every day to make sure that an onboarding email is sent to those that didn't already receive one. Add groups 36 AWS re:Post Private Console Administration Guide Follow these steps to manually invite users and groups to your private re:Post in AWS re:Post Private: 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage. 4. To invite users to your private re:Post, choose the Users tab. From the list, select the users that you want to invite to your private re:Post. Then, choose Onboard users to re:Post. 5. In the Onboard users to this private re:Post dialog box, enter the following information: For Subject, enter the subject for the email message that you're sending. For Body, enter a welcome message for your private re:Post. Choose Send onboarding email. 6. To invite groups to your private re:Post, choose the Groups tab. From the list, select the groups that you want to invite to your private re:Post. Then, choose Onboard groups to re:Post. 7. In the Onboard groups to this private re:Post dialog box, enter the following information: For Subject, enter the subject for the email message that you're sending. For Body, enter a welcome message for your private re:Post. Choose Send onboarding email. The welcome message is sent to all selected users and groups with information on how sign in to your private re:Post. Assign a role to a user in your private re:Post You can assign your private re:Post users one of the following permissions: • Administrator: A user who has permissions to modify the conﬁguration of your private re:Post • Expert: A user who has permissions to review and validate answers that the community provided Assign a role to a user 37 AWS re:Post Private Console Administration Guide • Moderator: A user who can respond to requests in the moderation queue • Support requester: A user who can create tickets to Support from the questions that they posted To assign a role to your private re:Post user, follow these steps: 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage. 4. Choose the Users tab. 5. Select one or more users that you want to assign the roles for. 6. Choose Edit role, and then choose the role that you want to assign to the selected users. The selected users are assigned the role that you chose. Under the Users tab, the Role for these users is updated to the role that you chose. Remove users from your private re:Post If you're an administrator, then you can remove users from your private re:Post. 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage. 4. Under Users, from the list, select the users that you want to remove from your private re:Post. Then, choose Remove. The selected users are removed from your private re:Post. Information about the removed users no longer appears under the Users tab. Remove groups from your private re:Post If you're an administrator, then you can remove groups from your private re:Post. 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. Remove users 38 AWS re:Post Private Console Administration Guide 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage. 4. Choose the Groups tab. 5. From the list, select the groups that you want to remove from your private re:Post. Then, choose Remove. The selected groups are removed from your private re:Post. Information about the removed groups no longer appears under the Groups tab. Add or remove an AWS employee from your private re:Post If you have an Enterprise or Enterprise On-Ramp Support Plan, then you can add or remove an AWS employee from your private re:Post. Contact Concierge Support or your Technical Account Manager (TAM) for more information. Delete your private re:Post To delete a private re:Post in AWS re:Post Private, follow these steps: 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage,
space-cag-015	space-cag.pdf	15	about the removed groups no longer appears under the Groups tab. Add or remove an AWS employee from your private re:Post If you have an Enterprise or Enterprise On-Ramp Support Plan, then you can add or remove an AWS employee from your private re:Post. Contact Concierge Support or your Technical Account Manager (TAM) for more information. Delete your private re:Post To delete a private re:Post in AWS re:Post Private, follow these steps: 1. Open the re:Post Private console at https://console.aws.amazon.com/repost-private/. 2. In the navigation pane, choose All my private re:Posts. 3. Choose the private re:Post that you want to manage, and then choose Delete. 4. Select all options to acknowledge and conﬁrm that you want to permanently delete the private re:Post and data that's associated with it. Important When you delete the private re:Post, all the conﬁguration information that's related to the private re:Post will be deleted. After the private re:Post is deleted, you can't restore any content from it. 5. Enter the name of your private re:Post when prompted for additional written consent. Then, choose Delete. It takes approximately 30 minutes for your private re:Post to be deleted. Add or remove an AWS employee 39 AWS re:Post Private Console Administration Guide Monitoring AWS re:Post Private Monitoring is an important part of maintaining the reliability, availability, and performance of AWS re:Post Private and your other AWS solutions. AWS provides the following monitoring tools to watch re:Post Private, report when something is wrong, and take automatic actions when appropriate: • Amazon CloudWatch monitors your AWS resources and the applications you run on AWS in real time. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a speciﬁed metric reaches a threshold that you specify. For example, you can have CloudWatch track CPU usage or other metrics of your Amazon EC2 instances and automatically launch new instances when needed. For more information, see the Amazon CloudWatch User Guide. • AWS CloudTrail captures API calls and related events made by or for your AWS account and delivers the log ﬁles to an Amazon S3 bucket that you specify. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see the AWS CloudTrail User Guide. Monitoring AWS re:Post Private with Amazon CloudWatch You can monitor AWS re:Post Private using Amazon CloudWatch, which collects raw data and processes it into readable, near real-time metrics. These statistics are kept for 15 months so that you can access historical information and gain a better perspective on how your web application or service is performing. You can also set alarms that watch for certain thresholds, and send notiﬁcations or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. The re:Post Private service reports the following metrics in the AWS/rePostPrivate namespace. Metric Description NumberOfSpaces The number of private re:Posts in the current account. Units: Count NumberOfUsers The number of users in a private re:Post. This metric uses spaceId as a dimension. Monitoring with CloudWatch 40 AWS re:Post Private Metric Description Units: Count Console Administration Guide ContentSize The amount of content in a private re:Post. This metric uses spaceId as a dimension. Units: Bytes The following dimensions are supported for the re:Post Private metrics. Dimension spaceId Description The unique identiﬁer for the private re:Post. Logging AWS re:Post Private API calls using AWS CloudTrail AWS re:Post Private is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in re:Post Private. CloudTrail captures all API calls for re:Post Private as events. The calls captured include calls from the re:Post Private console and code calls to the re:Post Private API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for re:Post Private. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to re:Post Private, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. re:Post Private information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in re:Post Private, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Working with CloudTrail Event history. For an ongoing record of events in your AWS account, including events for
space-cag-016	space-cag.pdf	16	the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. re:Post Private information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in re:Post Private, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Working with CloudTrail Event history. For an ongoing record of events in your AWS account, including events for re:Post Private, create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when Logging re:Post Private API calls using AWS CloudTrail 41 AWS re:Post Private Console Administration Guide you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Creating a trail for your AWS account • CloudTrail supported services and integrations • Conﬁguring Amazon SNS notiﬁcations for CloudTrail • Receiving CloudTrail log ﬁles from multiple Regions and Receiving CloudTrail log ﬁles from multiple accounts All re:Post Private actions are logged by CloudTrail and are documented in the AWS re:Post Private API Reference. re:Post Private supports logging the following actions as events in CloudTrail log ﬁles: • CreateSpace • DeleteSpace • DeregisterAdmin • GetSpace • ListSpaces • ListTagsForResource • RegisterAdmin • SendInvites • TagResource • UntagResource • UpdateSpace re:Post Private supports logging the following Support actions as events in the CloudTrail log ﬁles: • CreateCase • AddCommunicationToCase • ResolveCase re:Post Private information in CloudTrail 42 AWS re:Post Private Console Administration Guide Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. For more information, see the CloudTrail userIdentity element. Understanding re:Post Private log ﬁle entries A trail is a conﬁguration that enables delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log ﬁles aren't an ordered stack trace of the public API calls, so they don't appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the CreateSpace action. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAQM47QIR7WLEXAMPLE:user", "arn": "arn:aws:sts::123456789012:assumed-role/User/user", "accountId": "123456789012", "accessKeyId": "EXAMPLE_KEY_ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAQM47QIR7WLEXAMPLE", "arn": "arn:aws:iam::123456789012:role/User", "accountId": "123456789012", "userName": "User" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-11-06T19:24:39Z", "mfaAuthenticated": "false" Understanding re:Post Private log ﬁle entries 43 AWS re:Post Private } } }, "eventTime": "2023-11-06T21:37:44Z", "eventSource": "repostspace.amazonaws.com", "eventName": "CreateSpace", "awsRegion": "us-west-2", "sourceIPAddress": "205.251.233.176", Console Administration Guide "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36", "requestParameters": { "spaceName": "Test space name", "spaceSubdomain": "customsubdomain", "tagSet": {}, "tier": "2000", "roleArn": "", "spaceDescription": "Test space description" }, "responseElements": { "spaceId": "SPLPWvQmv9SIWYF30EXAMPLE", "Access-Control-Expose-Headers": "x-amzn-errortype, x-amzn-requestid, x-amzn- errormessage, x-amzn-trace-id, x-amz-apigw-id, date" }, "requestID": "71d815e0-6632-4ec9-9fac-92af3e4a86dc", "eventID": "30a6c3da-ce2e-4931-ba5d-b3cc7cf16ec8", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management" } The following example shows a CloudTrail log entry that demonstrates the RegisterAdmin action. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAQM47QIR7WLEXAMPLE:user", "arn": "arn:aws:sts::123456789012:assumed-role/User/user", Understanding re:Post Private log ﬁle entries 44 AWS re:Post Private Console Administration Guide "accountId": "123456789012", "accessKeyId": "EXAMPLE_KEY_ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAQM47QIR7WLEXAMPLE", "arn": "arn:aws:iam::123456789012:role/User", "accountId": "123456789012", "userName": "User" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-11-07T21:17:19Z", "mfaAuthenticated": "false" } } }, "eventTime": "2023-11-07T21:24:23Z", "eventSource": "repostspace.amazonaws.com", "eventName": "RegisterAdmin", "awsRegion": "us-west-2", "sourceIPAddress": "205.251.233.183", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36", "requestParameters": { "adminId": "08612310-a0f1-7063-3e54-fb2960444dd1", "spaceId": "SPlYNZE-ylQEmAXpmEXAMPLE" }, "responseElements": { "Access-Control-Expose-Headers": "x-amzn-errortype, x-amzn-requestid, x-amzn- errormessage, x-amzn-trace-id, x-amz-apigw-id, date" }, "requestID": "9939ebbe-8599-4f9a-827b-4995e3006001", "eventID": "e1873b18-f80c-4934-9ff2-bf5b35c78031", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management" } The following example shows a CloudTrail log entry that demonstrates the ListSpaces action. Understanding re:Post Private log ﬁle entries 45 AWS re:Post Private Console Administration Guide { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAQM47QIR7WLEXAMPLE:user", "arn": "arn:aws:sts::123456789012:assumed-role/User/user", "accountId": "123456789012", "accessKeyId": "EXAMPLE_KEY_ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAQM47QIR7WLEXAMPLE", "arn": "arn:aws:iam::123456789012:role/User", "accountId": "123456789012", "userName": "User" }, "webIdFederationData": {}, "attributes":
space-cag-017	space-cag.pdf	17	X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36", "requestParameters": { "adminId": "08612310-a0f1-7063-3e54-fb2960444dd1", "spaceId": "SPlYNZE-ylQEmAXpmEXAMPLE" }, "responseElements": { "Access-Control-Expose-Headers": "x-amzn-errortype, x-amzn-requestid, x-amzn- errormessage, x-amzn-trace-id, x-amz-apigw-id, date" }, "requestID": "9939ebbe-8599-4f9a-827b-4995e3006001", "eventID": "e1873b18-f80c-4934-9ff2-bf5b35c78031", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management" } The following example shows a CloudTrail log entry that demonstrates the ListSpaces action. Understanding re:Post Private log ﬁle entries 45 AWS re:Post Private Console Administration Guide { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAQM47QIR7WLEXAMPLE:user", "arn": "arn:aws:sts::123456789012:assumed-role/User/user", "accountId": "123456789012", "accessKeyId": "EXAMPLE_KEY_ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAQM47QIR7WLEXAMPLE", "arn": "arn:aws:iam::123456789012:role/User", "accountId": "123456789012", "userName": "User" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-11-09T22:28:23Z", "mfaAuthenticated": "false" } } }, "eventTime": "2023-11-09T22:38:34Z", "eventSource": "repostspace.amazonaws.com", "eventName": "ListSpaces", "awsRegion": "us-west-2", "sourceIPAddress": "205.251.233.176", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36", "requestParameters": null, "responseElements": null, "requestID": "95be587b-c04f-4eb0-9269-12fee33ae2e3", "eventID": "9777da32-545f-44c4-af0b-1d9109b8cbc3", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management" } Understanding re:Post Private log ﬁle entries 46 AWS re:Post Private Console Administration Guide The following example shows a CloudTrail log entry that demonstrates the ResolveCase action. You can use the sourceIdentity element in this log entry to identify the user that resolved the case. { "eventVersion": "1.09", "userIdentity": { "type": "AssumedRole", "principalId": "AROAQM47QIR76DQZ7N5WX:create-support-case- Uk1iHNTWQEOLmR2BR1FDJQ", "arn": "arn:aws:sts::123456789012:assumed-role/AWSRepostSpaceRole/create- support-case-Uk1iHNTWQEOLmR2BR1FDJQ", "accountId": "123456789012", "accessKeyId": "EXAMPLE_KEY_ID", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAQM47QIR76DQZ7N5WX", "arn": "arn:aws:iam::123456789012:role/AWSRepostSpaceRole", "accountId": "123456789012", "userName": "AWSRepostSpaceRole" }, "attributes": { "creationDate": "2023-11-17T21:46:42Z", "mfaAuthenticated": "false" }, "sourceIdentity": "28e17330-10f1-705d-7cba-3a62a6b10e2e" } }, "eventTime": "2023-11-17T21:46:44Z", "eventSource": "support.amazonaws.com", "eventName": "ResolveCase", "awsRegion": "us-west-2", "sourceIPAddress": "54.68.27.29", "userAgent": "aws-sdk-nodejs/2.1363.0 linux/v16.20.2 exec-env/AWS_ECS_FARGATE promise", "requestParameters": { "caseId": "case-123456789012-muen-2023-75d2c35481b96357" }, "responseElements": { "initialCaseStatus": "unassigned", "finalCaseStatus": "resolved" }, Understanding re:Post Private log ﬁle entries 47 AWS re:Post Private Console Administration Guide "requestID": "594b91c6-df1c-47e4-a834-d67d67f34b9d", "eventID": "7fc9cbe4-c8d5-4d61-a016-e076de272fff", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111111111111", "eventCategory": "Management", "tlsDetails": { "clientProvidedHostHeader": "support.us-west-2.amazonaws.com" } } Understanding re:Post Private log ﬁle entries 48 AWS re:Post Private Console Administration Guide Troubleshooting re:Post Private The following information can help you troubleshoot issues with AWS re:Post Private. Topics • Can't set up my private re:Post in a speciﬁc AWS Region • Can't set up private re:Post in my account • Can't manage users or groups in a private re:Post Can't set up my private re:Post in a speciﬁc AWS Region re:Post Private is available only in US East (N. Virginia), US West (Oregon), Europe (Frankfurt), Asia Paciﬁc (Singapore), Asia Paciﬁc (Sydney), Canada (Central), and Europe (Ireland) Regions. Make sure that you're creating your private re:Post in one of these Regions. Can't set up private re:Post in my account Make sure that you enabled AWS IAM Identity Center for your account and set up IAM Identity Center in the same Region where you want to create the private re:Post. For more information, see Prerequisites. Can't manage users or groups in a private re:Post Be sure that you have the required permissions to edit a private re:Post and manage users and groups within the private re:Post. For more information, see AWS re:Post Private identity-based policy examples. Can't set up my private re:Post in a speciﬁc AWS Region 49 AWS re:Post Private Console Administration Guide Document history The following table describes the documentation releases for AWS re:Post Private: Change Update Update Update Description Date Information about support for IPv6 connectivity April 18, 2025 Instructions added for automatic onboarding of users and enhanced content moderation October 22, 2024 Instructions to assign roles to users moved from Adminstra October 9, 2024 tion Guide to Console Administration Guide Guide structure review and improvements The structure of the guide was reviewed and improveme September 24, 2024 Update Update Update nts were made to improve the customer experience related to ﬁnding information for speciﬁc scenarios. Added US East (N. Virginia), Asia Paciﬁc (Sydney), Canada (Central), and Europe (Ireland) to supported Regions May 10, 2024 Added Asia Paciﬁc (Singapore) to supported Regions March 6, 2024 Added information to indicate that re:Post Private supports only organization intances of IAM Identity Center January 16, 2024 50 AWS re:Post Private New resources Initial release Console Administration Guide November 26, 2023 November 26, 2023 Added documentation for AWS managed policies for AWS re:Post Private Initial release of the re:Post Private Console Administr ation Guide 51
space-ug-001	space-ug.pdf	1	User Guide AWS re:Post Private Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS re:Post Private User Guide AWS re:Post Private: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS re:Post Private Table of Contents User Guide What is AWS re:Post Private? ......................................................................................................... 1 Access re:Post Private .................................................................................................................................. 1 Pricing ............................................................................................................................................................. 1 Get invited ...................................................................................................................................................... 1 Browser requirements .................................................................................................................................. 2 Sign in .............................................................................................................................................. 3 Complete your proﬁle ..................................................................................................................... 4 Work within your private re:Post ................................................................................................... 5 Ask a question ............................................................................................................................................... 5 Get an answer from re:Post Agent ........................................................................................................... 6 Post an answer .............................................................................................................................................. 7 View a selection ............................................................................................................................................ 8 Publish a selection ....................................................................................................................................... 8 Publish an article .......................................................................................................................................... 9 Search within your private re:Post ......................................................................................................... 10 Create a discussion ............................................................................................................................... 11 Convert your question to an Support case .................................................................................. 13 Sign out .......................................................................................................................................... 15 Document history .......................................................................................................................... 16 iii AWS re:Post Private User Guide What is AWS re:Post Private? AWS re:Post Private is a private version of AWS re:Post for enterprises with Enterprise Support or Enterprise On-Ramp Support plans. It provides access to knowledge and experts to accelerate cloud adoption and increase developer productivity. With your organization-speciﬁc private re:Post, you can build an organization-speciﬁc developer community that drives eﬃciencies at scale and provides access to valuable knowledge resources. Additionally, re:Post Private centralizes trusted AWS technical content and oﬀers private discussion forums to improve how your teams collaborate internally and with AWS to remove technical obstacles, accelerate innovation, and scale more eﬃciently in the cloud. For more information, see AWS re:Post Private. Access re:Post Private Non-administrative users use the re:Post Private application to sign in using credentials that are conﬁgured by their administrator. After signing in to a private re:Post, you can browse or search existing content, including tailored training and technical content that are scoped to your topics of interest. You can also search AWS public technical content directly from their private re:Post and create private threads for internal discussions on AWS public content. You can collaboratively solve AWS technical problems and get technical guidance from other users of your private re:Post by asking a question, providing a response, or publishing an article. You can also convert a discussion thread into an Support case. You can choose to add the responses from Support to your private re:Post. Pricing For information on the pricing tiers for re:Post Private, see Pricing. Get invited to AWS re:Post Private You must be invited to join your organization-speciﬁc private re:Post. Your re:Post Private console administrator creates a private re:Post and invites you and other users to join the private re:Post. Your console administrator sends you an email with information that you need to log in and register in the private re:Post. Access re:Post Private 1 AWS re:Post Private User Guide Browser requirements Sign in to the custom subdomain in your invite to open your private re:Post application. Use one of the latest three versions of the following supported web browsers: • Google Chrome • Mozilla Firefox • Microsoft Edge • Apple Safari for macOS Browser requirements 2 AWS re:Post Private User Guide Sign in to your private re:Post To sign in to your private re:Post for the ﬁrst time, open the email from your re:Post Private console administrator. Then, choose the link that's provided in the email to sign in to the private re:Post. You must use your AWS IAM Identity Center or AWS Active Directory credentials to sign in to re:Post Private. You might need to take additional steps to allow your browser to support single sign-on. For more information, see Single sign-on for IE and Chrome and Single sign-on for Firefox in the AWS Directory Service Administration Guide. 3 AWS re:Post Private User Guide Complete your proﬁle When you sign in to your private re:Post for the ﬁrst time, you must complete your proﬁle. Follow these steps to complete your proﬁle: 1. For Screen name, enter a display name. This name is displayed on all your posts. 2. For Email for notiﬁcations, enter your email address. 3. (Optional) For First name and Last name, enter your ﬁrst name and last name. 4. For Interface and notiﬁcations language, select a language. 5. For Content language, select additional language options for your content on re:Post Private. 6. Choose Complete proﬁle. After you complete your proﬁle, you receive a veriﬁcation email. In this email, choose Verify
space-ug-002	space-ug.pdf	2	private re:Post for the ﬁrst time, you must complete your proﬁle. Follow these steps to complete your proﬁle: 1. For Screen name, enter a display name. This name is displayed on all your posts. 2. For Email for notiﬁcations, enter your email address. 3. (Optional) For First name and Last name, enter your ﬁrst name and last name. 4. For Interface and notiﬁcations language, select a language. 5. For Content language, select additional language options for your content on re:Post Private. 6. Choose Complete proﬁle. After you complete your proﬁle, you receive a veriﬁcation email. In this email, choose Verify E- mail. In your private re:Post, choose Continue to service to start working with your private re:Post. Note To update your proﬁle, choose your user proﬁle, choose Settings, update as needed, and then choose Update your proﬁle. 4 AWS re:Post Private User Guide Work within your private re:Post The topics in this section explain how you can use your private re:Post to browse existing content, ask questions, post answers, and publish articles and selections. Topics • Ask a question in your private re:Post • Get an answer to your question from re:Post Agent • Post an answer to a question in your private re:Post • View a selection in your private re:Post • Publish a selection in your private re:Post • Publish an article in your private re:Post • Search within your private re:Post Ask a question in your private re:Post If you can't ﬁnd the information that you're looking for in your private re:Post, you can ask a question. Follow these steps to ask a question in your private re:Post: 1. From any page in your private re:Post application, choose Post content. Then, choose Ask question. -or- From any page in your private re:Post application, choose Ask question. 2. Review the guidelines for asking questions, and then choose Ask a question. Note You’re asked to review the guidelines only when you post a question for the ﬁrst time. 3. For Question title, enter a title. 4. For Question description, enter a description. Provide as much information as possible. 5. For Your organization-speciﬁc tags, select custom tags that apply to the question. Ask a question 5 AWS re:Post Private User Guide 6. For AWS Tags, select up to ﬁve tags that apply to your question. 7. Choose Post question. You see the list of similar content from your private re:Post that might help solve your problem. You can choose to view any of this content. If you still want to post the question, choose Post your question. Your question is displayed under the Questions tab. The users in your private re:Post can answer your question. All answers for the question are displayed under the question. To accept an answer, choose Accept Answer. Get an answer to your question from re:Post Agent When you wait for the other users in your private re:Post to answer your question, re:Post Agent reviews the question and provides an answer. re:Post Agent is an AI-powered persona that provides the ﬁrst response to your questions within a few seconds. Note The AWS generative AI capabilities generate the answer. However, you are responsible for evaluating the recommendation in your speciﬁc context and implementing appropriate oversight and safeguards. For more information, see AWS Responsible AI Policy. Note re:Post Agent might not generate an answer under the following conditions: • Your question is related to security or compliance. • Your question doesn't adhere to the community guidelines. • re:Post Agent doesn't have enough information to answer the question. If the answer that re:Post Agent provided is accurate, you can choose Accept Answer. The answer that re:Post Agent generated is displayed under the question. The following is an example of a re:Post Agent response to a question: Get an answer from re:Post Agent 6 AWS re:Post Private User Guide Important re:Post Agent isn't available in Asia Paciﬁc (Singapore) and Europe (Ireland) Regions yet. Post an answer to a question in your private re:Post You can answer a question that's posted in your private re:Post in AWS re:Post Private. Follow these steps to post an answer to a question in your private re:Post: 1. On your private re:Post application home page, choose Questions. Post an answer 7 AWS re:Post Private User Guide 2. From the list of questions, choose the question that you want to post an answer for. 3. Under Add your answer, enter your answer. 4. Choose Post answer. The answer that you added is now displayed under the question. View a selection in your private re:Post A selection is a learning path or a curated set of content assets that are relevant to a use case, technology domain, industry, or speciﬁc problem area. It's a collection of knowledge assets speciﬁc to your organization's cloud use case within AWS
space-ug-003	space-ug.pdf	3	choose Questions. Post an answer 7 AWS re:Post Private User Guide 2. From the list of questions, choose the question that you want to post an answer for. 3. Under Add your answer, enter your answer. 4. Choose Post answer. The answer that you added is now displayed under the question. View a selection in your private re:Post A selection is a learning path or a curated set of content assets that are relevant to a use case, technology domain, industry, or speciﬁc problem area. It's a collection of knowledge assets speciﬁc to your organization's cloud use case within AWS services and contains high-quality content from AWS sources, such as AWS re:Post, Knowledge Center, AWS Blogs, and AWS Documentation. You can view all the selections that are published in your private re:Post by AWS. Follow these steps to view a selection in your private re:Post: 1. From any page in your private re:Post application, choose the Selections tab. 2. From the list of selections, choose the selection that you want to view. Publish a selection in your private re:Post Follow these steps to publish a selection in your private re:Post: 1. From any page in your private re:Post application, choose Post content. Then, choose Create selection. -or- From any page in your private re:Post application, choose Create selection. 2. On the Create a draft page, for Selection title, enter a title. 3. For Selection description, enter a description. 4. For Short description, enter a meta title. In this ﬁeld, include a few words to brieﬂy describe the selection to improve search engine optimization. 5. For Your organization-speciﬁc tags, select custom tags that apply to the selection. View a selection 8 AWS re:Post Private User Guide 6. For AWS Tags, select up to ﬁve tags that apply to the selection. 7. For Title image, upload a cover image that describes the selection. The maximum size for the title image 2 MiB. The supported ﬁle types are jpg, .peg, and .png. 8. In the Content section, for Title, enter a title for your ﬁrst section. 9. For Description, enter a description for your section. 10.For each resource that you want to add to the selection, choose Add link. 11.Complete the following steps for each link that you add: For Add a link, enter the link for the resource. The Title ﬁeld is auto populated. (Optional) For Description, enter a short description. (Optional) For Add image, upload a cover image that describes the resource. The maximum size of the cover image is 2 MiB. The supported ﬁle types are .jpg, .peg, and .png. 12.(Optional) Choose Add body to include text and in-line images for the section. 13.To add another section, choose Add another section. Repeat steps 7 to 11. 14.Choose Create draft. 15.To edit your selection draft, choose Edit. 16.Choose Publish. Your selection is published under the Selections tab. Publish an article in your private re:Post Follow these steps to publish an article in your private re:Post: 1. From any page in your private re:Post application, choose Post content. Then, choose Publish article. -or- From any page in your private re:Post application, choose Publish article. 2. For Article title, enter a title. 3. For Context and purpose, enter a short description. 4. For Article body, enter your content. 5. For Your organization-speciﬁc tags, select custom tags that apply to the article. Publish an article 9 AWS re:Post Private User Guide 6. For AWS Tags, select all tags that apply to the article. 7. For Content level, select the content level that applies to your article. 8. Choose Publish article. The article that you published is now displayed under the Articles tab. The users in your private re:Post can view, upvote, and downvote your article. They can also add comments to your article that are displayed in the Comments on this article section. Search within your private re:Post The search box in the navigation bar is a uniﬁed search tool to ﬁnd information across AWS re:Post Private. Enter a few characters to see aggregated results from your private re:Post and AWS re:Post that match your query in a preview window. Search results are sorted by relevance and listed across categories, including Questions, Knowledge Center, Articles, Selections, Tags, and Topics. When you enter more characters, the search results are more deﬁned. Follow these steps to search for information in your private re:Post: 1. In the search box of your re:Post Private web application, enter all or part of your search terms. 2. Choose a speciﬁc search result from the preview window. 3. To view the complete search results page that defaults to the All content view, press Enter after you enter all or part of your search terms. Note View aggregated knowledge from your private re:Post in the re:Post Private results tab and aggregated knowledge
space-ug-004	space-ug.pdf	4	Articles, Selections, Tags, and Topics. When you enter more characters, the search results are more deﬁned. Follow these steps to search for information in your private re:Post: 1. In the search box of your re:Post Private web application, enter all or part of your search terms. 2. Choose a speciﬁc search result from the preview window. 3. To view the complete search results page that defaults to the All content view, press Enter after you enter all or part of your search terms. Note View aggregated knowledge from your private re:Post in the re:Post Private results tab and aggregated knowledge from AWS re:Post in the AWS re:Post results tab. 4. (Optional) On the Search Results page, select an option from the dropdown list to change the sort order by preference. Note By default, the search results are sorted by relevance. 5. On the Search Results page, do the following to further ﬁlter the search results: Search within your private re:Post 10 AWS re:Post Private User Guide For Filter content, enter search terms to reﬁne the results based on keywords. For Select up to 5 tags to ﬁlter, select the tags that you want to ﬁlter the results to. (Optional) For additional ﬁltering, choose the re:Post Private results tab or AWS re:Post results tab and use the ﬁlter for tags. Note Search results display results that contain any or all of the selected tags. 6. For example, if you choose the Questions tab to ﬁlter the search results by questions, then you can choose one of the available options for Filter questions to further narrow down your results. Create a discussion in your private re:Post You can start a private discussion on any of the search results from AWS re:Post within your private re:Post. You can start a discussion on a question, Knowledge Center article, or an article from a search result on the AWS re:Post content tab. Follow these steps to start a private discussion on a search result from AWS re:Post: 1. In the search results view, choose the AWS re:Post results tab. 2. Choose the search result that you want to create a discussion for. 3. Choose Start discussion in your private re:Post. 4. On the Ask a question page, enter the following information: For Question title, enter a title for your discussion. Under Question description, the link to the content is already included. You can enter more information as needed. For Tags, select up to ﬁve tags that apply to the discussion. Note If your organization allows custom tags, then for Custom tags, select your organization's custom tags that apply to the discussion. Create a discussion 11 AWS re:Post Private 5. Choose Post question. User Guide Your discussion is added to your private re:Post under the Questions tab. Create a discussion 12 AWS re:Post Private User Guide Convert your question to an Support case If you're a Support requester, then you can create a case to Support from a question that you posted in your private re:Post. Note Reach out to your re:Post Private administrator to get the Support requester permission. Note You can't edit a question after you convert it to an Support case. You can create a case from your question only if both of these conditions are true: • You posted the question at least 12 hours earlier. • Your question doesn't have an accepted answer. Follow these steps to create a support case from your question in your private re:Post: 1. From any page in your private re:Post application, choose the Questions tab. 2. Choose the question that you want to create a Support case for. 3. Choose Create support case. 4. Review the warning message. Then, take one of the following actions: If you don’t want to continue to create the case, then choose Cancel. If you want to continue to create the case, then choose Conﬁrm and complete the rest of these steps. 5. The ﬁelds Title, Summary, Comments and answers, and Tags and topics are populated with information from your question. You can choose to edit these ﬁelds and remove any conﬁdential and personal details. 6. Choose Create support case. Responses from Support are displayed under the question in the Support case tab. 13 AWS re:Post Private User Guide 7. After you receive a response from Support, enter your reply in the Reply to AWS Support section. Then, choose Send reply to AWS Support. Note The responses from Support and your replies are visible only to you. 8. To close the thread after your issue is resolved, choose Resolve thread. 9. Review the Publish support response message about publishing the support ticket correspondence. Then, choose either Resolve without publishing or Resolve and Publish. If you choose to resolve and publish, the case is resolved and support correspondence is published on
space-ug-005	space-ug.pdf	5	Support case tab. 13 AWS re:Post Private User Guide 7. After you receive a response from Support, enter your reply in the Reply to AWS Support section. Then, choose Send reply to AWS Support. Note The responses from Support and your replies are visible only to you. 8. To close the thread after your issue is resolved, choose Resolve thread. 9. Review the Publish support response message about publishing the support ticket correspondence. Then, choose either Resolve without publishing or Resolve and Publish. If you choose to resolve and publish, the case is resolved and support correspondence is published on the thread. If you choose to resolve without publishing, the case is resolved and support correspondence isn't published. However, you can choose Publish support correspondence at a later time to publish case communication on the thread. 10.If Support resolves the case and you want to publish the support ticket correspondence, then choose Publish support correspondence under the Support case tab. 14 AWS re:Post Private User Guide Sign out of AWS re:Post Private You can sign out of your private re:Post at any time. To sign back in, use your IAM Identity Center credentials. You can sign out of your private re:Post in one of the following ways: • In your private re:Post web application, choose your proﬁle, and then choose Sign out. You're then signed out of your private re:Post. • Sign out from the IAM Identity Center console. When you sign out, your re:Post Private session might continue for up to two hours after the IAM Identity Center session expires. During this time, you'll still be signed in to your private re:Post application. When your session times out, you're automatically signed out from your private re:Post. For more information, see Authentication in the AWS IAM Identity Center User Guide. 15 AWS re:Post Private User Guide Document history for the re:Post Private User Guide The following table describes the documentation releases for AWS re:Post Private: Change Update Guide structure review and improvements Description Date October 22, 2024 September 24, 2024 Added information on getting an answer from re:Post Agent for a question that a user posts The structure of the guide was reviewed and improveme nts were made to improve the customer experience related to ﬁnding information for speciﬁc scenarios. Initial release Initial release of the re:Post Private User Guide November 26, 2023 16
speke-001	speke.pdf	1	Partner and customer guide Secure Packager and Encoder Key Exchange API Speciﬁcation Copyright © 2021 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Secure Packager and Encoder Key Exchange API Speciﬁcation: Partner and customer guide Copyright © 2021 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Table of Contents What is Secure Packager and Encoder Key Exchange? .................................................................. 1 General architecture ..................................................................................................................................... 1 AWS cloud-based architecture ................................................................................................................... 2 How to get started ...................................................................................................................................... 3 Are you new to SPEKE? ................................................................................................................... 4 Related service information and speciﬁcations ..................................................................................... 4 Terminology ................................................................................................................................................... 4 Customer onboarding ...................................................................................................................... 6 Get started with a DRM platform provider ............................................................................................. 6 SPEKE support in AWS services and products ....................................................................................... 7 SPEKE support in AWS Partner services and products ......................................................................... 8 SPEKE API speciﬁcation .................................................................................................................. 9 Authentication required for SPEKE ........................................................................................................ 10 Authentication for AWS cloud implementations ............................................................................ 10 Authentication for on-premises products ........................................................................................ 11 SPEKE API v1 .............................................................................................................................................. 12 SPEKE API v1 - Customizations and constraints to the DASH-IF speciﬁcation ......................... 13 SPEKE API v1 - Standard payload components ............................................................................. 14 SPEKE API v1 - Live workﬂow method call examples ................................................................... 16 SPEKE API v1 - VOD workﬂow method call examples .................................................................. 21 SPEKE API v1 - Content key encryption .......................................................................................... 24 SPEKE API v1 - Heartbeat .................................................................................................................. 28 SPEKE API v1 - Overriding the key identiﬁer ................................................................................. 28 SPEKE API v2 .............................................................................................................................................. 30 SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation ......................... 31 SPEKE API v2 - Standard payload components ............................................................................. 35 SPEKE API v2 - Encryption contract ................................................................................................. 40 SPEKE API v2 - Live workﬂow method call examples ................................................................... 49 SPEKE API v2 - VOD workﬂow method call examples .................................................................. 55 SPEKE API v2 - Content key encryption .......................................................................................... 60 SPEKE API v2 - Overriding the key identiﬁer ................................................................................. 64 License for the SPEKE API speciﬁcation ................................................................................................ 66 Creative Commons Attribution-ShareAlike 4.0 International Public License ............................ 66 Document history .......................................................................................................................... 73 iii Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide What is Secure Packager and Encoder Key Exchange? Secure Packager and Encoder Key Exchange (SPEKE) deﬁnes the standard for communication between encryptors and packagers of media content and digital rights management (DRM) key providers. The speciﬁcation accommodates encryptors running on premises and in the AWS Cloud. Topics • General architecture • AWS cloud-based architecture • How to get started General architecture The following illustration shows a high-level view of the SPEKE content encryption architecture for on-premises products. These are the main components of the preceding architecture: • Encryptor – Provides the encryption technology. Receives encryption requests from its operator, and retrieves the required keys from the DRM key provider to secure the encrypted content. • DRM platform key provider – Provides encryption keys to the encryptor through a SPEKE- compliant API. The provider also provides licenses to media players for decryption. • Player – Requests keys from the same DRM platform key provider, which the player uses to unlock the content and serve it to its viewers. General architecture 1 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide AWS cloud-based architecture The following illustration shows the high-level architecture when SPEKE is used with services and features running in the AWS Cloud. These are the main services and components: • Encryptor – Provides the encryption technology in the AWS Cloud. The encryptor receives requests from its operator and retrieves the required encryption keys from the DRM key provider, through Amazon API Gateway, to secure the encrypted content. It delivers the encrypted content to an Amazon S3 bucket or through an Amazon CloudFront distribution. • AWS IAM and Amazon API Gateway – Manages customer-trusted roles and proxy communication between the encryptor and the key provider. API Gateway provides logging capabilities and lets customers control their relationships with the encryptor and with the DRM platform. Customers enable key provider access through IAM role conﬁguration. API Gateway must reside in the same AWS Region as the encryptor. • AWS Certiﬁcate Manager – (Optional) Provides certiﬁcate management for content key encryption. Encrypting content keys is the recommended practice for secure communication. The certiﬁcate manager must reside in the same AWS Region as the encryptor. • DRM platform key provider – Provides encryption keys
speke-002	speke.pdf	2	Gateway – Manages customer-trusted roles and proxy communication between the encryptor and the key provider. API Gateway provides logging capabilities and lets customers control their relationships with the encryptor and with the DRM platform. Customers enable key provider access through IAM role conﬁguration. API Gateway must reside in the same AWS Region as the encryptor. • AWS Certiﬁcate Manager – (Optional) Provides certiﬁcate management for content key encryption. Encrypting content keys is the recommended practice for secure communication. The certiﬁcate manager must reside in the same AWS Region as the encryptor. • DRM platform key provider – Provides encryption keys to the encryptor through a SPEKE- compliant API. The provider also provides licenses to media players for decryption. • Player – Requests keys from the same DRM platform key provider, which the player uses to unlock the content and serve it to its viewers. AWS cloud-based architecture 2 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide How to get started For additional introductory material about SPEKE, see Are you new to SPEKE?. Are you a customer? Partner with an AWS Elemental DRM platform provider to get set up to use encryption. For details, see Customer onboarding. Are you a DRM platform provider or a customer with your own key provider? Expose a REST API for your key provider in compliance with the SPEKE speciﬁcation. For details, see SPEKE API speciﬁcation. How to get started 3 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Are you new to SPEKE? This section provides introductory information for readers who are new to Secure Packager and Encoder Key Exchange (SPEKE). For an introduction to SPEKE, watch the following webcast: Related service information and speciﬁcations • API gateway permissions – How to control access to an API with AWS Identity and Access Management (AWS IAM) permissions. • AWS AssumeRole – How to use AWS Security Token Service (AWS STS) to assume role functionality. • AWS Sigv4 – How to sign an HTTP request using Signature Version 4. • DASH-IF CPIX speciﬁcation v2.0 – The DASH-IF Content Protection Information Exchange Format (CPIX) speciﬁcation version, which this SPEKE v1.0 speciﬁcation is based on. • DASH-IF CPIX speciﬁcation v2.3 – The DASH-IF Content Protection Information Exchange Format (CPIX) speciﬁcation version, which this SPEKE v2.0 speciﬁcation is based on. • DASH-IF system IDs – The list of registered identiﬁers for DRM systems. • https://github.com/awslabs/speke-reference-server – Example reference key provider to use with your AWS account, to help you get started with a SPEKE implementation in AWS. Terminology The following list deﬁnes the terminology used in this speciﬁcation. Where possible, this speciﬁcation follows the terminology used in the DASH-IF CPIX speciﬁcation. • ARN – Amazon Resource Name. Uniquely identiﬁes an AWS resource. • Content key – A cryptographic key used for encrypting part of the content. • Content provider – A publisher who provides the rights and rules for delivering protected media. The content provider might also provide source media (mezzanine format, for transcoding), asset identiﬁers, key identiﬁers (KIDs), key values, encoding instructions, and content description metadata. Related service information and speciﬁcations 4 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide • DRM – Digital rights management. Used to protect copyrighted digital content from unapproved access. • DRM platform – A system that provides DRM functionality and support to content encryptors and viewers, including providing DRM keys and licensing for content encryption and decryption. • DRM provider – See DRM platform. • DRM system – A standard for DRM implementations. Common DRM systems include Apple FairPlay, Google Widevine, and Microsoft PlayReady. DRM systems are used by content providers to secure digital content for delivery to viewers and for access by viewers. For a list of DRM systems that are registered with DASH-IF, see DASH-IF system IDs. The DASH-IF CPIX speciﬁcation uses the term "DRM system" as deﬁned here and, in some places, it uses "DRM system" to mean what this speciﬁcation refers to as a DRM platform. • DRM solution – See DRM platform. • DRM technology – See DRM system. • Encryptor – A media processing component that encrypts media content using keys obtained from the key provider. Encryptors typically also add DRM encryption signaling and metadata to the media.. Encryptors are usually encoders, packagers, and transcoders. • Key provider – The component of a DRM platform that exposes a SPEKE REST API to handle key requests. The key provider might be the key server itself, or it might be another component of the platform. • Key server – The component of a DRM platform that maintains keys for content encryption and decryption. • Operator – A person in charge of operating the overall system, including the encryptor and the key provider. • Player – A media
speke-003	speke.pdf	3	provider. Encryptors typically also add DRM encryption signaling and metadata to the media.. Encryptors are usually encoders, packagers, and transcoders. • Key provider – The component of a DRM platform that exposes a SPEKE REST API to handle key requests. The key provider might be the key server itself, or it might be another component of the platform. • Key server – The component of a DRM platform that maintains keys for content encryption and decryption. • Operator – A person in charge of operating the overall system, including the encryptor and the key provider. • Player – A media player operating on behalf of a viewer. Gets its information from diﬀerent sources, including the media manifest ﬁles, media ﬁles, and DRM licenses. Requests licenses from the DRM platform on behalf of the viewers. Terminology 5 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Customer onboarding for SPEKE Protect your content from unauthorized use by combining a Secure Packager and Encoder Key Exchange (SPEKE) digital rights management (DRM) key provider with your encryptor and with your media players. SPEKE deﬁnes the standard for communication between encryptors and packagers of media content and digital rights management (DRM) key providers. To onboard, you choose a DRM platform key provider and conﬁgure the communication between the key provider and your encryptors and players. Topics • Get started with a DRM platform provider • SPEKE support in AWS services and products • SPEKE support in AWS Partner services and products Get started with a DRM platform provider The following Amazon partners provide third-party DRM platform implementations for SPEKE. For details about their oﬀerings and information about how to contact them, follow the links to their Amazon Partner Network pages. Partners that don’t have a link don’t currently have an Amazon Partner Network page, but you can contact them directly. The partners can help you get set up to use their platforms. DRM platform provider SPEKE v1 support SPEKE v2 support Axinom BuyDRM castLabs EZDRM Inisoft DOVERUNNER Insys Cloud DRM √ √ √ √ √ √ √ √ √ √ √ √ √ √ Get started with a DRM platform provider 6 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide DRM platform provider SPEKE v1 support SPEKE v2 support Intertrust Technologies Irdeto JW Player Kaltura NAGRA NEXTSCAPE, Inc. SeaChange Verimatrix Viaccess-Orca WebStream √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ SPEKE support in AWS services and products This section lists the SPEKE support that is provided by AWS Media Services that run in the AWS Cloud and by AWS on-premises media products. These services and products are the encryptors in the SPEKE content encryption architecture. Verify that your streaming protocol and the DRM system that you want are available for your service or product. AWS service or product SPEKE v1 support SPEKE v2 support AWS Elemental MediaConvert - Service that runs in the AWS Cloud AWS Elemental MediaPackage - √ √ √ √ Supported DRM technologies Documentation Documentation SPEKE support in AWS services and products 7 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide AWS service or product Service that runs in the AWS Cloud AWS Elemental Live - On-premises product AWS Elemental Server - On-premis es product SPEKE v1 support SPEKE v2 support Supported DRM technologies √ √ Documentation: MPEG-DASH / HLS Documentation SPEKE support in AWS Partner services and products This section lists the SPEKE support that is provided by AWS Partner services and products that run in the AWS Cloud. These services and products are the encryptors in the SPEKE content encryption architecture. Verify that your streaming protocol and the DRM system that you want are available for your service or product. AWS service or product SPEKE v1 support SPEKE v2 support Bitmovin Live Video Encoding Bitmovin Video on demand (VOD) Encoding √ √ Supported DRM technologies Documentation Documentation SPEKE support in AWS Partner services and products 8 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide SPEKE API speciﬁcation This is the REST API speciﬁcation for Secure Packager and Encoder Key Exchange (SPEKE). Use this speciﬁcation to provide DRM copyright protection for customers who use encryption. In a video streaming workﬂow, the encryption engine communicates with the DRM platform key provider to request content keys. These keys are highly sensitive, so it is critical that the key provider and encryption engine establish a highly secure, trusted communication channel. You can also encrypt the content keys in the document for more secure, end-to-end encryption. This speciﬁcation addresses the following goals: • Deﬁne a simple, trusted, highly secure interface that DRM vendors and customers can use to integrate with encryptors when content encryption is required. • Cover VOD and
speke-004	speke.pdf	4	provide DRM copyright protection for customers who use encryption. In a video streaming workﬂow, the encryption engine communicates with the DRM platform key provider to request content keys. These keys are highly sensitive, so it is critical that the key provider and encryption engine establish a highly secure, trusted communication channel. You can also encrypt the content keys in the document for more secure, end-to-end encryption. This speciﬁcation addresses the following goals: • Deﬁne a simple, trusted, highly secure interface that DRM vendors and customers can use to integrate with encryptors when content encryption is required. • Cover VOD and live workﬂows, and include the error conditions and the authentication mechanisms that are required for robust, highly secure communication between encryptors and DRM key provider endpoints. • Include support for HLS, MSS, and DASH packaging and their common DRM systems: FairPlay, PlayReady, and Widevine/CENC. • Keep the speciﬁcation simple and extensible, to support future DRM systems. • Use a simple REST API. Note Copyright 2021, Amazon Web Services, Inc. or its aﬃliates. All rights reserved. The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. THE MATERIAL CONTAINED HEREIN IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS OF THIS MATERIAL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THIS MATERIAL OR THE USE OR OTHER DEALINGS OF THIS MATERIAL. 9 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Topics • Authentication required for SPEKE • SPEKE API v1 • SPEKE API v2 • License for the SPEKE API speciﬁcation Authentication required for SPEKE SPEKE requires authentication for on-premises products and for services and features that run in the AWS Cloud. Topics • Authentication for AWS cloud implementations • Authentication for on-premises products Authentication for AWS cloud implementations SPEKE requires AWS authentication through IAM roles for use with an encryptor. IAM roles are created by the DRM provider or by the operator who owns the DRM endpoint in an AWS account. Each role is assigned an Amazon Resource Name (ARN), which the AWS Elemental service operator provides on the service console when requesting encryption. The role’s policy permissions must be conﬁgured to give permission to access the key provider API and no other AWS resource access. When the encryptor contacts the DRM key provider, it uses the role ARN to assume the role of the key provider account holder, which returns temporary credentials for the encryptor to use to access the key provider. One common implementation is for the operator or DRM platform vendor to use Amazon API Gateway in front of the key provider, and then enable AWS Identity and Access Management (AWS IAM) authorization on the API Gateway resource. You can use the following policy deﬁnition example and attach it to a new role to give permissions to the appropriate resource. In this case, the permissions are for all API Gateway resources: { "Version": "2012-10-17", "Statement": [ Authentication required for SPEKE 10 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide { "Effect": "Allow", "Action": [ "execute-api:Invoke" ], "Resource": [ "arn:aws:execute-api:us-west-2:://GET/" ] } ] } Finally, the role requires the addition of a trust relationship, and the operator must be able to select the service. The following example shows a role ARN that is created for accessing the DRM key provider: arn:aws:iam::2949266363526:role/DRMKeyServer For more information about the creation of a role, see AWS AssumeRole. For more information about signing a request, see AWS Sigv4. Authentication for on-premises products For on-premises products, we recommend that you use SSL/TLS and digest authentication for the best security, but at a minimum you should use basic authentication over HTTPS. Both types of authentication use the Authorization header in the HTTP request: • Digest authentication – The authorization header consists of the identiﬁer Digest followed by a series of values that authenticate the request. Speciﬁcally, a response value is generated through a series of MD5 hash functions that include a unique, one-time-use nonce from the server that is used to ensure that the password travels securely. • Basic authentication – The authorization header consists of the identiﬁer Basic followed by a base-64 encoded string that represents the user name and password, separated by a colon. For information about basic and digest authentication, including detailed information about the header, see the Internet Engineering Task Force (IETF) speciﬁcation RFC 2617 - HTTP Authentication: Basic and Digest Access Authentication. Authentication for on-premises products 11 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide SPEKE API v1 This
speke-005	speke.pdf	5	that include a unique, one-time-use nonce from the server that is used to ensure that the password travels securely. • Basic authentication – The authorization header consists of the identiﬁer Basic followed by a base-64 encoded string that represents the user name and password, separated by a colon. For information about basic and digest authentication, including detailed information about the header, see the Internet Engineering Task Force (IETF) speciﬁcation RFC 2617 - HTTP Authentication: Basic and Digest Access Authentication. Authentication for on-premises products 11 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide SPEKE API v1 This is the REST API for Secure Packager and Encoder Key Exchange (SPEKE) v1. Use this speciﬁcation to provide DRM copyright protection for customers who use encryption. To be SPEKE- compliant, your DRM key provider must expose the REST API described in this speciﬁcation. The encryptor makes API calls to your key provider. Note The code examples in this speciﬁcation are for illustration purposes only. You can’t run the examples because they aren’t part of a complete SPEKE implementation. SPEKE uses the DASH Industry Forum Content Protection Information Exchange Format (DASH- IF-CPIX) data structure deﬁnition for key exchange, with some restrictions. DASH-IF-CPIX deﬁnes a schema to provide an extensible, multi-DRM exchange from the DRM platform to the encryptor. This enables content encryption for all adaptive bitrate packaging formats at the time of content compression and packaging. Adaptive bitrate packaging formats include HLS, DASH, and MSS. For detailed information about the exchange format, see the DASH Industry Forum CPIX speciﬁcation at https://dashif.org/docs/DASH-IF-CPIX-v2-0.pdf. Topics • SPEKE API v1 - Customizations and constraints to the DASH-IF speciﬁcation • SPEKE API v1 - Standard payload components • SPEKE API v1 - Live workﬂow method call examples • SPEKE API v1 - VOD workﬂow method call examples • SPEKE API v1 - Content key encryption • SPEKE API v1 - Heartbeat • SPEKE API v1 - Overriding the key identiﬁer SPEKE API v1 12 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide SPEKE API v1 - Customizations and constraints to the DASH-IF speciﬁcation The DASH-IF CPIX speciﬁcation, https://dashif.org/docs/DASH-IF-CPIX-v2-0.pdf, supports a number of use cases and topologies. The SPEKE API speciﬁcation adheres to the CPIX speciﬁcation with the following customizations and constraints: • SPEKE follows the Encryptor Consumer workﬂow. • For encrypted content keys, SPEKE applies the following restrictions: • SPEKE doesn’t support digital signature veriﬁcation (XMLDSIG) for request or response payloads. • SPEKE requires 2048 RSA-based certiﬁcates. • For rotating key workﬂows, SPEKE requires the ContentKeyUsageRule ﬁlter, KeyPeriodFilter. SPEKE ignores all other ContentKeyUsageRule settings. • SPEKE omits the UpdateHistoryItemList functionality. If the list is present in the response, SPEKE ignores it. • SPEKE supports key rotation. SPEKE uses only the `ContentKeyPeriod@index to track the key period. • To support MSS PlayReady, SPEKE uses a custom parameter under the DRMSystem tag, SPEKE:ProtectionHeader. • For HLS packaging, if the URIExtXKey is present in the response, then it must contain the full data to add in the URI parameter of the EXT-X-KEY tag of an HLS playlist, with no further signaling requirement. • For HLS playlist, under the DRMSystem tag, SPEKE provides the optional custom parameters speke:KeyFormat and speke:KeyFormatVersions, for the values of the KEYFORMAT and KEYFORMATVERSIONS parameters of the EXT-X-KEY tag. The HLS initialization vector (IV) always follows segment number unless explicitly speciﬁed by the operator. • When requesting keys, the encryptor might use the optional @explicitIV attribute on the ContentKey element. The key provider can respond with an IV using @explicitIV, even if the attribute is not included in the request. • The encryptor creates the key identiﬁer (KID), which stays the same for any given content ID and key period. The key provider includes the KID in its response to the request document. SPEKE API v1 - Customizations and constraints to the DASH-IF speciﬁcation 13 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide • The key provider might include a value for the Speke-User-Agent response header, to identify itself for debugging purposes. • SPEKE does not currently support multiple tracks or keys per content. The SPEKE-compliant encryptor acts as a client and sends POST operations to the key provider endpoint. The encryptor might send a periodic heartbeat request to ensure that the connection between the encryptor and the key provider endpoint is healthy. SPEKE API v1 - Standard payload components In any SPEKE request, the encryptor can request responses for one or more DRM systems. The encryptor speciﬁes the DRM systems in <cpix:DRMSystemList> of the request payload. Each system speciﬁcation includes the key and indicates the type of response to return. The following example shows a DRM system list with a single DRM system speciﬁcation: The following table lists the main components of each <cpix:DRMSystem>. Identiﬁer Description systemId
speke-006	speke.pdf	6	provider endpoint. The encryptor might send a periodic heartbeat request to ensure that the connection between the encryptor and the key provider endpoint is healthy. SPEKE API v1 - Standard payload components In any SPEKE request, the encryptor can request responses for one or more DRM systems. The encryptor speciﬁes the DRM systems in <cpix:DRMSystemList> of the request payload. Each system speciﬁcation includes the key and indicates the type of response to return. The following example shows a DRM system list with a single DRM system speciﬁcation: The following table lists the main components of each <cpix:DRMSystem>. Identiﬁer Description systemId or schemeId kid Unique identiﬁer for the DRM system type, as registered with the DASH IF organization. For a list, see DASH-IF System IDs. The key ID. This is not the actual key, but an identiﬁer that points to the key in a hash table. SPEKE API v1 - Standard payload components 14 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Identiﬁer Description <cpix:UriExtXKey> <cpix:PSSH> Requests a standard unencrypted key. The key response type must be either this or the PSSH response. Requests a Protection System Speciﬁc Header (PSSH). This type of header contains a reference to the kid, the systemID, plus custom data for the DRM vendor, as part of Common Encryption (CENC). The key response type must be either this or the UriExtXKey response. _Example Requests for Standard Key and for PSSH _ The following example shows part of a sample request from the encryptor to the DRM key provider, with the main components highlighted. The ﬁrst request is for a standard key, while the second request is for a PSSH response: _Example Responses for Standard Key and for PSSH _ SPEKE API v1 - Standard payload components 15 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide The following example shows the corresponding response from the DRM key provider to the encryptor: SPEKE API v1 - Live workﬂow method call examples Request Syntax Example The following URL is an example and does not indicate a ﬁxed format: POST https://speke-compatible-server/speke/v1.0/copyProtection Request Body A CPIX element. Request Headers SPEKE API v1 - Live workﬂow method call examples 16 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Name Type Occurs Description AWS Authoriza String tion X-Amz-Security- String Token X-Amz-Date Content-Type Response Headers Name Speke-User- Agent String String Type String Content-Type String Request Response 1..1 1..1 1..1 1..1 See AWS Sigv4 See AWS Sigv4 See AWS Sigv4 application/xml Occurs Description 1..1 1..1 String that identiﬁes the key provider application/xml HTTP CODE Payload Name Occurs Description 200 (Success) CPIX 1..1 4XX (Client Client error message 1..1 error) 5XX (Server Server error message 1..1 error) DASH-CPIX payload response Description of the client error Description of the server error SPEKE API v1 - Live workﬂow method call examples 17 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Note The examples in this section do not include content key encryption. For information about how to add content key encryption, see Content key encryption. Live Example Request Payload with Keys in the Clear The following example shows a typical live request payload from the encryptor to the DRM key provider: <cpix:CPIX id="abc123" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke"> <cpix:ContentKeyList> <cpix:ContentKey kid="98ee5596-cd3e-a20d-163a-e382420c6eff" explicitIV="OFj2IjCsPJFfMAxmQxLGPw=="></cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- HLS AES-128 (systemId is implementation specific)--> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="81376844- f976-481e-a84e-cc25d39b0b33"> <cpix:URIExtXKey></cpix:URIExtXKey> <speke:KeyFormat></speke:KeyFormat> <speke:KeyFormatVersions></speke:KeyFormatVersions> </cpix:DRMSystem> <!-- HLS SAMPLE-AES --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:URIExtXKey></cpix:URIExtXKey> <speke:KeyFormat></speke:KeyFormat> <speke:KeyFormatVersions></speke:KeyFormatVersions> </cpix:DRMSystem> <!-- Common encryption (Widevine)--> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> <!-- Common encryption / MSS (Playready) --> SPEKE API v1 - Live workﬂow method call examples 18 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <speke:ProtectionHeader></speke:ProtectionHeader> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> Live Example Response Payload with Keys in the Clear The following example shows a typical response payload from the DRM key provider: <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke" id="abc123"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- HLS AES-128 (systemId is implementation specific) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="81376844- f976-481e-a84e-cc25d39b0b33"> <cpix:URIExtXKey>aHR0cHM6Ly83azR5dHV4cTVkLmV4ZWN1dGUtYXBpLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tL0VrZVN0YWdlL2NsaWVudC9hYmMxMjMvOThlZTU1OTYtY2QzZS1hMjBkLTE2M2EtZTM4MjQyMGM2ZWZm</ cpix:URIExtXKey> <speke:KeyFormat>aWRlbnRpdHk=</speke:KeyFormat> <speke:KeyFormatVersions>MQ==</speke:KeyFormatVersions> </cpix:DRMSystem> SPEKE API v1 - Live workﬂow method call examples 19 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <!-- HLS SAMPLE-AES --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:URIExtXKey>aHR0cHM6Ly83azR5dHV4cTVkLmV4ZWN1dGUtYXBpLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tL0VrZVN0YWdlL2NsaWVudC9hYmMxMjMvOThlZTU1OTYtY2QzZS1hMjBkLTE2M2EtZTM4MjQyMGM2ZWZm</ cpix:URIExtXKey> <speke:KeyFormat>Y29tLmFwcGxlLnN0cmVhbWluZ2tleWRlbGl2ZXJ5</speke:KeyFormat> <speke:KeyFormatVersions>MQ==</speke:KeyFormatVersions> </cpix:DRMSystem> <!-- Common encryption (Widevine) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH>AAAAanBzc2gAAAAA7e +LqXnWSs6jyCfc1R0h7QAAAEoIARIQeSIcblaNbb7Dji6sAtKZzRoNd2lkZXZpbmVfdGVzdCIfa2V5LWlkOmVTSWNibGFOYmI3RGppNnNBdEtaelE9PSoCU0QyAA==</ cpix:PSSH> </cpix:DRMSystem> <!-- Common encryption / MSS (Playready) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <speke:ProtectionHeader>CgMAAAEAAQAAAzwAVwBSAE0ASABFAEEARABFAFIAIAB4AG0AbABuAHMAPQAiAGgAdAB0AHAAOgAvAC8AcwBjAGgAZQBtAGEAcwAuAG0AaQBjAHIAbwBzAG8AZgB0AC4AYwBvAG0ALwBEAFIATQAvADIAMAAwADcALwAwADMALwBQAGwAYQB5AFIAZQBhAGQAeQBIAGUAYQBkAGUAcgAiACAAdgBlAHIAcwBpAG8AbgA9ACIANAAuADAALgAwAC4AMAAiAD4APABEAEEAVABBAD4APABQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsARQBZAEwARQBOAD4AMQA2ADwALwBLAEUAWQBMAEUATgA +ADwAQQBMAEcASQBEAD4AQQBFAFMAQwBUAFIAPAAvAEEATABHAEkARAA +ADwALwBQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsASQBEAD4ATwBXAGoAaAB0AHIAMwB1ADkAawArAHIAZABvADEASQBMAFkAMAByAGEAdwA9AD0APAAvAEsASQBEAD4APABDAEgARQBDAEsAUwBVAE0APgBCADMAQQA2AEEAMwB4AG0AdABkAEkAPQA8AC8AQwBIAEUAQwBLAFMAVQBNAD4APABMAEEAXwBVAFIATAA +AGgAdAB0AHAAOgAvAC8AcABsAGEAeQByAGUAYQBkAHkALgBkAGkAcgBlAGMAdAB0AGEAcABzAC4AbgBlAHQALwBwAHIALwBzAHYAYwAvAHIAaQBnAGgAdABzAG0AYQBuAGEAZwBlAHIALgBhAHMAbQB4AD8AUABsAGEAeQBSAGkAZwBoAHQAPQAxACYAYQBtAHAAOwBhAG0AcAA7AGEAbQBwADsAVQBzAGUAUwBpAG0AcABsAGUATgBvAG4AUABlAHIAcwBpAHMAdABlAG4AdABMAGkAYwBlAG4AcwBlAD0AMQA8AC8ATABBAF8AVQBSAEwAPgA8AC8ARABBAFQAQQA +ADwALwBXAFIATQBIAEUAQQBEAEUAUgA+AA==</speke:ProtectionHeader> <cpix:PSSH>AAADMHBzc2gAAAAAmgTweZhAQoarkuZb4IhflQAAAxAQAwAAAQABAAYDPABXAFIATQBIAEUAQQBEAEUAUgAgAHgAbQBsAG4AcwA9ACIAaAB0AHQAcAA6AC8ALwBzAGMAaABlAG0AYQBzAC4AbQBpAGMAcgBvAHMAbwBmAHQALgBjAG8AbQAvAEQAUgBNAC8AMgAwADAANwAvADAAMwAvAFAAbABhAHkAUgBlAGEAZAB5AEgAZQBhAGQAZQByACIAIAB2AGUAcgBzAGkAbwBuAD0AIgA0AC4AMAAuADAALgAwACIAPgA8AEQAQQBUAEEAPgA8AFAAUgBPAFQARQBDAFQASQBOAEYATwA +ADwASwBFAFkATABFAE4APgAxADYAPAAvAEsARQBZAEwARQBOAD4APABBAEwARwBJAEQAPgBBAEUAUwBDAFQAUgA8AC8AQQBMAEcASQBEAD4APAAvAFAAUgBPAFQARQBDAFQASQBOAEYATwA +ADwASwBJAEQAPgBiAGgAdwBpAGUAWQAxAFcAdgBtADMARABqAGkANgBzAEEAdABLAFoAegBRAD0APQA8AC8ASwBJAEQAPgA8AEMASABFAEMASwBTAFUATQA +AGEAVABtAFAASgBWAEMAVgBaADYAcwA9ADwALwBDAEgARQBDAEsAUwBVAE0APgA8AEwAQQBfAFUAUgBMAD4AaAB0AHQAcABzADoALwAvAHAAcgBsAHMALgBhAHQAdgAtAHAAcwAuAGEAbQBhAHoAbwBuAC4AYwBvAG0ALwBjAGQAcAA8AC8ATABBAF8AVQBSAEwAPgA8AEMAVQBTAFQATwBNAEEAVABUAFIASQBCAFUAVABFAFMAPgA8AEkASQBTAF8ARABSAE0AXwBWAEUAUgBTAEkATwBOAD4ANwAuADEALgAxADQAMwA5AC4AMAA8AC8ASQBJAFMAXwBEAFIATQBfAFYARQBSAFMASQBPAE4APgA8AC8AQwBVAFMAVABPAE0AQQBUAFQAUgBJAEIAVQBUAEUAUwA +ADwALwBEAEEAVABBAD4APAAvAFcAUgBNAEgARQBBAEQARQBSAD4A</cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" /> </cpix:ContentKeyUsageRule> SPEKE API v1 - Live workﬂow method call examples 20 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:ContentKeyUsageRuleList> </cpix:CPIX> SPEKE API
speke-007	speke.pdf	7	call examples 19 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <!-- HLS SAMPLE-AES --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:URIExtXKey>aHR0cHM6Ly83azR5dHV4cTVkLmV4ZWN1dGUtYXBpLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tL0VrZVN0YWdlL2NsaWVudC9hYmMxMjMvOThlZTU1OTYtY2QzZS1hMjBkLTE2M2EtZTM4MjQyMGM2ZWZm</ cpix:URIExtXKey> <speke:KeyFormat>Y29tLmFwcGxlLnN0cmVhbWluZ2tleWRlbGl2ZXJ5</speke:KeyFormat> <speke:KeyFormatVersions>MQ==</speke:KeyFormatVersions> </cpix:DRMSystem> <!-- Common encryption (Widevine) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH>AAAAanBzc2gAAAAA7e +LqXnWSs6jyCfc1R0h7QAAAEoIARIQeSIcblaNbb7Dji6sAtKZzRoNd2lkZXZpbmVfdGVzdCIfa2V5LWlkOmVTSWNibGFOYmI3RGppNnNBdEtaelE9PSoCU0QyAA==</ cpix:PSSH> </cpix:DRMSystem> <!-- Common encryption / MSS (Playready) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <speke:ProtectionHeader>CgMAAAEAAQAAAzwAVwBSAE0ASABFAEEARABFAFIAIAB4AG0AbABuAHMAPQAiAGgAdAB0AHAAOgAvAC8AcwBjAGgAZQBtAGEAcwAuAG0AaQBjAHIAbwBzAG8AZgB0AC4AYwBvAG0ALwBEAFIATQAvADIAMAAwADcALwAwADMALwBQAGwAYQB5AFIAZQBhAGQAeQBIAGUAYQBkAGUAcgAiACAAdgBlAHIAcwBpAG8AbgA9ACIANAAuADAALgAwAC4AMAAiAD4APABEAEEAVABBAD4APABQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsARQBZAEwARQBOAD4AMQA2ADwALwBLAEUAWQBMAEUATgA +ADwAQQBMAEcASQBEAD4AQQBFAFMAQwBUAFIAPAAvAEEATABHAEkARAA +ADwALwBQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsASQBEAD4ATwBXAGoAaAB0AHIAMwB1ADkAawArAHIAZABvADEASQBMAFkAMAByAGEAdwA9AD0APAAvAEsASQBEAD4APABDAEgARQBDAEsAUwBVAE0APgBCADMAQQA2AEEAMwB4AG0AdABkAEkAPQA8AC8AQwBIAEUAQwBLAFMAVQBNAD4APABMAEEAXwBVAFIATAA +AGgAdAB0AHAAOgAvAC8AcABsAGEAeQByAGUAYQBkAHkALgBkAGkAcgBlAGMAdAB0AGEAcABzAC4AbgBlAHQALwBwAHIALwBzAHYAYwAvAHIAaQBnAGgAdABzAG0AYQBuAGEAZwBlAHIALgBhAHMAbQB4AD8AUABsAGEAeQBSAGkAZwBoAHQAPQAxACYAYQBtAHAAOwBhAG0AcAA7AGEAbQBwADsAVQBzAGUAUwBpAG0AcABsAGUATgBvAG4AUABlAHIAcwBpAHMAdABlAG4AdABMAGkAYwBlAG4AcwBlAD0AMQA8AC8ATABBAF8AVQBSAEwAPgA8AC8ARABBAFQAQQA +ADwALwBXAFIATQBIAEUAQQBEAEUAUgA+AA==</speke:ProtectionHeader> <cpix:PSSH>AAADMHBzc2gAAAAAmgTweZhAQoarkuZb4IhflQAAAxAQAwAAAQABAAYDPABXAFIATQBIAEUAQQBEAEUAUgAgAHgAbQBsAG4AcwA9ACIAaAB0AHQAcAA6AC8ALwBzAGMAaABlAG0AYQBzAC4AbQBpAGMAcgBvAHMAbwBmAHQALgBjAG8AbQAvAEQAUgBNAC8AMgAwADAANwAvADAAMwAvAFAAbABhAHkAUgBlAGEAZAB5AEgAZQBhAGQAZQByACIAIAB2AGUAcgBzAGkAbwBuAD0AIgA0AC4AMAAuADAALgAwACIAPgA8AEQAQQBUAEEAPgA8AFAAUgBPAFQARQBDAFQASQBOAEYATwA +ADwASwBFAFkATABFAE4APgAxADYAPAAvAEsARQBZAEwARQBOAD4APABBAEwARwBJAEQAPgBBAEUAUwBDAFQAUgA8AC8AQQBMAEcASQBEAD4APAAvAFAAUgBPAFQARQBDAFQASQBOAEYATwA +ADwASwBJAEQAPgBiAGgAdwBpAGUAWQAxAFcAdgBtADMARABqAGkANgBzAEEAdABLAFoAegBRAD0APQA8AC8ASwBJAEQAPgA8AEMASABFAEMASwBTAFUATQA +AGEAVABtAFAASgBWAEMAVgBaADYAcwA9ADwALwBDAEgARQBDAEsAUwBVAE0APgA8AEwAQQBfAFUAUgBMAD4AaAB0AHQAcABzADoALwAvAHAAcgBsAHMALgBhAHQAdgAtAHAAcwAuAGEAbQBhAHoAbwBuAC4AYwBvAG0ALwBjAGQAcAA8AC8ATABBAF8AVQBSAEwAPgA8AEMAVQBTAFQATwBNAEEAVABUAFIASQBCAFUAVABFAFMAPgA8AEkASQBTAF8ARABSAE0AXwBWAEUAUgBTAEkATwBOAD4ANwAuADEALgAxADQAMwA5AC4AMAA8AC8ASQBJAFMAXwBEAFIATQBfAFYARQBSAFMASQBPAE4APgA8AC8AQwBVAFMAVABPAE0AQQBUAFQAUgBJAEIAVQBUAEUAUwA +ADwALwBEAEEAVABBAD4APAAvAFcAUgBNAEgARQBBAEQARQBSAD4A</cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" /> </cpix:ContentKeyUsageRule> SPEKE API v1 - Live workﬂow method call examples 20 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:ContentKeyUsageRuleList> </cpix:CPIX> SPEKE API v1 - VOD workﬂow method call examples Request Syntax Example The following URL is an example and does not indicate a ﬁxed format. POST https://speke-compatible-server/speke/v1.0/copyProtection Request Body A CPIX element. Response Headers Name Speke-User- Agent Type String Content-Type String Request Response Occurs Description 1..1 1..1 String that identiﬁes the key provider application/xml HTTP CODE Payload Name Occurs Description 200 (Success) CPIX 1..1 4XX (Client Client error message 1..1 error) 5XX (Server Server error message 1..1 error) DASH-CPIX payload response Description of the client error Description of the server error SPEKE API v1 - VOD workﬂow method call examples 21 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Note The examples in this section do not include content key encryption. For information on how to add content key encryption, see Content key encryption. VOD Example Request Payload with Keys in the Clear The following example shows a basic VOD request payload from the encryptor to the DRM key provider: <cpix:CPIX id="abc123" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke"> <cpix:ContentKeyList> <cpix:ContentKey kid="98ee5596-cd3e-a20d-163a-e382420c6eff" explicitIV="OFj2IjCsPJFfMAxmQxLGPw=="></cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- HLS AES-128 (systemId is implementation specific)--> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="81376844- f976-481e-a84e-cc25d39b0b33"> <cpix:URIExtXKey></cpix:URIExtXKey> <speke:KeyFormat></speke:KeyFormat> <speke:KeyFormatVersions></speke:KeyFormatVersions> </cpix:DRMSystem> <!-- HLS SAMPLE-AES --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:URIExtXKey></cpix:URIExtXKey> <speke:KeyFormat></speke:KeyFormat> <speke:KeyFormatVersions></speke:KeyFormatVersions> </cpix:DRMSystem> <!-- Common encryption (Widevine)--> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> <!-- Common encryption / MSS (Playready) --> SPEKE API v1 - VOD workﬂow method call examples 22 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <speke:ProtectionHeader></speke:ProtectionHeader> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> </cpix:CPIX> VOD Example Response Payload with Keys in the Clear The following example shows a basic VOD response payload from the DRM key provider: <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke" id="abc123"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- HLS AES-128 (systemId is implementation specific) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="81376844- f976-481e-a84e-cc25d39b0b33"> <cpix:URIExtXKey>aHR0cHM6Ly83azR5dHV4cTVkLmV4ZWN1dGUtYXBpLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tL0VrZVN0YWdlL2NsaWVudC9hYmMxMjMvOThlZTU1OTYtY2QzZS1hMjBkLTE2M2EtZTM4MjQyMGM2ZWZm</ cpix:URIExtXKey> <speke:KeyFormat>aWRlbnRpdHk=</speke:KeyFormat> <speke:KeyFormatVersions>MQ==</speke:KeyFormatVersions> </cpix:DRMSystem> <!-- HLS SAMPLE-AES --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:URIExtXKey>aHR0cHM6Ly83azR5dHV4cTVkLmV4ZWN1dGUtYXBpLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tL0VrZVN0YWdlL2NsaWVudC9hYmMxMjMvOThlZTU1OTYtY2QzZS1hMjBkLTE2M2EtZTM4MjQyMGM2ZWZm</ cpix:URIExtXKey> <speke:KeyFormat>Y29tLmFwcGxlLnN0cmVhbWluZ2tleWRlbGl2ZXJ5</speke:KeyFormat> <speke:KeyFormatVersions>MQ==</speke:KeyFormatVersions> SPEKE API v1 - VOD workﬂow method call examples 23 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:DRMSystem> <!-- Common encryption (Widevine) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH>AAAAanBzc2gAAAAA7e +LqXnWSs6jyCfc1R0h7QAAAEoIARIQeSIcblaNbb7Dji6sAtKZzRoNd2lkZXZpbmVfdGVzdCIfa2V5LWlkOmVTSWNibGFOYmI3RGppNnNBdEtaelE9PSoCU0QyAA==</ cpix:PSSH> </cpix:DRMSystem> <!-- Common encryption / MSS (Playready) --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <speke:ProtectionHeader>CgMAAAEAAQAAAzwAVwBSAE0ASABFAEEARABFAFIAIAB4AG0AbABuAHMAPQAiAGgAdAB0AHAAOgAvAC8AcwBjAGgAZQBtAGEAcwAuAG0AaQBjAHIAbwBzAG8AZgB0AC4AYwBvAG0ALwBEAFIATQAvADIAMAAwADcALwAwADMALwBQAGwAYQB5AFIAZQBhAGQAeQBIAGUAYQBkAGUAcgAiACAAdgBlAHIAcwBpAG8AbgA9ACIANAAuADAALgAwAC4AMAAiAD4APABEAEEAVABBAD4APABQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsARQBZAEwARQBOAD4AMQA2ADwALwBLAEUAWQBMAEUATgA +ADwAQQBMAEcASQBEAD4AQQBFAFMAQwBUAFIAPAAvAEEATABHAEkARAA +ADwALwBQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsASQBEAD4ATwBXAGoAaAB0AHIAMwB1ADkAawArAHIAZABvADEASQBMAFkAMAByAGEAdwA9AD0APAAvAEsASQBEAD4APABDAEgARQBDAEsAUwBVAE0APgBCADMAQQA2AEEAMwB4AG0AdABkAEkAPQA8AC8AQwBIAEUAQwBLAFMAVQBNAD4APABMAEEAXwBVAFIATAA +AGgAdAB0AHAAOgAvAC8AcABsAGEAeQByAGUAYQBkAHkALgBkAGkAcgBlAGMAdAB0AGEAcABzAC4AbgBlAHQALwBwAHIALwBzAHYAYwAvAHIAaQBnAGgAdABzAG0AYQBuAGEAZwBlAHIALgBhAHMAbQB4AD8AUABsAGEAeQBSAGkAZwBoAHQAPQAxACYAYQBtAHAAOwBhAG0AcAA7AGEAbQBwADsAVQBzAGUAUwBpAG0AcABsAGUATgBvAG4AUABlAHIAcwBpAHMAdABlAG4AdABMAGkAYwBlAG4AcwBlAD0AMQA8AC8ATABBAF8AVQBSAEwAPgA8AC8ARABBAFQAQQA +ADwALwBXAFIATQBIAEUAQQBEAEUAUgA+AA==</speke:ProtectionHeader> <cpix:PSSH>AAADMHBzc2gAAAAAmgTweZhAQoarkuZb4IhflQAAAxAQAwAAAQABAAYDPABXAFIATQBIAEUAQQBEAEUAUgAgAHgAbQBsAG4AcwA9ACIAaAB0AHQAcAA6AC8ALwBzAGMAaABlAG0AYQBzAC4AbQBpAGMAcgBvAHMAbwBmAHQALgBjAG8AbQAvAEQAUgBNAC8AMgAwADAANwAvADAAMwAvAFAAbABhAHkAUgBlAGEAZAB5AEgAZQBhAGQAZQByACIAIAB2AGUAcgBzAGkAbwBuAD0AIgA0AC4AMAAuADAALgAwACIAPgA8AEQAQQBUAEEAPgA8AFAAUgBPAFQARQBDAFQASQBOAEYATwA +ADwASwBFAFkATABFAE4APgAxADYAPAAvAEsARQBZAEwARQBOAD4APABBAEwARwBJAEQAPgBBAEUAUwBDAFQAUgA8AC8AQQBMAEcASQBEAD4APAAvAFAAUgBPAFQARQBDAFQASQBOAEYATwA +ADwASwBJAEQAPgBiAGgAdwBpAGUAWQAxAFcAdgBtADMARABqAGkANgBzAEEAdABLAFoAegBRAD0APQA8AC8ASwBJAEQAPgA8AEMASABFAEMASwBTAFUATQA +AGEAVABtAFAASgBWAEMAVgBaADYAcwA9ADwALwBDAEgARQBDAEsAUwBVAE0APgA8AEwAQQBfAFUAUgBMAD4AaAB0AHQAcABzADoALwAvAHAAcgBsAHMALgBhAHQAdgAtAHAAcwAuAGEAbQBhAHoAbwBuAC4AYwBvAG0ALwBjAGQAcAA8AC8ATABBAF8AVQBSAEwAPgA8AEMAVQBTAFQATwBNAEEAVABUAFIASQBCAFUAVABFAFMAPgA8AEkASQBTAF8ARABSAE0AXwBWAEUAUgBTAEkATwBOAD4ANwAuADEALgAxADQAMwA5AC4AMAA8AC8ASQBJAFMAXwBEAFIATQBfAFYARQBSAFMASQBPAE4APgA8AC8AQwBVAFMAVABPAE0AQQBUAFQAUgBJAEIAVQBUAEUAUwA +ADwALwBEAEEAVABBAD4APAAvAFcAUgBNAEgARQBBAEQARQBSAD4A</cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> </cpix:CPIX> SPEKE API v1 - Content key encryption You can optionally add content key encryption to your SPEKE implementation. Content key encryption guarantees full end-to-end protection by encrypting the content keys for transit, in addition to encrypting the content itself. If you don’t implement this for your key provider, you rely on the transport layer encryption plus strong authentication for security. To use content key encryption for encryptors running in AWS Cloud, customers import certiﬁcates into the AWS Certiﬁcate Manager and then use the resulting certiﬁcate ARNs for their encryption activities. The encryptor uses the certiﬁcate ARNs and the ACM service to provide encrypted content keys to the DRM key provider. Restrictions SPEKE API v1 - Content key encryption 24 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide SPEKE supports content key encryption as speciﬁed in the DASH-IF CPIX speciﬁcation with the following restrictions: • SPEKE doesn’t support digital signature veriﬁcation (XMLDSIG) for request or response payloads. • SPEKE requires 2048 RSA-based certiﬁcates. These restrictions are also listed in Customizations and constraints to the DASH-IF speciﬁcation. Implement content key encryption To provide content key encryption, include the following in your DRM key provider implementations: • Handle the element <cpix:DeliveryDataList> in the request and response payloads. • Provide encrypted values in the <cpix:ContentKeyList> of the response payloads. For more information about these elements, see the DASH-IF CPIX 2.0 speciﬁcation. Example Content Key Encryption Element <cpix:DeliveryDataList> in the Request Payload The following example highlights the added <cpix:DeliveryDataList> element in bold: <?xml version="1.0" encoding="UTF-8"?> <cpix:CPIX id="example-test-doc-encryption" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN SERVER ID>"> <cpix:DeliveryKey> <ds:X509Data> <ds:X509Certificate><X.509 CERTIFICATE, BASE-64 ENCODED></ ds:X509Certificate> </ds:X509Data> </cpix:DeliveryKey> </cpix:DeliveryData> </cpix:DeliveryDataList> <cpix:ContentKeyList> ... </cpix:ContentKeyList> </cpix:CPIX> SPEKE API v1 - Content key encryption 25 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Example Content Key Encryption Element <cpix:DeliveryDataList> in the Response Payload The following example highlights the added <cpix:DeliveryDataList> element in bold: <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:enc="http://www.w3.org/2001/04/xmlenc#" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke" id="hls_test_001"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN
speke-008	speke.pdf	8	CPIX 2.0 speciﬁcation. Example Content Key Encryption Element <cpix:DeliveryDataList> in the Request Payload The following example highlights the added <cpix:DeliveryDataList> element in bold: <?xml version="1.0" encoding="UTF-8"?> <cpix:CPIX id="example-test-doc-encryption" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN SERVER ID>"> <cpix:DeliveryKey> <ds:X509Data> <ds:X509Certificate><X.509 CERTIFICATE, BASE-64 ENCODED></ ds:X509Certificate> </ds:X509Data> </cpix:DeliveryKey> </cpix:DeliveryData> </cpix:DeliveryDataList> <cpix:ContentKeyList> ... </cpix:ContentKeyList> </cpix:CPIX> SPEKE API v1 - Content key encryption 25 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Example Content Key Encryption Element <cpix:DeliveryDataList> in the Response Payload The following example highlights the added <cpix:DeliveryDataList> element in bold: <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:enc="http://www.w3.org/2001/04/xmlenc#" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke" id="hls_test_001"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN SERVER ID>"> <cpix:DeliveryKey> <ds:X509Data> <ds:X509Certificate><X.509 CERTIFICATE, BASE-64 ENCODED></ ds:X509Certificate> </ds:X509Data> </cpix:DeliveryKey> <cpix:DocumentKey Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc"> <cpix:Data> <pskc:Secret> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#rsa-oaep-mgf1p" /> <enc:CipherData> <enc:CipherValue><RSA CIPHER VALUE></enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> <pskc:ValueMAC>qnei/5TsfUwDu+8bhsZrLjDRDngvmnUZD2eva7SfXWw=</ pskc:ValueMAC> </pskc:Secret> </cpix:Data> </cpix:DocumentKey> <cpix:MACMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#hmac- sha512"> <cpix:Key> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#rsa-oaep-mgf1p" /> <enc:CipherData> <enc:CipherValue><RSA CIPHER VALUE></enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> <pskc:ValueMAC>DGqdpHUfFKxdsO9+EWrPjtdTCVfjPLwwtzEcFC/j0xY=</ pskc:ValueMAC> </cpix:Key> SPEKE API v1 - Content key encryption 26 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:MACMethod> </cpix:DeliveryData> </cpix:DeliveryDataList> <cpix:ContentKeyList> ... </cpix:ContentKeyList> </cpix:CPIX> Example Content Key Encryption Element <cpix:ContentKeyList> in the Response Payload The following example shows encrypted content key handling in the <cpix:ContentKeyList> element of the response payload. This uses the <pskc:EncryptedValue> element: <cpix:ContentKeyList> <cpix:ContentKey kid="682681c8-69fa-4434-9f9f-1a7f5389ec02"> <cpix:Data> <pskc:Secret> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#aes256-cbc" /> <enc:CipherData> <enc:CipherValue>NJYebfvJ2TdMm3k6v +rLNVYb0NoTJoTLBBdbpe8nmilEfp82SKa7MkqTn2lmQBPB</enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> <pskc:ValueMAC>t9lW4WCebfS1GP+dh0IicMs+2+jnrAmfDa4WU6VGHc4=</ pskc:ValueMAC> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> By comparison, the following example shows a similar response payload with the content key delivered unencrypted, as a clear key. This uses the <pskc:PlainValue> element: <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="682681c8-69fa-4434-9f9f-1a7f5389ec02"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> SPEKE API v1 - Content key encryption 27 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> SPEKE API v1 - Heartbeat Request Syntax Example The following URL is an example and does not indicate a ﬁxed format: GET https://speke-compatible-server/speke/v1.0/heartbeat Request Response HTTP CODE Payload Name Occurs Description 200 (Success) statusMessage 1..1 Message that describes the status SPEKE API v1 - Overriding the key identiﬁer The encryptor creates a new key identiﬁer (KID) each time that it rotates keys. It passes the KID to the DRM key provider in its requests. Almost always, the key provider responds using the same KID, but it can provide a diﬀerent value for the KID in the response. The following is an example request with the KID 11111111-1111-1111-1111-111111111111: <cpix:CPIX id="abc123" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke"> <cpix:ContentKeyList> <cpix:ContentKey kid="11111111-1111-1111-1111-111111111111"></cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- Common encryption (Widevine)--> <cpix:DRMSystem kid="11111111-1111-1111-1111-111111111111" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH /> </cpix:DRMSystem> </cpix:DRMSystemList> SPEKE API v1 - Heartbeat 28 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="11111111-1111-1111-1111-111111111111"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> The following response overrides the KID to 22222222-2222-2222-2222-222222222222: <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" xmlns:speke="urn:aws:amazon:com:speke" id="abc123"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="ASgwx9pQ2/2lnDzJsUxWcQ==" kid="22222222-2222-2222-2222-222222222222"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>p3dWaHARtL97MpT7TE916w==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <cpix:DRMSystem kid="22222222-2222-2222-2222-222222222222" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:PSSH>AAAAanBzc2gAAAAA7e +LqXnWSs6jyCfc1R0h7QAAAEoIARIQeSIcblaNbb7Dji6sAtKZzRoNd2lkZXZpbmVfdGVzdCIfa2V5LWlkOmVTSWNibGFOYmI3RGppNnNBdEtaelE9PSoCU0QyAA==</ cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="22222222-2222-2222-2222-222222222222"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" /> SPEKE API v1 - Overriding the key identiﬁer 29 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> SPEKE API v2 This is the REST API for Secure Packager and Encoder Key Exchange (SPEKE) v2. Use this speciﬁcation to provide DRM copyright protection for customers who use encryption. To be SPEKE- compliant, your DRM key provider must expose the REST API described in this speciﬁcation. The encryptor makes API calls to your key provider. Note The code examples in this speciﬁcation are for illustration purposes only. You can’t run the examples because they aren’t part of a complete SPEKE implementation. SPEKE uses the DASH Industry Forum Content Protection Information Exchange Format (DASH- IF-CPIX) data structure deﬁnition for key exchange, with some restrictions. DASH-IF-CPIX deﬁnes a schema to provide an extensible, multi-DRM exchange from the DRM platform to the encryptor. This enables content encryption for all adaptive bitrate packaging formats at the time of content compression and packaging. Adaptive bitrate packaging formats include HLS, DASH, and MSS. Starting with its version 2.0, SPEKE is aligned on a speciﬁc CPIX version: On the SPEKE side, this is enforced through the use of the X-Speke-Version HTTP header, and on the CPIX side through the use of the CPIX@version attribute. A lack of these elements in the requests is typical of SPEKE v1 legacy workﬂows. In SPEKE v2 workﬂows, the key provider is expected to process CPIX documents only if it supports both version parameters. For detailed information about the exchange format, see the DASH Industry Forum CPIX 2.3 speciﬁcation. Overall, SPEKE v2.0 brings the following evolutions compared to SPEKE v1.0: • All tags from the SPEKE XML namespace are deprecated in favor of equivalent tags in the CPIX XML namespace • SPEKE:ProtectionHeader is deprecated and replaced by CPIX:DRMSystem.SmoothStreamingProtectionHeaderData SPEKE API v2 30 Secure Packager and Encoder Key
speke-009	speke.pdf	9	CPIX@version attribute. A lack of these elements in the requests is typical of SPEKE v1 legacy workﬂows. In SPEKE v2 workﬂows, the key provider is expected to process CPIX documents only if it supports both version parameters. For detailed information about the exchange format, see the DASH Industry Forum CPIX 2.3 speciﬁcation. Overall, SPEKE v2.0 brings the following evolutions compared to SPEKE v1.0: • All tags from the SPEKE XML namespace are deprecated in favor of equivalent tags in the CPIX XML namespace • SPEKE:ProtectionHeader is deprecated and replaced by CPIX:DRMSystem.SmoothStreamingProtectionHeaderData SPEKE API v2 30 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide • CPIX:URIExtXKey, SPEKE:KeyFormat and SPEKE:KeyFormatVersions are deprecated and replaced by CPIX:DRMSystem.HLSSignalingData • CPIX@id is replaced by CPIX@contentId • New mandatory CPIX attributes: CPIX@version, ContentKey@commonEncryptionScheme • New optional CPIX element: DRMSystem.ContentProtectionData • Support for multiple content keys • Cross-versioning mechanism between SPEKE and CPIX • HTTP headers evolution: new X-Speke-Version header, Speke-User-Agent header renamed into X-Speke-User-Agent • Heartbeat API deprecation As the SPEKE v1.0 speciﬁcation stays unchanged, existing implementations don’t need to change to continue supporting SPEKE v1.0 workﬂows. Topics • SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation • SPEKE API v2 - Standard payload components • SPEKE API v2 - Encryption contract • SPEKE API v2 - Live workﬂow method call examples • SPEKE API v2 - VOD workﬂow method call examples • SPEKE API v2 - Content key encryption • SPEKE API v2 - Overriding the key identiﬁer SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation The DASH Industry Forum CPIX 2.3 speciﬁcation supports a number of use cases and topologies. The SPEKE API v2.0 speciﬁcation deﬁnes both a CPIX Proﬁle and an API for CPIX. In order to achieve these two goals, it adheres to the CPIX speciﬁcation with the following customizations and constraints: CPIX Proﬁle • SPEKE follows the Encryptor Consumer workﬂow. SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation 31 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide • For encrypted content keys, SPEKE applies the following restrictions: • SPEKE doesn’t support digital signature veriﬁcation (XMLDSIG) for request or response payloads. • SPEKE requires 2048 RSA-based certiﬁcates. • SPEKE leverages only a subset of CPIX functionalities: • SPEKE omits the UpdateHistoryItemList functionality. If the list is present in the response, SPEKE ignores it. • SPEKE omits the root/leaf key functionality. If the ContentKey@dependsOnKey attribute is present in the response, SPEKE ignores it. • SPEKE omits the BitrateFilter element and the VideoFilter@wcg attribute. If these elements or attributes are present in the CPIX payload, SPEKE ignores it. • Only the elements or attributes referenced as 'Supported' on the Standard Payload Components page or the Encryption contract page can be used in CPIX documents exchanged with SPEKE v2. • When included in a CPIX request by the encryptor, all elements and attributes shall carry a valid value in the key provider CPIX response. If not, the encryptor shall stop and throw an error. • SPEKE supports key rotation with KeyPeriodFilter elements. SPEKE uses only the ContentKeyPeriod@index to track the key period. • For HLS signaling, multiple DRMSystem.HLSSignalingData elements must be used: one with a DRMSystem.HLSSignalingData@playlist attribute value of ‘media’, and another one with a DRMSystem.HLSSignalingData@playlist attribute value of ‘master’. • When requesting keys, the encryptor might use the optional @explicitIV attribute on the ContentKey element. The key provider can respond with an IV using @explicitIV, even if the attribute is not included in the request. • The encryptor creates the key identiﬁer (KID), which stays the same for any given content ID and key period. The key provider includes the KID in its response to the request document. • The encryptor shall include a value for the CPIX@contentId attribute. When receiving an empty value for this attribute, the key provider shall return an error with description 'Missing CPIX@contentId'. CPIX@contentId value cannot be overriden by the key provider. CPIX@id value, if not null, shall be ignored by the key provider. • The encryptor shall include a value for the CPIX@version attribute. When receiving an empty value for this attribute, the key provider shall return an error with description 'Missing CPIX@version'. When receiving a request with an unsupported version, the error description returned by the key provider shall be 'Unsupported CPIX@version'. SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation 32 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide CPIX@version value cannot be overriden by the key provider. • The encryptor shall include a value for the ContentKey@commonEncryptionScheme attribute for each requested key. When receiving an empty value for this attribute, the key provider shall return an error with description 'Missing ContentKey@commonEncryptionScheme for KID id '. A unique CPIX document cannot mix multiple
speke-010	speke.pdf	10	'Missing CPIX@version'. When receiving a request with an unsupported version, the error description returned by the key provider shall be 'Unsupported CPIX@version'. SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation 32 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide CPIX@version value cannot be overriden by the key provider. • The encryptor shall include a value for the ContentKey@commonEncryptionScheme attribute for each requested key. When receiving an empty value for this attribute, the key provider shall return an error with description 'Missing ContentKey@commonEncryptionScheme for KID id '. A unique CPIX document cannot mix multiple values for diﬀerent ContentKey@commonEncryptionScheme attributes. When receiving such a combination, the key provider shall return an error with description 'Non compliant ContentKey@commonEncryptionScheme combination'. Not all ContentKey@commonEncryptionScheme values are compatible with all DRM technologies. When receiving such a combination, the key provider shall return an error with description 'ContentKey@commonEncryptionScheme non compatible with DRMSystem id '. ContentKey@commonEncryptionScheme value cannot be overriden by the key provider. • When receiving diﬀerent values for DRMSystem@PSSH and DRMSystem.ContentProtectionData innerXML <pssh> element in the CPIX response body, the encryptor shall stop and throw an error. API for CPIX • The key provider shall include a value for the X-Speke-User-Agent HTTP response header. • A SPEKE-compliant encryptor acts as a client and sends POST operations to the key provider endpoint. • The encryptor shall include a value for the X-Speke-Version HTTP request header, with the SPEKE version used with the request, formulated as MajorVersion.MinorVersion, like '2.0' for SPEKE v2.0. If the key provider doesn’t support the SPEKE version used by the encryptor for the current request, the key provider shall return an error with description 'Unsupported SPEKE version' and not try to process the CPIX document on a best eﬀort basis. The X-Speke-Version header value deﬁned by the encryptor cannot be modiﬁed by the key provider in the response to the request. • When receiving errors in the response body, the encryptor shall throw an error and not retry the request with a SPEKE v1.0 versioning. SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation 33 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide If the key provider doesn’t return an error but fails to return a CPIX document that includes the mandatory information, the encryptor should stop and throw an error. The following table summarizes the standard messages that must be returned by the key provider in the body of the message. The HTTP response code in error cases shall be a 4XX or a 5XX, never a 200. The 422 error code can be used for all errors related to SPEKE/CPIX. Error case Error message CPIX@contentId is not deﬁned Missing CPIX@contentId CPIX@version is not deﬁned Missing CPIX@version CPIX@version is not supported Unsupported CPIX@version ContentKey@commonEncryptionScheme is not deﬁned Missing ContentKey@commonEncryption Scheme for KID id (where id equals ContentKey@kid value) Multiple ContentKey@commonEncryption Scheme values used in a single CPIX document Non compliant ContentKey@commonE ncryptionScheme combination ContentKey@commonEncryptionScheme is not compatible with DRM technology ContentKey@commonEncryptionScheme non compatible with DRMSystem id (where id equals DRMSystem@systemId value) X-Speke-Version header value is not a supported SPEKE version Unsupported SPEKE version The encryption contract is malformed Malformed encryption contract The encryption contract contradicts DRM security levels constraints Requested CPIX encryption contract not supported The encryption contract doesn’t include any VideoFilter or AudioFilter element Missing CPIX encryption contract SPEKE API v2 - Customizations and constraints to the DASH-IF speciﬁcation 34 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide SPEKE API v2 - Standard payload components Through a single SPEKE request, the encryptor can request multiple content keys, together with the necessary manfest signaling for multiple packaging formats, according to the encryption contract that is deﬁned for a given content. In order to cover all these aspects, a standard CPIX document is composed of three mandatory list sections, plus an optional list section for live content key rotation. <cpix:ContentKeyList> section and top level <cpix:CPIX> element This is a mandatory section, relevant for both Live and VOD streaming, deﬁning the diﬀerent content keys that need to be used by the encryptor. The <cpix:ContentKeyList> element can contain one or several <cpix:ContentKey> child elements, each of them describing a distinct content key. As per the CPIX speciﬁcation, the possible values of the ContentKey@commonEncryptionScheme attribute are deﬁned in the Common encryption in ISO base media ﬁle format ﬁles speciﬁcation (ISO/IEC 23001-7:2016): • 'cenc': AES-CTR mode full sample and video NAL Subsample encryption • 'cbc1': AES-CBC mode full sample and video NAL Subsample encryption • 'cens': AES-CTR mode partial video NAL pattern encryption • 'cbcs': AES-CBC mode partial video NAL pattern encryption The following example shows a CPIX document with a single, non encrypted, content key: <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret>
speke-011	speke.pdf	11	distinct content key. As per the CPIX speciﬁcation, the possible values of the ContentKey@commonEncryptionScheme attribute are deﬁned in the Common encryption in ISO base media ﬁle format ﬁles speciﬁcation (ISO/IEC 23001-7:2016): • 'cenc': AES-CTR mode full sample and video NAL Subsample encryption • 'cbc1': AES-CBC mode full sample and video NAL Subsample encryption • 'cens': AES-CTR mode partial video NAL pattern encryption • 'cbcs': AES-CBC mode partial video NAL pattern encryption The following example shows a CPIX document with a single, non encrypted, content key: <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> SPEKE API v2 - Standard payload components 35 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide ... </cpix:CPIX> By default, content keys are not encrypted, as in the example below. But the encryption of content keys can be requested by the encryptor through the inclusion of the <cpix:DeliveryDataList> element. Please refer to the Content Key Encryption section for more details. Element supported by Mandatory attributes Optional attributes Mandatory child elements Optional child elements SPEKE <cpix:CPIX> name, xmlns:enc contentId , version, xmlns:cpix, xmlns:pskc one <cpix:Con tentKeyList>, one <cpix:Del iveryDataList>, one <cpix:DRM one <cpix:Con SystemList>, tentKeyPe one <cpix:Con riodList> <cpix:Con tentKeyList> - id tentKeyUs ageRuleList> at least one <cpix:Con tentKey> <cpix:Con tentKey> kid, commonEnc ryptionScheme, id, Algorithm, explicitIV one <pskc:Sec ret> <pskc:Secret> Data PlainValue or EncryptedValue ValueMAC - - - <enc:Encr yptionMet hod>, <enc:Ciph erData> <cpix:DRMSystemList> section This is a mandatory section, relevant for both Live and VOD streaming, deﬁning the diﬀerent DRM systems that need to be leveraged together with the content keys. The following example shows a DRM system list with a single PlayReady DRM system speciﬁcation: SPEKE API v2 - Standard payload components 36 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:DRMSystemList> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media">HicXmbZ2m[...]4==</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">HicXmbZ2m[...]jEi</cpix:HLSSignalingData> <cpix:ContentProtectionData>t7WwH24FI[...]YCC</cpix:ContentProtectionData> <cpix:PSSH>FFFFanBzc[...]A==</cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData>s5RrJ12HL[...]UBB</ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> </cpix:DRMSystemList> For a complete list of DRM systemIDs, please refer to the Content Protection section of the DASH- IF Identiﬁers repository. Element supported by Mandatory attributes Optional attributes Mandatory child elements Optional child elements SPEKE <cpix:DRM SystemList> <cpix:DRM System> - id at least one <cpix:DRM System> - kid, systemId id, name, PSSH - ContentPr otectionData, SmoothStr eamingPro tectionHe aderData, two <cpix:HLS SignalingData> elements with diﬀerent playlist attribute value DRMSystem@PSSH is mandatory if ISO-BMFF encapsulation is applied to media segments. DRMSystem.ContentProtectionData innerXML <pssh> element is leveraged by the encryptor only for manifest signaling purposes. SPEKE API v2 - Standard payload components 37 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide If DRMSystem@PSSH is present and DRMSystem.ContentProtectionData contains a innerXML <pssh> element, both values shall be identical. If DRMSystem signaling is to be carried in HLS manifests, both a <cpix:HLSSignalingData playlist="media"> and a <cpix:HLSSignalingData playlist="master"> elements must be included in the CPIX request and response. <cpix:ContentKeyPeriodList> section This is an optional section, relevant only for Live streaming, deﬁning the crypto periods applied to the content. The <cpix:ContentKeyPeriodList> element can contain one or several <cpix:ContentKeyPeriod> child elements, each of them describing a distinct crypto period in the live timeline. Using UUIDs as part of the value of the id attribute is a commonly used approach. <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" / > </cpix:ContentKeyPeriodList> Element supported by Mandatory attributes Optional attributes Mandatory child elements Optional child elements SPEKE <cpix:Con tentKeyPe riodList> - <cpix:Con tentKeyPeriod> id, index id - at least one <cpix:Con tentKeyPeriod> - - - If crypto periods are used, the encryption keys also need to be attached to one of the crypto periods in the CPIX document, as shown in the section below. <cpix:ContentKeyUsageRuleList> section This is a mandatory section, relevant for both Live and VOD streaming, deﬁning how the diﬀerent content keys will protect tracks inside the streamset and across the crypto periods. SPEKE API v2 - Standard payload components 38 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide The <cpix:ContentKeyUsageRuleList> element can contain one or several <cpix:ContentKeyUsageRule> child elements, each of them describing the tracks to which a given content key is applied by the encryptor, potentially during a speciﬁc crypto period. At least one <cpix:AudioFilter> or one <cpix:VideoFilter> element is required to be present in a <cpix:ContentKeyUsageRule> element. The following example shows a simple list with only one rule applying a single content key to all audio and video tracks during a speciﬁc crypto period. <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="ALL"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Element supported by Mandatory attributes Optional attributes Mandatory child elements Optional child elements SPEKE <cpix:Con tentKeyUs ageRuleList> <cpix:Con tentKeyUs ageRule> - id kid, intendedT rackType - - <cpix:Key PeriodFilter> periodId <cpix:Aud ioFilter> - minChannels, maxChannels at least one <cpix:Con tentKeyUs ageRule> at least one <cpix:Aud ioFilter> or one <cpix:Vid eoFilter> (*) - - - <cpix:Key PeriodFilter> - -
speke-012	speke.pdf	12	a <cpix:ContentKeyUsageRule> element. The following example shows a simple list with only one rule applying a single content key to all audio and video tracks during a speciﬁc crypto period. <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="ALL"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Element supported by Mandatory attributes Optional attributes Mandatory child elements Optional child elements SPEKE <cpix:Con tentKeyUs ageRuleList> <cpix:Con tentKeyUs ageRule> - id kid, intendedT rackType - - <cpix:Key PeriodFilter> periodId <cpix:Aud ioFilter> - minChannels, maxChannels at least one <cpix:Con tentKeyUs ageRule> at least one <cpix:Aud ioFilter> or one <cpix:Vid eoFilter> () - - - <cpix:Key PeriodFilter> - - SPEKE API v2 - Standard payload components 39 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Element supported by Mandatory attributes Optional attributes Mandatory child elements Optional child elements SPEKE <cpix:Vid eoFilter> - minPixels, maxPixels, hdr, minFps, maxFps - - () For a detailed explanation on the use of single or of multiple content keys to protect one or several tracks in a streamset, please refer to the Encryption Contract documentation section._ SPEKE API v2 - Encryption contract The encryption contract deﬁnes which content keys are protecting which tracks inside a given streamset, based on the tracks characteristics. Using multiple content keys for diﬀerent tracks in a streamset, despite being a recommended industry best practice, is not mandatory, but recommended - at least two diﬀerent content keys, one for audio tracks and one for video tracks. Using a single content key to encrypt multiple tracks is possible but needs to be explicitly signaled in the CPIX document sent by the encryptor to to key provider. Generally speaking, the encryptor always describes precisely how many content keys are required and how they are leveraged to encrypt the various media tracks. Principles The encryption contract is located in the <cpix:ContentKeyUsageRuleList> section of the CPIX document. In this section, each content key deﬁned in the <cpix:ContentKeyList> section corresponds to a speciﬁc <cpix:ContentKeyUsageRule> element, which shall include: • a ContentKeyUsageRule@intendedTrackType attribute that can reference one or more sub-components, separated by the '+' sign if multiple sub-components are used. The value of ContentKeyUsageRule@intendedTrackType shall be unique in an encryption contract, and can not be used in multiple ContentKeyUsageRule elements. • one or more <cpix:AudioFilter> or <cpix:VideoFilter> child element, depending on the value of ContentKeyUsageRule@intendedTrackType attribute. The rules governing this relationship are the following: SPEKE API v2 - Encryption contract 40 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide • When all the audio and video tracks of the streamset need to be protected with a unique content key, the string 'ALL' must be used as the ContentKeyUsageRule@intendedTrackType attribute value. Example 1 shows such a use case. In this situation, both a <cpix:AudioFilter /> and a <cpix:VideoFilter /> child elements without any attribute shall be included. Any other combination of <cpix:AudioFilter> and/or <cpix:VideoFilter> elements is invalid in this particular context. • For all other use cases, the value of the ContentKeyUsageRule@intendedTrackType attribute can be freely deﬁned, and the number of <cpix:AudioFilter /> and a <cpix:VideoFilter /> child elements must correspond to the number of sub-components aggregated through the '+' sign. Examples 2/3/4/5/6/7/9/10 illustrate this requirement, when a single sub-component is present in the ContentKeyUsageRule@intendedTrackType attribute value. Example 8 illustrate it when multiple sub-components are used: ContentKeyUsageRule@intendedTrackType="SD+HD" is described by two distinct <cpix:VideoFilter> child elements with diﬀerent attributes values, and ContentKeyUsageRule@intendedTrackType="HDR+HFR+UHD" is described by three distinct <cpix:VideoFilter> child elements with diﬀerent attributes values. Filters CPIX deﬁnes multiple ﬁltering elements and attributes, but SPEKE supports only a subset of it. The following table summarizes these diﬀerences: CPIX ﬁlter type Overall SPEKE support Filter attributes supported by SPEKE Filter attributes not supported by SPEKE <cpix:VideoFilter> Yes <cpix:AudioFilter> Yes <cpix:KeyPeriodFil ter> Yes minPixels, maxPixels , hdr, minFps, maxFps (optional attributes) wcg minChannels, maxChannels (optional attributes) periodId (mandatory attribute) <cpix:BitrateFilter> No N/A N/A SPEKE API v2 - Encryption contract 41 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide CPIX ﬁlter type Overall SPEKE support Filter attributes supported by SPEKE Filter attributes not supported by SPEKE <cpix:LabelFilter> No N/A N/A As per the CPIX speciﬁcation for VideoFilter, [minPixels, maxPixels] is an all inclusive range in both dimensions, while (minFps, maxFps] is inclusive only for the maxFps dimension. For AudioFilter, [minChannels, maxChannels] is an inclusive range in both dimensions. Problematic situations There are situations where the information provided in the encryption contract might be partial, ambiguous or erroneous. In these cases, it is important that the encryptor and the key provider behave appropriately and guarantee a proper protection of the contents. The following table presents the recommended behavior in these situations: In this situation The encryptor should/shall … The key provider should/sh all … No rule applies to one or more tracks in the streamset The encryptor should look at its
speke-013	speke.pdf	13	is inclusive only for the maxFps dimension. For AudioFilter, [minChannels, maxChannels] is an inclusive range in both dimensions. Problematic situations There are situations where the information provided in the encryption contract might be partial, ambiguous or erroneous. In these cases, it is important that the encryptor and the key provider behave appropriately and guarantee a proper protection of the contents. The following table presents the recommended behavior in these situations: In this situation The encryptor should/shall … The key provider should/sh all … No rule applies to one or more tracks in the streamset The encryptor should look at its conﬁguration (external to Not relevant: the key provider doesn’t have knowledge of the (see example 3 below) the CPIX payload) and verify streamset structure. that the concerned tracks don’t require encryption. If it’s not the expectation, the encryptor should throw an error and stop processing. Multiple rules overlap and suggest multiple content keys to encrypt a speciﬁc track The encryptor should apply the last ContentKeyUsageRul e successfully evaluated in the order of the document. Not relevant: the key provider doesn’t have knowledge of the streamset structure. The encryption contract changes in a single SPEKE request/response cycle The encryptor shall raise an exception and stop processin g, as the key provider is not To prevent this situation to happen in the ﬁrst place, the key provider must not modify an encryption contract SPEKE API v2 - Encryption contract 42 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide In this situation The encryptor should/shall … The key provider should/sh all … responsible for deﬁning the received in the CPIX payload encryption contract. of the SPEKE request. Malformed encryption contract: intendedTrackType/ The encryptor shall raise an exception, stop processin The key provider shall raise an exception and return Filters cardinality constraint g and not send the SPEKE a 'Malformed encryption exception, unsupported ﬁlters request to the key provider, as contract' error. or attributes it would most likely result in erroneous content protectio n or leave some tracks unprotected. Well formed encryption contract, but in breach of the If the encryptor has got knowledge of the DRM The key provider shall raise an exception and return a DRM security levels constrain security levels constraints, 'Requested CPIX encryption ts: as an example, a single it should raise an exception contract not supported' error. content key being requested , stop processing and not to protect both audio tracks send the SPEKE request to and UHD video tracks the key provider, as it would most likely result in erroneous content protection. Missing encryption contract The encryptor shall not send CPIX documents which don’t The key provider shall raise an exception and return a contain any VideoFilter or AudioFilter element. 'Missing CPIX encryption contract' error. Examples of Encryption Contracts Example 1: one content key for all audio and video tracks <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="ALL"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> SPEKE API v2 - Encryption contract 43 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:AudioFilter /> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 2: one content key for all video tracks, one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 3: one content key for all video tracks, unencrypted audio tracks <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 4: multiple content keys for diﬀerent video tracks (SD/HD), one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for SD video tracks (up to 1024x576) --> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="SD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter maxPixels="589824" /> </cpix:ContentKeyUsageRule> SPEKE API v2 - Encryption contract 44 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <!-- Rule for HD video tracks (more than 1024x576) --> <cpix:ContentKeyUsageRule kid="37e3de05-9a3b-4c69-8970-63c17a95e0b7" intendedTrackType="HD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="589825" /> </cpix:ContentKeyUsageRule> <!-- Rule for all audio tracks --> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 5: multiple content keys for diﬀerent video tracks (SD/HD/UHD), one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for SD video tracks (up to 1024x576) --> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="SD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter maxPixels="589824" /> </cpix:ContentKeyUsageRule> <!-- Rule for HD video tracks (more than 1024x576, up to 1920x1080) --> <cpix:ContentKeyUsageRule kid="37e3de05-9a3b-4c69-8970-63c17a95e0b7" intendedTrackType="HD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="589825" maxPixels="2073600" /> </cpix:ContentKeyUsageRule> <!-- Rule for UHD video tracks (more than 1920x1080) --> <cpix:ContentKeyUsageRule kid="75c6fa78-8b5d-6d75-9653-26f41b78d1a3" intendedTrackType="UHD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="2073601" /> </cpix:ContentKeyUsageRule> <!-- Rule for all audio tracks --> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> SPEKE API v2 - Encryption contract 45 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Example 6: multiple content keys for diﬀerent video tracks (SD/HD/UHD1/UHD2), one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for SD video tracks (up to 1024x576) --> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="SD"> <cpix:KeyPeriodFilter
speke-014	speke.pdf	14	up to 1920x1080) --> <cpix:ContentKeyUsageRule kid="37e3de05-9a3b-4c69-8970-63c17a95e0b7" intendedTrackType="HD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="589825" maxPixels="2073600" /> </cpix:ContentKeyUsageRule> <!-- Rule for UHD video tracks (more than 1920x1080) --> <cpix:ContentKeyUsageRule kid="75c6fa78-8b5d-6d75-9653-26f41b78d1a3" intendedTrackType="UHD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="2073601" /> </cpix:ContentKeyUsageRule> <!-- Rule for all audio tracks --> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> SPEKE API v2 - Encryption contract 45 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Example 6: multiple content keys for diﬀerent video tracks (SD/HD/UHD1/UHD2), one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for SD video tracks (up to 1024x576) --> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="SD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter maxPixels="589824" /> </cpix:ContentKeyUsageRule> <!-- Rule for HD video tracks (more than 1024x576, up to 1920x1080) --> <cpix:ContentKeyUsageRule kid="37e3de05-9a3b-4c69-8970-63c17a95e0b7" intendedTrackType="HD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="589825" maxPixels="2073600" /> </cpix:ContentKeyUsageRule> <!-- Rule for UHD1 video tracks (more than 1920x1080, up to 4096x2160) --> <cpix:ContentKeyUsageRule kid="75c6fa78-8b5d-6d75-9653-26f41b78d1a3" intendedTrackType="UHD1"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="2073601" maxPixels="8847360" /> </cpix:ContentKeyUsageRule> <!-- Rule for UHD2 video tracks (more than 4096x2160) --> <cpix:ContentKeyUsageRule kid="63d2ec36-6b7c-9f34-4546-97d01f36f7c5" intendedTrackType="UHD2"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="8847361" /> </cpix:ContentKeyUsageRule> <!-- Rule for all audio tracks --> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 7: multiple content keys for diﬀerent video tracks (SD/HD1/HD2/UHD1/UHD2), one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for SD video tracks (up to 1024x576) --> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="SD"> SPEKE API v2 - Encryption contract 46 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter maxPixels="589824" /> </cpix:ContentKeyUsageRule> <!-- Rule for HD1 video tracks (more than 1024x576, up to 1280x720) --> <cpix:ContentKeyUsageRule kid="37e3de05-9a3b-4c69-8970-63c17a95e0b7" intendedTrackType="HD1"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="589825" maxPixels="921600" /> </cpix:ContentKeyUsageRule> <!-- Rule for HD2 video tracks (more than 1280x720, up to 1920x1080) --> <cpix:ContentKeyUsageRule kid="cda406d8-9d87-4f76-92da-31110e756176" intendedTrackType="HD2"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="921601" maxPixels="2073600" /> </cpix:ContentKeyUsageRule> <!-- Rule for UHD1 video tracks (more than 1920x1080, up to 4096x2160) --> <cpix:ContentKeyUsageRule kid="75c6fa78-8b5d-6d75-9653-26f41b78d1a3" intendedTrackType="UHD1"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="2073601" maxPixels="8847360" /> </cpix:ContentKeyUsageRule> <!-- Rule for UHD2 video tracks (more than 4096x2160) --> <cpix:ContentKeyUsageRule kid="63d2ec36-6b7c-9f34-4546-97d01f36f7c5" intendedTrackType="UHD2"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter minPixels="8847361" /> </cpix:ContentKeyUsageRule> <!-- Rule for all audio tracks --> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 8: multiple content keys for diﬀerent video tracks (based on multiple attributes types), one content key for all audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for SD and HD video tracks--> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="SD+HD"> SPEKE API v2 - Encryption contract 47 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter maxPixels="442368" maxFps="30" hdr="false"/> <cpix:VideoFilter minPixels="442369" maxPixels="2073600" maxFps="30" hdr="false"/> </cpix:ContentKeyUsageRule> <!-- Rule for HDR, HFR and UHD video tracks--> <cpix:ContentKeyUsageRule kid="37e3de05-9a3b-4c69-8970-63c17a95e0b7" intendedTrackType="HDR+HFR+UHD"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter hdr="true" /> <cpix:VideoFilter minFps="30" /> <cpix:VideoFilter minPixels="20736001" /> </cpix:ContentKeyUsageRule> <!-- Rule for all audio tracks--> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> Example 9: one content keys for all video tracks, multiple content keys for stereo and multichannel audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for video tracks--> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <!-- Rule for stereo audio tracks--> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="STEREO_AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter maxChannels="2"/> </cpix:ContentKeyUsageRule> <!-- Rule for multichannel audio tracks--> <cpix:ContentKeyUsageRule kid="7ae8e96f-309e-42c3-a510-24023d923373" intendedTrackType="MULTICHANNEL_AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <AudioFilter minChannels="3"/> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> SPEKE API v2 - Encryption contract 48 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Example 10: one content keys for all video tracks, multiple content keys for stereo and two types of multichannel audio tracks <cpix:ContentKeyUsageRuleList> <!-- Rule for video tracks--> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <!-- Rule for stereo audio tracks--> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="STEREO_AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter maxChannels="2"/> </cpix:ContentKeyUsageRule> <!-- Rule for multichannel audio tracks (3 to 6 channels)--> <cpix:ContentKeyUsageRule kid="7ae8e96f-309e-42c3-a510-24023d923373" intendedTrackType="MULTICHANNEL_AUDIO_3_6"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter minChannels="3" maxChannels="6"/> </cpix:ContentKeyUsageRule> <!-- Rule for multichannel audio tracks (7 channels and more)--> <cpix:ContentKeyUsageRule kid="81eb3761-55ff-4d22-a31d-94f01bbfd8ba" intendedTrackType="MULTICHANNEL_AUDIO_7"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter minChannels="7"/> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> SPEKE API v2 - Live workﬂow method call examples Request Syntax Example The following URL is an example and does not indicate a ﬁxed format: POST https://speke-compatible-server/speke/v2.0/copyProtection Request Body A CPIX document. Request Headers SPEKE API v2 - Live workﬂow method call examples 49 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Name Type Occurs Description AWS Authoriza String tion X-Amz-Security- String Token X-Amz-Date Content-Type String String X-Speke-Version String 1..1 1..1 1..1 1..1 1..1 See AWS Sigv4 See AWS Sigv4 See AWS Sigv4 application/xml SPEKE API version used with the request, formulate d as MajorVers ion.MinorVersion, like '2.0' for SPEKE v2.0 Response Headers Name Type Occurs Description X-Speke-User- String Agent Content-Type String X-Speke-Version String 1..1 1..1 1..1 String that identiﬁes the key provider application/xml SPEKE API version used with the request, formulate d as MajorVers ion.MinorVersion, like '2.0' for SPEKE v2.0 Request Response SPEKE API v2 - Live workﬂow method call examples 50 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide HTTP CODE Payload Name Occurs Description 200 (Success) CPIX 1..1 4XX (Client Client error message
speke-015	speke.pdf	15	See AWS Sigv4 application/xml SPEKE API version used with the request, formulate d as MajorVers ion.MinorVersion, like '2.0' for SPEKE v2.0 Response Headers Name Type Occurs Description X-Speke-User- String Agent Content-Type String X-Speke-Version String 1..1 1..1 1..1 String that identiﬁes the key provider application/xml SPEKE API version used with the request, formulate d as MajorVers ion.MinorVersion, like '2.0' for SPEKE v2.0 Request Response SPEKE API v2 - Live workﬂow method call examples 50 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide HTTP CODE Payload Name Occurs Description 200 (Success) CPIX 1..1 4XX (Client Client error message 1..1 error) 5XX (Server Server error message 1..1 error) Note DASH-CPIX payload response Description of the client error Description of the server error The examples in this section do not include content key encryption. For information on how to add content key encryption, see Content key encryption. Live Example Request Payload with Keys in the Clear The following example shows a typical live request payload from the encryptor to the DRM key provider, with one content key for all video tracks and one content key for all audio tracks: <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff" commonEncryptionScheme="cbcs"></cpix:ContentKey> <cpix:ContentKey explicitIV="L6jzdXrXAFbCJGBuMrrKrG==" kid="53abdba2-f210-43cb-bc90- f18f9a890a02" commonEncryptionScheme="cbcs"></cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- FairPlay --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> SPEKE API v2 - Live workﬂow method call examples 51 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> </cpix:DRMSystem> <!-- Widevine --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> <!-- Playready --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData></ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData></ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> SPEKE API v2 - Live workﬂow method call examples 52 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> Live Example Response Payload with Keys in the Clear The following example shows a typical response payload from the DRM key provider (returned values have been shortened with […] for readability): <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> <cpix:ContentKey explicitIV="L6jzdXrXAFbCJGBuMrrKrG==" kid="53abdba2-f210-43cb-bc90- f18f9a890a02" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>h3toSFIlyAYpfXVQ795m6x==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- FairPlay --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media">aHR0cHM6L[...]WZm</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">Y29tLmFwc[...]XJ5</cpix:HLSSignalingData> </cpix:DRMSystem> SPEKE API v2 - Live workﬂow method call examples 53 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media">trBAnbMcj[...]u44</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">mn626PjyR[...]2fi</cpix:HLSSignalingData> </cpix:DRMSystem> <!-- Widevine --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media">Ifa2V5LWl[...]nNB</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">oIARIQeSI[...]Nd2l</cpix:HLSSignalingData> <cpix:ContentProtectionData>RoNd2lkZXZ[...]Nib</cpix:ContentProtectionData> <cpix:PSSH>AAAAanBzc[...]A==</cpix:PSSH> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media">lTznjvtzL[...]GfJ</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">XgzdzQH7p[...]zeX</cpix:HLSSignalingData> <cpix:ContentProtectionData>TdgRnuJsZ[...]wDw</cpix:ContentProtectionData> <cpix:PSSH>mYZbjpWdS[...]D==</cpix:PSSH> </cpix:DRMSystem> <!-- Playready --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media">HicXmbZ2m[...]4==</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">GVzdCIfa2[...]Eta</cpix:HLSSignalingData> <cpix:ContentProtectionData>t7WwH24FI[...]YCC</cpix:ContentProtectionData> <cpix:PSSH>FFFFanBzc[...]A==</cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData>s5RrJ12HL[...]UBB</ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media">BptGzwis2[...]Iej</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">3c9SXdVa0[...]MBH</cpix:HLSSignalingData> <cpix:ContentProtectionData>HotJCMQyc[...]GpU</cpix:ContentProtectionData> <cpix:PSSH>S6UD43ybN[...]f==</cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData>VBFUv2or0[...]JeP</ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> SPEKE API v2 - Live workﬂow method call examples 54 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> SPEKE API v2 - VOD workﬂow method call examples Request Syntax Example The following URL is an example and does not indicate a ﬁxed format. POST https://speke-compatible-server/speke/v2.0/copyProtection Request Body A CPIX document. Request Headers Name Type Occurs Description AWS Authoriza String tion X-Amz-Security- String Token X-Amz-Date Content-Type String String X-Speke-Version String 1..1 1..1 1..1 1..1 1..1 See AWS Sigv4 See AWS Sigv4 See AWS Sigv4 application/xml SPEKE API version used with the SPEKE API v2 - VOD workﬂow method call examples 55 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Name Type Occurs Description request, formulate d as MajorVers ion.MinorVersion, like '2.0' for SPEKE v2.0 Response Headers Name Type Occurs Description X-Speke-User- String Agent Content-Type String X-Speke-Version String 1..1 1..1 1..1 String that identiﬁes the key provider application/xml SPEKE API version used with the request, formulate d as MajorVers ion.MinorVersion, like '2.0' for SPEKE v2.0 Request Response HTTP CODE Payload Name Occurs Description 200 (Success) CPIX 1..1 4XX (Client Client error message 1..1 error) 5XX (Server Server error message 1..1 error) DASH-CPIX payload response Description of the client error Description of the server error SPEKE API v2 - VOD workﬂow method call examples 56 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Note The examples in this section do not include content key encryption. For information on how to add content key encryption, see Content key encryption. VOD Example Request Payload with Keys in the Clear The following example shows a typical VOD request payload from
speke-016	speke.pdf	16	Name Occurs Description 200 (Success) CPIX 1..1 4XX (Client Client error message 1..1 error) 5XX (Server Server error message 1..1 error) DASH-CPIX payload response Description of the client error Description of the server error SPEKE API v2 - VOD workﬂow method call examples 56 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Note The examples in this section do not include content key encryption. For information on how to add content key encryption, see Content key encryption. VOD Example Request Payload with Keys in the Clear The following example shows a typical VOD request payload from the encryptor to the DRM key provider, with one content key for all video tracks and one content key for all audio tracks: <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff" commonEncryptionScheme="cbcs"></cpix:ContentKey> <cpix:ContentKey explicitIV="L6jzdXrXAFbCJGBuMrrKrG==" kid="53abdba2-f210-43cb-bc90- f18f9a890a02" commonEncryptionScheme="cbcs"></cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- FairPlay --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> </cpix:DRMSystem> <!-- Widevine --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> SPEKE API v2 - VOD workﬂow method call examples 57 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> <!-- Playready --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData></ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData></ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> VOD Example Response Payload with Keys in the Clear The following example shows a typical response payload from the DRM key provider (returned values have been shortened with […] for readability): <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> SPEKE API v2 - VOD workﬂow method call examples 58 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e-a20d-163a- e382420c6eff" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> <cpix:ContentKey explicitIV="L6jzdXrXAFbCJGBuMrrKrG==" kid="53abdba2-f210-43cb-bc90- f18f9a890a02" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>h3toSFIlyAYpfXVQ795m6x==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- FairPlay --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media">aHR0cHM6L[...]WZm</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">Y29tLmFwc[...]XJ5</cpix:HLSSignalingData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"> <cpix:HLSSignalingData playlist="media">trBAnbMcj[...]u44</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">mn626PjyR[...]2fi</cpix:HLSSignalingData> </cpix:DRMSystem> <!-- Widevine --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media">Ifa2V5LWl[...]nNB</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">oIARIQeSI[...]Nd2l</cpix:HLSSignalingData> <cpix:ContentProtectionData>RoNd2lkZXZ[...]Nib</cpix:ContentProtectionData> <cpix:PSSH>AAAAanBzc[...]A==</cpix:PSSH> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media">lTznjvtzL[...]GfJ</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">XgzdzQH7p[...]zeX</cpix:HLSSignalingData> <cpix:ContentProtectionData>TdgRnuJsZ[...]wDw</cpix:ContentProtectionData> <cpix:PSSH>mYZbjpWdS[...]D==</cpix:PSSH> SPEKE API v2 - VOD workﬂow method call examples 59 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:DRMSystem> <!-- Playready --> <cpix:DRMSystem kid="98ee5596-cd3e-a20d-163a-e382420c6eff" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media">HicXmbZ2m[...]4==</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">GVzdCIfa2[...]Eta</cpix:HLSSignalingData> <cpix:ContentProtectionData>t7WwH24FI[...]YCC</cpix:ContentProtectionData> <cpix:PSSH>FFFFanBzc[...]A==</cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData>s5RrJ12HL[...]UBB</ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> <cpix:DRMSystem kid="53abdba2-f210-43cb-bc90-f18f9a890a02" systemId="9a04f079-9840-4286-ab92-e65be0885f95"> <cpix:HLSSignalingData playlist="media">BptGzwis2[...]Iej</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">3c9SXdVa0[...]MBH</cpix:HLSSignalingData> <cpix:ContentProtectionData>HotJCMQyc[...]GpU</cpix:ContentProtectionData> <cpix:PSSH>S6UD43ybN[...]f==</cpix:PSSH> <cpix:SmoothStreamingProtectionHeaderData>VBFUv2or0[...]JeP</ cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="98ee5596-cd3e-a20d-163a-e382420c6eff" intendedTrackType="VIDEO"> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> <cpix:ContentKeyUsageRule kid="53abdba2-f210-43cb-bc90-f18f9a890a02" intendedTrackType="AUDIO"> <cpix:AudioFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> SPEKE API v2 - Content key encryption You can optionally add content key encryption to your SPEKE implementation. Content key encryption guarantees full end-to-end protection by encrypting the content keys for transit, in addition to encrypting the content itself. If you don’t implement this for your key provider, you rely on the transport layer encryption plus strong authentication for security. To use content key encryption for encryptors running in AWS Cloud, customers import certiﬁcates into the AWS Certiﬁcate Manager and then use the resulting certiﬁcate ARNs for their encryption SPEKE API v2 - Content key encryption 60 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide activities. The encryptor uses the certiﬁcate ARNs and the ACM service to provide encrypted content keys to the DRM key provider. Restrictions SPEKE supports content key encryption as speciﬁed in the DASH-IF CPIX speciﬁcation with the following restrictions: • SPEKE doesn’t support digital signature veriﬁcation (XMLDSIG) for request or response payloads. • SPEKE requires 2048 RSA-based certiﬁcates. These restrictions are also listed in Customizations and constraints to the DASH-IF speciﬁcation. Implement content key encryption To provide content key encryption, include the following in your DRM key provider implementations: • Handle the element <cpix:DeliveryDataList> in the request and response payloads. • Provide encrypted values in the <cpix:ContentKeyList> of the response payloads. For more information about these elements, see the DASH-IF CPIX 2.3 speciﬁcation. Example Content Key Encryption Element <cpix:DeliveryDataList> in the Request Payload <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN SERVER ID>"> <cpix:DeliveryKey> <ds:X509Data> <ds:X509Certificate><X.509 CERTIFICATE, BASE-64 ENCODED></ ds:X509Certificate> </ds:X509Data> </cpix:DeliveryKey> </cpix:DeliveryData> </cpix:DeliveryDataList> <cpix:ContentKeyList> SPEKE API v2 - Content key encryption 61 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide ... </cpix:ContentKeyList> </cpix:CPIX> Example Content Key Encryption Element <cpix:DeliveryDataList> in the Response Payload <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN SERVER ID>"> <cpix:DeliveryKey> <ds:X509Data> <ds:X509Certificate><X.509 CERTIFICATE, BASE-64 ENCODED></ ds:X509Certificate> </ds:X509Data> </cpix:DeliveryKey> <cpix:DocumentKey Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc"> <cpix:Data> <pskc:Secret> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#rsa-oaep-mgf1p" /> <enc:CipherData> <enc:CipherValue><RSA CIPHER VALUE></enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> <pskc:ValueMAC>qnei/5TsfUwDu+8bhsZrLjDRDngvmnUZD2eva7SfXWw=</ pskc:ValueMAC> </pskc:Secret> </cpix:Data> </cpix:DocumentKey> <cpix:MACMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#hmac- sha512"> <cpix:Key> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#rsa-oaep-mgf1p" /> <enc:CipherData> <enc:CipherValue><RSA CIPHER VALUE></enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> SPEKE API v2 - Content key encryption 62 Secure Packager and Encoder
speke-017	speke.pdf	17	<cpix:ContentKeyList> SPEKE API v2 - Content key encryption 61 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide ... </cpix:ContentKeyList> </cpix:CPIX> Example Content Key Encryption Element <cpix:DeliveryDataList> in the Response Payload <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:DeliveryDataList> <cpix:DeliveryData id="<ORIGIN SERVER ID>"> <cpix:DeliveryKey> <ds:X509Data> <ds:X509Certificate><X.509 CERTIFICATE, BASE-64 ENCODED></ ds:X509Certificate> </ds:X509Data> </cpix:DeliveryKey> <cpix:DocumentKey Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc"> <cpix:Data> <pskc:Secret> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#rsa-oaep-mgf1p" /> <enc:CipherData> <enc:CipherValue><RSA CIPHER VALUE></enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> <pskc:ValueMAC>qnei/5TsfUwDu+8bhsZrLjDRDngvmnUZD2eva7SfXWw=</ pskc:ValueMAC> </pskc:Secret> </cpix:Data> </cpix:DocumentKey> <cpix:MACMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#hmac- sha512"> <cpix:Key> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#rsa-oaep-mgf1p" /> <enc:CipherData> <enc:CipherValue><RSA CIPHER VALUE></enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> SPEKE API v2 - Content key encryption 62 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <pskc:ValueMAC>DGqdpHUfFKxdsO9+EWrPjtdTCVfjPLwwtzEcFC/j0xY=</ pskc:ValueMAC> </cpix:Key> </cpix:MACMethod> </cpix:DeliveryData> </cpix:DeliveryDataList> <cpix:ContentKeyList> ... </cpix:ContentKeyList> </cpix:CPIX> Example Content Key Encryption Element <cpix:ContentKeyList> in the Response Payload The following example shows encrypted content key handling in the <cpix:ContentKeyList> element of the response payload. This uses the <pskc:EncryptedValue> element: <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e- a20d-163a-e382420c6eff" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:EncryptedValue> <enc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/ xmlenc#aes256-cbc" /> <enc:CipherData> <enc:CipherValue>NJYebfvJ2TdMm3k6v +rLNVYb0NoTJoTLBBdbpe8nmilEfp82SKa7MkqTn2lmQBPB</enc:CipherValue> </enc:CipherData> </pskc:EncryptedValue> <pskc:ValueMAC>t9lW4WCebfS1GP+dh0IicMs+2+jnrAmfDa4WU6VGHc4=</ pskc:ValueMAC> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> By comparison, the following example shows a similar response payload with the content key delivered unencrypted, as a clear key. This uses the <pskc:PlainValue> element: <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="98ee5596-cd3e- a20d-163a-e382420c6eff" commonEncryptionScheme="cbcs"> SPEKE API v2 - Content key encryption 63 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> SPEKE API v2 - Overriding the key identiﬁer The encryptor creates a new key identiﬁer (KID) each time that it rotates keys. It passes the KID to the DRM key provider in its requests. Almost always, the key provider responds using the same KID, but it can provide a diﬀerent value for the KID in the response. The following is an example request with the KID 11111111-1111-1111-1111-111111111111: <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="11111111-1111-1111-1111-111111111111" commonEncryptionScheme="cbcs"></ cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- Widevine --> <cpix:DRMSystem kid="11111111-1111-1111-1111-111111111111" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media"></cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master"></cpix:HLSSignalingData> <cpix:ContentProtectionData></cpix:ContentProtectionData> <cpix:PSSH></cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="11111111-1111-1111-1111-111111111111" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> SPEKE API v2 - Overriding the key identiﬁer 64 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide </cpix:ContentKeyUsageRuleList> </cpix:CPIX> The following response overrides the KID to 22222222-2222-2222-2222-222222222222: <cpix:CPIX contentId="abc123" version="2.3" xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc"> <cpix:ContentKeyList> <cpix:ContentKey explicitIV="OFj2IjCsPJFfMAxmQxLGPw==" kid="22222222-2222-2222-2222-222222222222" commonEncryptionScheme="cbcs"> <cpix:Data> <pskc:Secret> <pskc:PlainValue>5dGAgwGuUYu4dHeHtNlxJw==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <!-- Widevine --> <cpix:DRMSystem kid="22222222-2222-2222-2222-222222222222" systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"> <cpix:HLSSignalingData playlist="media">Ifa2V5LWl[...]nNB</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="master">oIARIQeSI[...]Nd2l</cpix:HLSSignalingData> <cpix:ContentProtectionData>RoNd2lkZXZ[...]Nib</cpix:ContentProtectionData> <cpix:PSSH>AAAAanBzc[...]A==</cpix:PSSH> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f" index="1" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="22222222-2222-2222-2222-222222222222" intendedTrackType="VIDEO"> <cpix:KeyPeriodFilter periodId="keyPeriod_0909829f-40ff-4625-90fa-75da3e53278f"/> <cpix:VideoFilter /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX> SPEKE API v2 - Overriding the key identiﬁer 65 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide License for the SPEKE API speciﬁcation Creative Commons Attribution-ShareAlike 4.0 International Public License By exercising the Licensed Rights (deﬁned below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of beneﬁts the Licensor receives from making the Licensed Material available under these terms and conditions. Section 1 – Deﬁnitions. a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modiﬁed in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. b. Adapter’s License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License. d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights speciﬁed in Section 2(b)(1)-(2) are not Copyright and Similar Rights. e. Eﬀective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulﬁlling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the
speke-018	speke.pdf	18	recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights speciﬁed in Section 2(b)(1)-(2) are not Copyright and Similar Rights. e. Eﬀective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulﬁlling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. License for the SPEKE API speciﬁcation 66 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. j. Licensor means the individual(s) or entity(ies) granting rights under this Public License. k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/ EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. m.You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. Section 2 – Scope. a. License grant. 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: A. reproduce and Share the Licensed Material, in whole or in part; and B. produce, reproduce, and Share Adapted Material. 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. 3. Term. The term of this Public License is speciﬁed in Section 6(a). 4. Media and formats; technical modiﬁcations allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, Creative Commons Attribution-ShareAlike 4.0 International Public License 67 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide and to make technical modiﬁcations necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modiﬁcations necessary to exercise the Licensed Rights, including technical modiﬁcations necessary to circumvent Eﬀective Technological Measures. For purposes of this Public License, simply making modiﬁcations authorized by this Section 2(a)(4) never produces Adapted Material. 5. Downstream recipients. A. Oﬀer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an oﬀer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. B. Additional oﬀer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an oﬀer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. C. No downstream restrictions. You may not oﬀer or impose any additional or diﬀerent terms or conditions on, or apply any Eﬀective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted oﬃcial status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). b. Other rights. 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor
speke-019	speke.pdf	19	endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted oﬃcial status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). b. Other rights. 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. 2. Patent and trademark rights are not licensed under this Public License. 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. Section 3 – License Conditions. Your exercise of the Licensed Rights is expressly made subject to the following conditions. a. Attribution. Creative Commons Attribution-ShareAlike 4.0 International Public License 68 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide 1. If You Share the Licensed Material (including in modiﬁed form), You must: A. retain the following if it is supplied by the Licensor with the Licensed Material: i . identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); ii . a copyright notice; iii . a notice that refers to this Public License; iv . a notice that refers to the disclaimer of warranties; v . a URI or hyperlink to the Licensed Material to the extent reasonably practicable; B. indicate if You modiﬁed the Licensed Material and retain an indication of any previous modiﬁcations; and C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. 3. If requested by the Licensor, You must remove any of the information required by Section 3(a) (1)(A) to the extent reasonably practicable. b. ShareAlike. In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. 2. You must include the text of, or the URI or hyperlink to, the Adapter’s License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. Creative Commons Attribution-ShareAlike 4.0 International Public License 69 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide 3. You may not oﬀer or impose any additional or diﬀerent terms or conditions on, or apply any Eﬀective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter’s License You apply. Section 4 – Sui Generis Database Rights. Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. Section 5 – Disclaimer of Warranties and Limitation of Liability. a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor oﬀers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, ﬁtness for a
speke-020	speke.pdf	20	or a substantial portion of the contents of the database. For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. Section 5 – Disclaimer of Warranties and Limitation of Liability. a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor oﬀers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, ﬁtness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. Creative Commons Attribution-ShareAlike 4.0 International Public License 70 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. Section 6 – Term and Termination. a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or 2. upon express reinstatement by the Licensor. c. For the avoidance of doubt, this Section 6(b) does not aﬀect any right the Licensor may have to seek remedies for Your violations of this Public License. d. For the avoidance of doubt, the Licensor may also oﬀer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. Section 7 – Other Terms and Conditions. a. The Licensor shall not be bound by any additional or diﬀerent terms or conditions communicated by You unless expressly agreed. b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. Section 8 – Interpretation. a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the Creative Commons Attribution-ShareAlike 4.0 International Public License 71 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide provision cannot be reformed, it shall be severed from this Public License without aﬀecting the enforceability of the remaining terms and conditions. c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. Creative Commons Attribution-ShareAlike 4.0 International Public License 72 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Document history for the SPEKE partner and customer guide The following table describes the changes to the SPEKE documentation. SPEKE v1 Change Description Date Support matrix: AWS Partner services and products Added a new section for SPEKE Support in AWS January 13, 2023 Partner services and products, listing Bitmovin services. Updates to DRM platform providers Added links and new partner information to the DRM January 24, 2019 platform provider list. Include third-party encryptors Updated the architecture and November 20, 2018 Content Key Encryption descriptions to account for third-party encryptors. Added
speke-021	speke.pdf	21	and Encoder Key Exchange API Speciﬁcation Partner and customer guide Document history for the SPEKE partner and customer guide The following table describes the changes to the SPEKE documentation. SPEKE v1 Change Description Date Support matrix: AWS Partner services and products Added a new section for SPEKE Support in AWS January 13, 2023 Partner services and products, listing Bitmovin services. Updates to DRM platform providers Added links and new partner information to the DRM January 24, 2019 platform provider list. Include third-party encryptors Updated the architecture and November 20, 2018 Content Key Encryption descriptions to account for third-party encryptors. Added the option to encrypt content keys. Prior to this, Secure Packager and Encoder Key Exchange supported clear key delivery only. October 30, 2018 Support matrix - AWS Elemental Live Added an AWS Elemental Live support matrix. September 27, 2018 Standard payload component s Added a section that deﬁnes the main elements in the JSON payload. September 27, 2018 KID override Added a section about KID overrides by a key provider. September 27, 2018 73 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Change Description Date Corrected links to DASH-IF site Corrected links to the DASH IF site for the CPIX speciﬁcation September 27, 2018 Release copy for AWS Elemental Live CMAF Initial release July 20, 2018 June 27, 2018 November 27, 2017 and for the system IDs page. Updated the SPEKE documentation to include AWS Elemental products. Updated the support matrix tables for services to include the Common Media Applicati on Format (CMAF). Initial release of Secure Packager and Encoder Key Exchange (SPEKE) version 1, a speciﬁcation for communica tion between a content encryptor and a DRM key provider. The DRM key provider exposes a Secure Packager and Encoder Key Exchange API to handle incoming key requests. SPEKE v2 Change Description Date Updates to DRM platform providers section and AWS services and products supporting SPEKE section Added Webstream to the SPEKE v2 column of the DRM platform provider list, added MediaConvert to the SPEKE v2 column of the SPEKE October 10, 2024 74 Secure Packager and Encoder Key Exchange API Speciﬁcation Partner and customer guide Change Description Date support in AWS services and products table. Updates to DRM platform providers section Added new qualiﬁed partners to the SPEKE v2 column of August 9, 2023 the DRM platform provider list. Updates to Live and VOD workﬂow method call Added missing X-Speke- Version response header examples sections in SPEKE v2 Live and VOD January 13, 2023 workﬂow method call examples sections. Updates to DRM platform providers and Encryption Added new qualiﬁed partners to the SPEKE v2 column of January 27, 2022 contract section the DRM platform provider Initial release September 7, 2021 list. Added two new examples of Encryption contracts, and changed SD max resolution to 1024x576 in all concerned examples. Initial release of Secure Packager and Encoder Key Exchange (SPEKE) version 2.0, a speciﬁcation for communication between a content encryptor and a DRM key provider. The DRM key provider exposes a Secure Packager and Encoder Key Exchange API to handle incoming key requests. 75
sql-reference-001	sql-reference.pdf	1	SQL Reference AWS Clean Rooms Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Clean Rooms SQL Reference AWS Clean Rooms: SQL Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Clean Rooms Table of Contents SQL Reference Overview .......................................................................................................................................... 1 Conventions ................................................................................................................................................... 1 Naming rules ................................................................................................................................................. 2 Conﬁgured table association names and columns ........................................................................... 2 Reserved words ........................................................................................................................................ 4 AWS Clean Rooms Spark SQL ......................................................................................................... 6 Literals ............................................................................................................................................................. 6 + (Concatenation) operator ................................................................................................................... 7 Data types ...................................................................................................................................................... 8 Multibyte characters ............................................................................................................................. 10 Numeric types ........................................................................................................................................ 10 Character types ..................................................................................................................................... 18 Datetime types ...................................................................................................................................... 20 Boolean type .......................................................................................................................................... 37 Binary type ............................................................................................................................................. 41 Nested type ............................................................................................................................................ 41 Type compatibility and conversion ................................................................................................... 43 SQL commands ........................................................................................................................................... 48 SELECT ..................................................................................................................................................... 48 SQL functions .............................................................................................................................................. 96 Aggregate functions ............................................................................................................................. 96 Array functions .................................................................................................................................... 126 Binary functions .................................................................................................................................. 137 Conditional expressions ..................................................................................................................... 138 Constructor functions ........................................................................................................................ 151 Data type formatting functions ...................................................................................................... 154 Date and time functions ................................................................................................................... 186 Encryption and decryption functions ............................................................................................. 223 Hash functions .................................................................................................................................... 227 Hyperloglog functions ....................................................................................................................... 233 JSON functions ................................................................................................................................... 241 Math functions .................................................................................................................................... 244 Scalar functions .................................................................................................................................. 279 String functions .................................................................................................................................. 281 iii AWS Clean Rooms SQL Reference Privacy-related functions .................................................................................................................. 334 Window functions ............................................................................................................................... 339 SQL conditions ......................................................................................................................................... 366 Comparison operators ....................................................................................................................... 367 Logical conditions ............................................................................................................................... 372 Pattern-matching conditions ........................................................................................................... 376 BETWEEN range condition ............................................................................................................... 385 Null condition ...................................................................................................................................... 387 EXISTS condition ................................................................................................................................. 388 IN condition ......................................................................................................................................... 389 AWS Clean Rooms SQL ............................................................................................................... 392 Literals ........................................................................................................................................................ 392 + (Concatenation) operator .............................................................................................................. 393 Data types ................................................................................................................................................. 394 Multibyte characters ............................................................................................................................. 10 Numeric types ..................................................................................................................................... 396 Character types ................................................................................................................................... 403 Datetime types .................................................................................................................................... 405 Boolean type ....................................................................................................................................... 425 SUPER type .......................................................................................................................................... 428 Nested type ......................................................................................................................................... 428 VARBYTE type ...................................................................................................................................... 431 Type compatibility and conversion ................................................................................................. 433 SQL commands ........................................................................................................................................ 439 SELECT .................................................................................................................................................. 439 SQL functions ........................................................................................................................................... 473 Aggregate functions ........................................................................................................................... 473 Array functions .................................................................................................................................... 500 Conditional expressions ..................................................................................................................... 506 Data type formatting functions ...................................................................................................... 516 Date and time functions ................................................................................................................... 541 Hash functions .................................................................................................................................... 574 JSON functions ................................................................................................................................... 579 Math functions .................................................................................................................................... 589 String functions .................................................................................................................................. 621 SUPER type information functions ................................................................................................. 670 iv AWS Clean Rooms SQL Reference VARBYTE functions ............................................................................................................................. 682 Window functions ............................................................................................................................... 686 SQL conditions ......................................................................................................................................... 747 Comparison conditions ...................................................................................................................... 748 Logical conditions ............................................................................................................................... 752 Pattern-matching conditions ........................................................................................................... 756 BETWEEN range condition ............................................................................................................... 764 Null condition ...................................................................................................................................... 766 EXISTS condition ................................................................................................................................. 767 IN condition ......................................................................................................................................... 768 Syntax .................................................................................................................................................... 769 Querying nested data ................................................................................................................. 770 Navigation .................................................................................................................................................. 770 Unnesting queries .................................................................................................................................... 771 Lax semantics ............................................................................................................................................ 773 Types of introspection ............................................................................................................................ 774 Document history ........................................................................................................................ 775 v AWS Clean Rooms SQL Reference Overview of SQL in AWS Clean Rooms Welcome to the AWS Clean Rooms SQL Reference. AWS Clean Rooms is built around industry-standard Structured Query Language (SQL), a query language that consists of commands and functions that you use to work with databases and database objects. SQL also enforces rules regarding the use of data types, expressions, and literals. The following topics provide general information about the conventions and naming rules used in this SQL Reference. Topics • SQL reference conventions • SQL naming rules The following sections provide information about the literals, data types, SQL commands, types of SQL functions, and SQL conditions you can use in AWS Clean Rooms. • AWS Clean Rooms Spark SQL • AWS Clean Rooms SQL For more information about AWS Clean Rooms, see the AWS Clean Rooms User Guide and the AWS Clean Rooms API Reference. SQL reference conventions This section explains the conventions that are used to write the syntax for the SQL expressions, commands, and functions. Character Description CAPS [ ] Words in capital letters are key words. Brackets denote optional arguments. Multiple arguments in brackets indicate that you can choose any number of the arguments. In addition, arguments in brackets on separate lines indicate that the parser Conventions 1 AWS Clean Rooms SQL Reference Character Description { } \| italics ... ' expects the arguments to be in the order that they are listed in the syntax. Braces indicate that you are required to choose one of the arguments inside the braces. Pipes indicate that you can choose between the arguments. Words in italics indicate placeholders. You must insert the appropriate value in place of the word in italics. An ellipsis indicates that you can repeat the preceding element. Words in single quotation marks indicate
sql-reference-002	sql-reference.pdf	2	In addition, arguments in brackets on separate lines indicate that the parser Conventions 1 AWS Clean Rooms SQL Reference Character Description { } \| italics ... ' expects the arguments to be in the order that they are listed in the syntax. Braces indicate that you are required to choose one of the arguments inside the braces. Pipes indicate that you can choose between the arguments. Words in italics indicate placeholders. You must insert the appropriate value in place of the word in italics. An ellipsis indicates that you can repeat the preceding element. Words in single quotation marks indicate that you must type the quotes. SQL naming rules The following sections explain the SQL naming rules in AWS Clean Rooms. Topics • Conﬁgured table association names and columns • Reserved words Conﬁgured table association names and columns Members who can query use conﬁgured table association names as table names in queries. Conﬁgured table association names and conﬁgured table columns can be aliased in queries. The following naming rules apply to conﬁgured table association names, conﬁgured table column names, and aliases: • They must use only alphanumeric, underscore (_), or hyphen (-) characters but can't start or end with a hyphen. Naming rules 2 AWS Clean Rooms SQL Reference • (Custom analysis rule only) They can use the dollar sign ($) but can't use a pattern that follows a dollar-quoted string constant. A dollar-quoted string constant consists of: • a dollar sign ($) • an optional "tag" of zero or more characters • another dollar sign • arbitrary sequence of characters that makes up the string content • a dollar sign ($) • the same tag that began the dollar quote • a dollar sign For example: $$invalid$$ • They can't contain consecutive hyphen (-) characters. • They can't begin with any of the following preﬁxes: padb_, pg_, stcs_, stl_, stll_, stv_, svcs_, svl_, svv_, sys_, systable_ • They can't contain backslash characters (\) , quotation marks ('), or spaces that aren't double- quoted. • If they start with a non-alphabetical character, they must be within double-quotes (" "). • If they contain a hyphen (-) character, they must be within double-quotes (" "). • They must be between 1 and 127 characters in length. • Reserved words must be within double-quotes (" "). • The following column names are reserved can't be used in AWS Clean Rooms (even with quotes): • oid • tableoid • xmin • cmin • xmax • cmax • ctid Conﬁgured table association names and columns 3 AWS Clean Rooms Reserved words The following is a list of reserved words in AWS Clean Rooms. SQL Reference AES128 DELTA32KDESC LEADING PRIMARY AES256ALL DISTINCT LEFTLIKE RAW ALLOWOVER WRITEANALYSE DO LIMIT READRATIO ANALYZE DISABLE LOCALTIME RECOVERRE FERENCES AND ANY ARRAY AS ASC ELSE LOCALTIMESTAMP REJECTLOG EMPTYASNU LLENABLE ENCODE ENCRYPT LUN LUNS LZO RESORT RESPECT RESTORE ENCRYPTIONEND LZOP RIGHTSELECT AUTHORIZATION EXCEPT MINUS SESSION_USER AZ64 EXPLICITFALSE MOSTLY16 SIMILAR BACKUPBETWEEN FOR MOSTLY32 SNAPSHOT BINARY FOREIGN MOSTLY8NATURAL SOME BLANKSASN ULLBOTH BYTEDICT BZIP2CASE FREEZE FROM FULL NEW NOT NOTNULL CAST GLOBALDICT256 NULL SYSDATESYSTEM TABLE TAG TDES Reserved words 4 AWS Clean Rooms CHECK COLLATE COLUMN GLOBALDIC T64KGRANT NULLSOFF TEXT255 GROUP OFFLINEOFFSET TEXT32KTHEN SQL Reference GZIPHAVING CONSTRAINT IDENTITY CREATE IGNOREILIKE CREDENTIALSCROSS IN CURRENT_DATE INITIALLY OID OLD ON ONLY OPEN CURRENT_TIME INNER OR CURRENT_T IMESTAMP INTERSECT ORDER TIMESTAMP TO TOPTRAILING TRUE TRUNCATEC OLUMNSUNION UNIQUE UNNEST CURRENT_USER INTERVAL OUTER USING CURRENT_U SER_IDDEFAULT INTO OVERLAPS VERBOSE DEFERRABLE IS PARALLELPARTITION WALLETWHEN DEFLATE DEFRAG DELTA ISNULL JOIN PERCENT WHERE PERMISSIONS WITH LANGUAGE PIVOTPLACING WITHOUT Reserved words 5 AWS Clean Rooms SQL Reference AWS Clean Rooms Spark SQL AWS Clean Rooms Spark SQL enforces rules regarding the use of data types, expressions, and literals. For more information about AWS Clean Rooms Spark SQL, see the AWS Clean Rooms User Guide and the AWS Clean Rooms API Reference. The following topics provide information about the literals, data types, commands, functions, and conditions supported in AWS Clean Rooms Spark SQL. Topics • Literals • Data types • AWS Clean Rooms Spark SQL commands • AWS Clean Rooms Spark SQL functions • AWS Clean Rooms Spark SQL conditions Literals A literal or constant is a ﬁxed data value, composed of a sequence of characters or a numeric constant. AWS Clean Rooms Spark SQL supports several types of literals, including: • Numeric literals for integer, decimal, and ﬂoating-point numbers. • Character literals, also referred to as strings, character strings, or character constants, used to specify a character string value. • Date, time, and timestamp literals, used with datetime data types. For more information, see Date, time, and timestamp literals. • Interval literals. For more information, see Interval literals. • Boolean literals. For more information, see Boolean literals. • Null literals, used to specify a null value. • Only TAB, CARRIAGE RETURN (CR), and LINE
sql-reference-003	sql-reference.pdf	3	characters or a numeric constant. AWS Clean Rooms Spark SQL supports several types of literals, including: • Numeric literals for integer, decimal, and ﬂoating-point numbers. • Character literals, also referred to as strings, character strings, or character constants, used to specify a character string value. • Date, time, and timestamp literals, used with datetime data types. For more information, see Date, time, and timestamp literals. • Interval literals. For more information, see Interval literals. • Boolean literals. For more information, see Boolean literals. • Null literals, used to specify a null value. • Only TAB, CARRIAGE RETURN (CR), and LINE FEED (LF) Unicode control characters from the Unicode general category (Cc) are supported. Literals 6 AWS Clean Rooms SQL Reference AWS Clean Rooms Spark SQL doesn't support direct references to string literals in the SELECT clause, but they can be used within functions such as CAST. + (Concatenation) operator Concatenates numeric literals, string literals, and/or datetime and interval literals. They are on either side of the + symbol and return diﬀerent types based on the inputs on either side of the + symbol. Syntax numeric + string date + time date + timetz The order of the arguments can be reversed. Arguments numeric literals Literals or constants that represent numbers can be integer or ﬂoating-point. string literals Strings, character strings, or character constants date A DATE column or an expression that implicitly converts to a DATE. time A TIME column or an expression that implicitly converts to a TIME. timetz A TIMETZ column or an expression that implicitly converts to a TIMETZ. + (Concatenation) operator 7 AWS Clean Rooms Example SQL Reference The following example table TIME_TEST has a column TIME_VAL (type TIME) with three values inserted. select date '2000-01-02' + time_val as ts from time_test; Data types Each value that AWS Clean Rooms Spark SQL stores or retrieves has a data type with a ﬁxed set of associated properties. Data types are declared when tables are created. A data type constrains the set of values that a column or argument can contain. The following table lists the data types that you can use in AWS Clean Rooms Spark SQL. Data type name Data type Aliases Description ARRAY BIGINT BINARY the section called “Nested type” the section called “Numeric types” the section called “Binary type” Not applicable Not applicable Array nested data type Signed eight-byte integer Not applicable Byte sequence values BOOLEAN the section called “Boolean type” BOOL Logical Boolean (true/false) BYTE CHAR DATE Data types the section called “Binary type” Not applicable the section called “Character types” the section called “Datetime types” CHARACTER Not applicable 1-byte signed integer numbers, from -128 to 127 Fixed-length character string Calendar date (year, month, day) 8 AWS Clean Rooms SQL Reference Data type name Data type Aliases Description DECIMAL FLOAT INTEGER INTERVAL LONG MAP REAL SHORT SMALLINT STRUCT TIME the section called “Numeric types” NUMERIC Exact numeric of selectable precision the section called “Numeric types” FLOAT8, DOUBLE PRECISION Double precision ﬂoating-point the section called “Numeric types” INT the section called “Datetime types” Not applicable Not applicable number Signed four-byte integer Time duration in day to time order or year to month order 8-byte signed integer numbers the section called “Numeric types” the section called “Nested type” the section called “Numeric types” the section called “Numeric types” the section called “Numeric types” the section called “Nested type” the section called “Datetime types” Not applicable Map nested data type FLOAT4 Not applicable Not applicable Not applicable Single precision ﬂoating-point number 2-byte signed integer numbers. Signed two-byte integer Struct nested data type Not applicable Time of day Data types 9 AWS Clean Rooms SQL Reference Data type name Data type Aliases Description the section called “Datetime types” the section called “Datetime types” the section called “Numeric types” the section called “Character types” Not applicable Not applicable Not applicable Time of day with local time zone Time of day without time zone 1-byte signed integer numbers, from -128 to 127 CHARACTER VARYING Variable-length character string with a user-deﬁned limit TIMESTAMP_LTZ TIMESTAMP_NTZ TINYINT VARCHAR Note The ARRAY, STRUCT, and MAP nested data types are currently only enabled for the custom analysis rule. For more information, see Nested type. Multibyte characters The VARCHAR data type supports UTF-8 multibyte characters up to a maximum of four bytes. Five-byte or longer characters are not supported. To calculate the size of a VARCHAR column that contains multibyte characters, multiply the number of characters by the number of bytes per character. For example, if a string has four Chinese characters, and each character is three bytes long, then you will need a VARCHAR(12) column to store the string. The VARCHAR data type doesn't support the following invalid UTF-8 codepoints: 0xD800 – 0xDFFF (Byte sequences: ED A0 80 – ED BF BF) The CHAR
sql-reference-004	sql-reference.pdf	4	Multibyte characters The VARCHAR data type supports UTF-8 multibyte characters up to a maximum of four bytes. Five-byte or longer characters are not supported. To calculate the size of a VARCHAR column that contains multibyte characters, multiply the number of characters by the number of bytes per character. For example, if a string has four Chinese characters, and each character is three bytes long, then you will need a VARCHAR(12) column to store the string. The VARCHAR data type doesn't support the following invalid UTF-8 codepoints: 0xD800 – 0xDFFF (Byte sequences: ED A0 80 – ED BF BF) The CHAR data type doesn't support multibyte characters. Numeric types Numeric data types include integers, decimals, and ﬂoating-point numbers. Multibyte characters 10 SQL Reference AWS Clean Rooms Topics • Integer types • DECIMAL or NUMERIC type • Floating-point types • Computations with numeric values Integer types Use the following data types to store whole numbers of various ranges. You can't store values outside of the allowed range for each type. Name SMALLINT SHORT INTEGER or INT BIGINT LONG Storage Range 2 bytes 2 bytes 4 bytes 8 bytes 8 bytes -32768 to +32767 -32768 to +32767 -2147483648 to +2147483647 -92233720 36854775808 to 922337203 6854775807 -92233720 36854775808 to 922337203 6854775807 DECIMAL or NUMERIC type Use the DECIMAL or NUMERIC data type to store values with a user-deﬁned precision. The DECIMAL and NUMERIC keywords are interchangeable. In this document, decimal is the preferred term for this data type. The term numeric is used generically to refer to integer, decimal, and ﬂoating-point data types. Numeric types 11 AWS Clean Rooms Storage Range SQL Reference Variable, up to 128 bits for uncompressed DECIMAL types. 128-bit signed integers with up to 38 digits of precision. Deﬁne a DECIMAL column in a table by specifying a precision and scale: decimal(precision, scale) precision The total number of signiﬁcant digits in the whole value: the number of digits on both sides of the decimal point. For example, the number 48.2891 has a precision of 6 and a scale of 4. The default precision, if not speciﬁed, is 18. The maximum precision is 38. If the number of digits to the left of the decimal point in an input value exceeds the precision of the column minus its scale, the value can't be copied into the column (or inserted or updated). This rule applies to any value that falls outside the range of the column deﬁnition. For example, the allowed range of values for a numeric(5,2) column is -999.99 to 999.99. scale The number of decimal digits in the fractional part of the value, to the right of the decimal point. Integers have a scale of zero. In a column speciﬁcation, the scale value must be less than or equal to the precision value. The default scale, if not speciﬁed, is 0. The maximum scale is 37. If the scale of an input value that is loaded into a table is greater than the scale of the column, the value is rounded to the speciﬁed scale. For example, the PRICEPAID column in the SALES table is a DECIMAL(8,2) column. If a DECIMAL(8,4) value is inserted into the PRICEPAID column, the value is rounded to a scale of 2. insert into sales values (0, 8, 1, 1, 2000, 14, 5, 4323.8951, 11.00, null); select pricepaid, salesid from sales where salesid=0; pricepaid \| salesid -----------+--------- 4323.90 \| 0 Numeric types 12 AWS Clean Rooms (1 row) SQL Reference However, results of explicit casts of values selected from tables are not rounded. Note The maximum positive value that you can insert into a DECIMAL(19,0) column is 9223372036854775807 (263 -1). The maximum negative value is -9223372036854775807. For example, an attempt to insert the value 9999999999999999999 (19 nines) will cause an overﬂow error. Regardless of the placement of the decimal point, the largest string that AWS Clean Rooms can represent as a DECIMAL number is 9223372036854775807. For example, the largest value that you can load into a DECIMAL(19,18) column is 9.223372036854775807. These rules are because of the following: • DECIMAL values with 19 or fewer signiﬁcant digits of precision are stored internally as 8- byte integers. • DECIMAL values with 20 to 38 signiﬁcant digits of precision are stored as 16-byte integers. Notes about using 128-bit DECIMAL or NUMERIC columns Do not arbitrarily assign maximum precision to DECIMAL columns unless you are certain that your application requires that precision. 128-bit values use twice as much disk space as 64-bit values and can slow down query execution time. Floating-point types Use the REAL and DOUBLE PRECISION data types to store numeric values with variable precision. These types are inexact types, meaning that some values are stored as approximations, such that storing and returning a speciﬁc value may result in slight discrepancies. If you require exact storage and
sql-reference-005	sql-reference.pdf	5	precision are stored as 16-byte integers. Notes about using 128-bit DECIMAL or NUMERIC columns Do not arbitrarily assign maximum precision to DECIMAL columns unless you are certain that your application requires that precision. 128-bit values use twice as much disk space as 64-bit values and can slow down query execution time. Floating-point types Use the REAL and DOUBLE PRECISION data types to store numeric values with variable precision. These types are inexact types, meaning that some values are stored as approximations, such that storing and returning a speciﬁc value may result in slight discrepancies. If you require exact storage and calculations (such as for monetary amounts), use the DECIMAL data type. REAL represents the single-precision ﬂoating point format, according to the IEEE Standard 754 for Floating-Point Arithmetic. It has a precision of about 6 digits, and a range of around 1E-37 to 1E +37. You can also specify this data type as FLOAT4. Numeric types 13 AWS Clean Rooms SQL Reference DOUBLE PRECISION represents the double-precision ﬂoating point format, according to the IEEE Standard 754 for Binary Floating-Point Arithmetic. It has a precision of about 15 digits, and a range of around 1E-307 to 1E+308. You can also specify this data type as FLOAT or FLOAT8. Computations with numeric values In AWS Clean Rooms, computation refers to binary mathematical operations: addition, subtraction, multiplication, and division. This section describes the expected return types for these operations, as well as the speciﬁc formula that is applied to determine precision and scale when DECIMAL data types are involved. When numeric values are computed during query processing, you might encounter cases where the computation is impossible and the query returns a numeric overﬂow error. You might also encounter cases where the scale of computed values varies or is unexpected. For some operations, you can use explicit casting (type promotion) or AWS Clean Rooms conﬁguration parameters to work around these problems. For information about the results of similar computations with SQL functions, see AWS Clean Rooms SQL functions. Return types for computations Given the set of numeric data types supported in AWS Clean Rooms, the following table shows the expected return types for addition, subtraction, multiplication, and division operations. The ﬁrst column on the left side of the table represents the ﬁrst operand in the calculation, and the top row represents the second operand. Operand 1 Operand 2 Return type SMALLINT or SHORT SMALLINT or SHORT SMALLINT or SHORT SMALLINT or SHORT INTEGER SMALLINT or SHORT BIGINT SMALLINT or SHORT DECIMAL SMALLINT or SHORT SMALLINT or SHORT FLOAT4 FLOAT8 INTEGER BIGINT DECIMAL FLOAT8 FLOAT8 Numeric types 14 AWS Clean Rooms Operand 1 INTEGER INTEGER INTEGER INTEGER INTEGER SQL Reference Operand 2 INTEGER Return type INTEGER BIGINT or LONG BIGINT or LONG DECIMAL FLOAT4 FLOAT8 DECIMAL FLOAT8 FLOAT8 BIGINT or LONG BIGINT or LONG BIGINT or LONG BIGINT or LONG DECIMAL BIGINT or LONG BIGINT or LONG DECIMAL DECIMAL DECIMAL FLOAT4 FLOAT8 FLOAT4 FLOAT8 DECIMAL FLOAT4 FLOAT8 FLOAT8 FLOAT8 DECIMAL FLOAT8 FLOAT8 DECIMAL FLOAT8 FLOAT8 FLOAT8 FLOAT8 Precision and scale of computed DECIMAL results The following table summarizes the rules for computing resulting precision and scale when mathematical operations return DECIMAL results. In this table, p1 and s1 represent the precision and scale of the ﬁrst operand in a calculation. p2 and s2 represent the precision and scale of the second operand. (Regardless of these calculations, the maximum result precision is 38, and the maximum result scale is 38.) Numeric types 15 AWS Clean Rooms SQL Reference Operation Result precision and scale + or - Scale = max(s1,s2) Precision = max(p1-s1,p2-s2)+1+scale * / Scale = s1+s2 Precision = p1+p2+1 Scale = max(4,s1+p2-s2+1) Precision = p1-s1+ s2+scale For example, the PRICEPAID and COMMISSION columns in the SALES table are both DECIMAL(8,2) columns. If you divide PRICEPAID by COMMISSION (or vice versa), the formula is applied as follows: Precision = 8-2 + 2 + max(4,2+8-2+1) = 6 + 2 + 9 = 17 Scale = max(4,2+8-2+1) = 9 Result = DECIMAL(17,9) The following calculation is the general rule for computing the resulting precision and scale for operations performed on DECIMAL values with set operators such as UNION, INTERSECT, and EXCEPT or functions such as COALESCE and DECODE: Scale = max(s1,s2) Precision = min(max(p1-s1,p2-s2)+scale,19) For example, a DEC1 table with one DECIMAL(7,2) column is joined with a DEC2 table with one DECIMAL(15,3) column to create a DEC3 table. The schema of DEC3 shows that the column becomes a NUMERIC(15,3) column. select * from dec1 union select * from dec2; In the above example, the formula is applied as follows: Numeric types 16 AWS Clean Rooms SQL Reference Precision = min(max(7-2,15-3) + max(2,3), 19) = 12 + 3 = 15 Scale = max(2,3) = 3 Result = DECIMAL(15,3) Notes on division operations For division operations, divide-by-zero conditions return errors. The
sql-reference-006	sql-reference.pdf	6	= max(s1,s2) Precision = min(max(p1-s1,p2-s2)+scale,19) For example, a DEC1 table with one DECIMAL(7,2) column is joined with a DEC2 table with one DECIMAL(15,3) column to create a DEC3 table. The schema of DEC3 shows that the column becomes a NUMERIC(15,3) column. select * from dec1 union select * from dec2; In the above example, the formula is applied as follows: Numeric types 16 AWS Clean Rooms SQL Reference Precision = min(max(7-2,15-3) + max(2,3), 19) = 12 + 3 = 15 Scale = max(2,3) = 3 Result = DECIMAL(15,3) Notes on division operations For division operations, divide-by-zero conditions return errors. The scale limit of 100 is applied after the precision and scale are calculated. If the calculated result scale is greater than 100, division results are scaled as follows: • Precision = precision - (scale - max_scale) • Scale = max_scale If the calculated precision is greater than the maximum precision (38), the precision is reduced to 38, and the scale becomes the result of: max(38 + scale - precision), min(4, 100)) Overﬂow conditions Overﬂow is checked for all numeric computations. DECIMAL data with a precision of 19 or less is stored as 64-bit integers. DECIMAL data with a precision that is greater than 19 is stored as 128- bit integers. The maximum precision for all DECIMAL values is 38, and the maximum scale is 37. Overﬂow errors occur when a value exceeds these limits, which apply to both intermediate and ﬁnal result sets: • Explicit casting results in runtime overﬂow errors when speciﬁc data values don't ﬁt the requested precision or scale speciﬁed by the cast function. For example, you can't cast all values from the PRICEPAID column in the SALES table (a DECIMAL(8,2) column) and return a DECIMAL(7,3) result: select pricepaid::decimal(7,3) from sales; ERROR: Numeric data overflow (result precision) This error occurs because some of the larger values in the PRICEPAID column can't be cast. • Multiplication operations produce results in which the result scale is the sum of the scale of each operand. If both operands have a scale of 4, for example, the result scale is 8, leaving only 10 Numeric types 17 AWS Clean Rooms SQL Reference digits for the left side of the decimal point. Therefore, it is relatively easy to run into overﬂow conditions when multiplying two large numbers that both have signiﬁcant scale. Numeric calculations with INTEGER and DECIMAL types When one of the operands in a calculation has an INTEGER data type and the other operand is DECIMAL, the INTEGER operand is implicitly cast as a DECIMAL. • SMALLINT or SHORT is cast as DECIMAL(5,0) • INTEGER is cast as DECIMAL(10,0) • BIGINT or LONG is cast as DECIMAL(19,0) For example, if you multiply SALES.COMMISSION, a DECIMAL(8,2) column, and SALES.QTYSOLD, a SMALLINT column, this calculation is cast as: DECIMAL(8,2) * DECIMAL(5,0) Character types Character data types include CHAR (character) and VARCHAR (character varying). Topics • CHAR or CHARACTER • VARCHAR or CHARACTER VARYING • Signiﬁcance of trailing blanks CHAR or CHARACTER Use a CHAR or CHARACTER column to store ﬁxed-length strings. These strings are padded with blanks, so a CHAR(10) column always occupies 10 bytes of storage. char(10) A CHAR column without a length speciﬁcation results in a CHAR(1) column. Character types 18 AWS Clean Rooms SQL Reference CHAR and VARCHAR data types are deﬁned in terms of bytes, not characters. A CHAR column can only contain single-byte characters, so a CHAR(10) column can contain a string with a maximum length of 10 bytes. Name Storage Range (width of column) CHAR or CHARACTER Length of string, including trailing blanks (if any) 4096 bytes VARCHAR or CHARACTER VARYING Use a VARCHAR or CHARACTER VARYING column to store variable-length strings with a ﬁxed limit. These strings are not padded with blanks, so a VARCHAR(120) column consists of a maximum of 120 single-byte characters, 60 two-byte characters, 40 three-byte characters, or 30 four-byte characters. varchar(120) VARCHAR data types are deﬁned in terms of bytes, not characters. A VARCHAR can contain multibyte characters, up to a maximum of four bytes per character. For example, a VARCHAR(12) column can contain 12 single-byte characters, 6 two-byte characters, 4 three-byte characters, or 3 four-byte characters. Name Storage Range (width of column) VARCHAR or CHARACTER VARYING 65535 bytes (64K -1) 4 bytes + total bytes for character s, where each character can be 1 to 4 bytes. Character types 19 AWS Clean Rooms SQL Reference Signiﬁcance of trailing blanks Both CHAR and VARCHAR data types store strings up to n bytes in length. An attempt to store a longer string into a column of these types results in an error. However, if the extra characters are all spaces (blanks), the string is truncated to the maximum length. If the string is shorter than the maximum length, CHAR values are padded
sql-reference-007	sql-reference.pdf	7	of column) VARCHAR or CHARACTER VARYING 65535 bytes (64K -1) 4 bytes + total bytes for character s, where each character can be 1 to 4 bytes. Character types 19 AWS Clean Rooms SQL Reference Signiﬁcance of trailing blanks Both CHAR and VARCHAR data types store strings up to n bytes in length. An attempt to store a longer string into a column of these types results in an error. However, if the extra characters are all spaces (blanks), the string is truncated to the maximum length. If the string is shorter than the maximum length, CHAR values are padded with blanks, but VARCHAR values store the string without blanks. Trailing blanks in CHAR values are always semantically insigniﬁcant. They are disregarded when you compare two CHAR values, not included in LENGTH calculations, and removed when you convert a CHAR value to another string type. Trailing spaces in VARCHAR and CHAR values are treated as semantically insigniﬁcant when values are compared. Length calculations return the length of VARCHAR character strings with trailing spaces included in the length. Trailing blanks are not counted in the length for ﬁxed-length character strings. Datetime types Datetime data types include DATE, TIME, TIMESTAMP_LTZ, and TIMESTAMP_NTZ. Topics • DATE • TIME • TIMESTAMP_LTZ • TIMESTAMP_NTZ • Examples with datetime types • Date, time, and timestamp literals • Interval literals • Interval data types and literals DATE Use the DATE data type to store simple calendar dates without timestamps. Datetime types 20 AWS Clean Rooms SQL Reference Name Storage Range Resolution DATE 4 bytes 4713 BC to 294276 AD 1 day TIME Use the TIME data type to store the time of day. TIME columns store values with up to a maximum of six digits of precision for fractional seconds. By default, TIME values are Coordinated Universal Time (UTC) in both user tables and AWS Clean Rooms system tables. Name Storage Range Resolution TIME 8 bytes 00:00:00 to 24:00:00 1 microsecond TIMESTAMP_LTZ Use the TIMESTAMP_LTZ data type to store complete timestamp values that include the date, the time of day, and the local time zone. TIMESTAMP represents values comprising values of ﬁelds year, month, day, hour, minute, and second, with the session local timezone. The timestamp value represents an absolute point in time. TIMESTAMP in Spark is a user-speciﬁed alias associated with one of the TIMESTAMP_LTZ and TIMESTAMP_NTZ variations. You can set the default timestamp type as TIMESTAMP_LTZ (default value) or TIMESTAMP_NTZ via the conﬁguration spark.sql.timestampType. TIMESTAMP_NTZ Use the TIMESTAMP_NTZ data type to store complete timestamp values that include the date, the time of day, without the local time zone. TIMESTAMP represents values comprising values of ﬁelds year, month, day, hour, minute, and second. All operations are performed without taking any time zone into account. Datetime types 21 AWS Clean Rooms SQL Reference TIMESTAMP in Spark is a user-speciﬁed alias associated with one of the TIMESTAMP_LTZ and TIMESTAMP_NTZ variations. You can set the default timestamp type as TIMESTAMP_LTZ (default value) or TIMESTAMP_NTZ via the conﬁguration spark.sql.timestampType. Examples with datetime types The following examples show you how to work with datetime types that are supported by AWS Clean Rooms. Date examples The following examples insert dates that have diﬀerent formats and display the output. select * from datetable order by 1; start_date \| end_date ----------------------- 2008-06-01 \| 2008-12-31 2008-06-01 \| 2008-12-31 If you insert a timestamp value into a DATE column, the time portion is ignored and only the date is loaded. Time examples The following examples insert TIME and TIMETZ values that have diﬀerent formats and display the output. select * from timetable order by 1; start_time \| end_time ------------------------ 19:11:19 \| 20:41:19+00 19:11:19 \| 20:41:19+00 Date, time, and timestamp literals Following are rules for working with date, time, and timestamp literals that are supported by AWS Clean Rooms Spark SQL. Datetime types 22 AWS Clean Rooms Dates SQL Reference The following table shows input dates that are valid examples of literal date values that you can load into AWS Clean Rooms tables. The default MDY DateStyle mode is assumed to be in eﬀect. This mode means that the month value precedes the day value in strings such as 1999-01-08 and 01/02/00. Note A date or timestamp literal must be enclosed in quotation marks when you load it into a table. Input date January 8, 1999 1999-01-08 1/8/1999 01/02/00 2000-Jan-31 Jan-31-2000 31-Jan-2000 20080215 080215 2008.366 Times Full date January 8, 1999 January 8, 1999 January 8, 1999 January 2, 2000 January 31, 2000 January 31, 2000 January 31, 2000 February 15, 2008 February 15, 2008 December 31, 2008 (the three-digit part of date must be between 001 and 366) The following table shows input times that are valid examples of literal time values that you can load into AWS Clean Rooms tables. Datetime types 23 AWS Clean
sql-reference-008	sql-reference.pdf	8	literal must be enclosed in quotation marks when you load it into a table. Input date January 8, 1999 1999-01-08 1/8/1999 01/02/00 2000-Jan-31 Jan-31-2000 31-Jan-2000 20080215 080215 2008.366 Times Full date January 8, 1999 January 8, 1999 January 8, 1999 January 2, 2000 January 31, 2000 January 31, 2000 January 31, 2000 February 15, 2008 February 15, 2008 December 31, 2008 (the three-digit part of date must be between 001 and 366) The following table shows input times that are valid examples of literal time values that you can load into AWS Clean Rooms tables. Datetime types 23 AWS Clean Rooms Input times 04:05:06.789 04:05:06 04:05 040506 04:05 AM 04:05 PM 16:05 SQL Reference Description (of time part) 4:05 AM and 6.789 seconds 4:05 AM and 6 seconds 4:05 AM exactly 4:05 AM and 6 seconds 4:05 AM exactly; AM is optional 4:05 PM exactly; the hour value must be less than 12 4:05 PM exactly Special datetime values The following table shows special values that can be used as datetime literals and as arguments to date functions. They require single quotation marks and are converted to regular timestamp values during query processing. Special value now today tomorrow yesterday Description Evaluates to the start time of the current transaction and returns a timestamp with microsecond precision. Evaluates to the appropriate date and returns a timestamp with zeroes for the time parts. Evaluates to the appropriate date and returns a timestamp with zeroes for the time parts. Evaluates to the appropriate date and returns a timestamp with zeroes for the time parts. Datetime types 24 AWS Clean Rooms SQL Reference The following examples show how now and today work with the DATEADD function. select dateadd(day,1,'today'); date_add --------------------- 2009-11-17 00:00:00 (1 row) select dateadd(day,1,'now'); date_add ---------------------------- 2009-11-17 10:45:32.021394 (1 row) Interval literals Following are rules for working with interval literals that are supported by AWS Clean Rooms Spark SQL. Use an interval literal to identify speciﬁc periods of time, such as 12 hours or 6 weeks. You can use these interval literals in conditions and calculations that involve datetime expressions. Note You can't use the INTERVAL data type for columns in AWS Clean Rooms tables. An interval is expressed as a combination of the INTERVAL keyword with a numeric quantity and a supported date part, for example INTERVAL '7 days' or INTERVAL '59 minutes'. You can connect several quantities and units to form a more precise interval, for example: INTERVAL '7 days, 3 hours, 59 minutes'. Abbreviations and plurals of each unit are also supported; for example: 5 s, 5 second, and 5 seconds are equivalent intervals. If you don't specify a date part, the interval value represents seconds. You can specify the quantity value as a fraction (for example: 0.5 days). Examples The following examples show a series of calculations with diﬀerent interval values. Datetime types 25 AWS Clean Rooms SQL Reference The following example adds 1 second to the speciﬁed date. select caldate + interval '1 second' as dateplus from date where caldate='12-31-2008'; dateplus --------------------- 2008-12-31 00:00:01 (1 row) The following example adds 1 minute to the speciﬁed date. select caldate + interval '1 minute' as dateplus from date where caldate='12-31-2008'; dateplus --------------------- 2008-12-31 00:01:00 (1 row) The following example adds 3 hours and 35 minutes to the speciﬁed date. select caldate + interval '3 hours, 35 minutes' as dateplus from date where caldate='12-31-2008'; dateplus --------------------- 2008-12-31 03:35:00 (1 row) The following example adds 52 weeks to the speciﬁed date. select caldate + interval '52 weeks' as dateplus from date where caldate='12-31-2008'; dateplus --------------------- 2009-12-30 00:00:00 (1 row) The following example adds 1 week, 1 hour, 1 minute, and 1 second to the speciﬁed date. select caldate + interval '1w, 1h, 1m, 1s' as dateplus from date where caldate='12-31-2008'; dateplus Datetime types 26 AWS Clean Rooms --------------------- 2009-01-07 01:01:01 (1 row) SQL Reference The following example adds 12 hours (half a day) to the speciﬁed date. select caldate + interval '0.5 days' as dateplus from date where caldate='12-31-2008'; dateplus --------------------- 2008-12-31 12:00:00 (1 row) The following example subtracts 4 months from March 31, 2023 and the result is November 30, 2022. The calculation considers the number of days in a month. select date '2023-03-31' - interval '4 months'; ?column? --------------------- 2022-11-30 00:00:00 Interval data types and literals You can use an interval data type to store durations of time in units such as, seconds, minutes, hours, days, months, and years. Interval data types and literals can be used in datetime calculations, such as, adding intervals to dates and timestamps, summing intervals, and subtracting an interval from a date or timestamp. Interval literals can be used as input values to interval data type columns in a table. Syntax of interval data type To specify an interval data type to store a

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.