Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRegistrationAttachment

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.

Request Syntax


{
   "AttachmentBody": blob,
   "AttachmentUrl": "string",
   "ClientToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AttachmentBody

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

Type: Base64-encoded binary data object

Length Constraints: Minimum length of 1. Maximum length of 1572864.

Required: No

AttachmentUrl

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: \S+

Required: No

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

Tags

An array of tags (key and value pairs) to associate with the registration attachment.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "AttachmentStatus": "string",
   "CreatedTimestamp": number,
   "RegistrationAttachmentArn": "string",
   "RegistrationAttachmentId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

AttachmentStatus

The status of the registration attachment.

UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..

Type: String

Valid Values: UPLOAD_IN_PROGRESS | UPLOAD_COMPLETE | UPLOAD_FAILED | DELETED

CreatedTimestamp

The time when the registration attachment was created, in UNIX epoch time format.

Type: Timestamp

RegistrationAttachmentArn

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

Type: String

RegistrationAttachmentId

The unique identifier for the registration attachment.

Type: String

Tags

An array of tags (key and value pairs) to associate with the registration attachment.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400