Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

Use either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned.

post/#X-Amz-Target=PinpointSMSVoiceV2.CreateRegistrationAttachment

Headers

X-Amz-Target'PinpointSMSVoiceV2.CreateRegistrationAttachment' required

Request body

AttachmentBodystring

The registration file to upload. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG.

AttachmentUrlstring

Registration files have to be stored in an Amazon S3 bucket. The URI to use when sending is in the format <code>s3://BucketName/FileName</code>.

ClientTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Response

Success

RegistrationAttachmentArnstring required

The Amazon Resource Name (ARN) for the registration attachment.

RegistrationAttachmentIdstring required

The unique identifier for the registration attachment.

AttachmentStatus'UPLOAD_IN_PROGRESS' | 'UPLOAD_COMPLETE' | 'UPLOAD_FAILED' | 'DELETED' required
<p>The status of the registration attachment. </p> <ul> <li> <p> <code>UPLOAD_IN_PROGRESS</code> The attachment is being uploaded.</p> </li> <li> <p> <code>UPLOAD_COMPLETE</code> The attachment has been uploaded.</p> </li> <li> <p> <code>UPLOAD_FAILED</code> The attachment failed to uploaded.</p> </li> <li> <p> <code>DELETED</code> The attachment has been deleted..</p> </li> </ul>
CreatedTimestampstring date-time required

The time when the registration attachment was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.