registration_attachments

Creates, updates, deletes, gets or lists a registration_attachments resource.

Overview

Name	registration_attachments
Type	Resource
Id	aws.pinpoint_sms_voice_v2.registration_attachments

Fields

The following fields are returned by SELECT queries:

describe_registration_attachments

Name	Datatype	Description
attachment_status	string	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.. (UPLOAD_IN_PROGRESS, UPLOAD_COMPLETE, UPLOAD_FAILED, DELETED)
attachment_upload_error_reason	string	A description of why the upload didn't successfully complete. (INTERNAL_ERROR)
attachment_url	string	The URL to the document that's associated with the registration attachment.
created_timestamp	string (date-time)	The time when the registration attachment was created, in UNIX epoch time format.
registration_attachment_arn	string	The Amazon Resource Name (ARN) for the registration attachment.
registration_attachment_id	string	The unique identifier for the registration attachment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_registration_attachments	select	region		Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
create_registration_attachment	insert	region		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.
delete_registration_attachment	delete	region		Permanently delete the specified registration attachment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_registration_attachments

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

SELECT
attachment_status,
attachment_upload_error_reason,
attachment_url,
created_timestamp,
registration_attachment_arn,
registration_attachment_id
FROM aws.pinpoint_sms_voice_v2.registration_attachments
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_registration_attachment

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.

INSERT INTO aws.pinpoint_sms_voice_v2.registration_attachments (
AttachmentBody,
AttachmentUrl,
Tags,
ClientToken,
region
)
SELECT 
'{{ AttachmentBody }}',
'{{ AttachmentUrl }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
attachment_status,
created_timestamp,
registration_attachment_arn,
registration_attachment_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: registration_attachments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registration_attachments resource.
  - name: AttachmentBody
    value: "{{ AttachmentBody }}"
    description: |
      The registration file to upload. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG.
  - name: AttachmentUrl
    value: "{{ AttachmentUrl }}"
    description: |
      Registration files have to be stored in an Amazon S3 bucket. The URI to use when sending is in the format s3://BucketName/FileName.
  - name: Tags
    description: |
      An array of tags (key and value pairs) to associate with the registration attachment.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.

DELETE examples

delete_registration_attachment

Permanently delete the specified registration attachment.

DELETE FROM aws.pinpoint_sms_voice_v2.registration_attachments
WHERE region = '{{ region }}' --required
;