Create Registration Attachment

pinpointsmsvoicev2_create_registration_attachment

R Documentation

Create a new registration attachment to use for uploading a file or a URL to a file¶

Description¶

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.

Usage¶

pinpointsmsvoicev2_create_registration_attachment(AttachmentBody,
  AttachmentUrl, Tags, ClientToken)

Arguments¶

AttachmentBody

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

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⁠.

Tags

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

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.

Value¶

A list with the following syntax:

list(
  RegistrationAttachmentArn = "string",
  RegistrationAttachmentId = "string",
  AttachmentStatus = "UPLOAD_IN_PROGRESS"|"UPLOAD_COMPLETE"|"UPLOAD_FAILED"|"DELETED",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$create_registration_attachment(
  AttachmentBody = raw,
  AttachmentUrl = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string"
)