address_lists

Creates, updates, deletes, gets or lists an address_lists resource.

Overview

Name	address_lists
Type	Resource
Id	aws.mailmanager.address_lists

Fields

The following fields are returned by SELECT queries:

get_address_list

Name	Datatype	Description
address_list_arn	string	The Amazon Resource Name (ARN) of the address list resource.
address_list_id	string	The identifier of the address list resource. (pattern: <code>[a-zA-Z0-9-]+</code>)
address_list_name	string	A user-friendly name for the address list resource. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
created_timestamp	string (date-time)	The date of when then address list was created.
last_updated_timestamp	string (date-time)	The date of when the address list was last updated.

list_address_lists

Name	Datatype	Description
address_list_arn	string	The Amazon Resource Name (ARN) of the address list.
address_list_id	string	The identifier of the address list. (pattern: <code>[a-zA-Z0-9-]+</code>)
address_list_name	string	The user-friendly name of the address list. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
created_timestamp	string (date-time)	The timestamp of when the address list was created.
last_updated_timestamp	string (date-time)	The timestamp of when the address list was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_address_list	select	region		Fetch attributes of an address list.
list_address_lists	select	region		Lists address lists for this account.
register_member_to_address_list	insert	region, AddressListId, Address		Adds a member to an address list.
create_address_list	insert	region, AddressListName		Creates a new address list.
deregister_member_from_address_list	delete	region		Removes a member from an address list.
delete_address_list	delete	region		Deletes an address list.
start_address_list_import_job	exec	region, JobId		Starts an import job for an address list.
stop_address_list_import_job	exec	region, JobId		Stops an ongoing import job for an address list.

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

get_address_list

Fetch attributes of an address list.

SELECT
address_list_arn,
address_list_id,
address_list_name,
created_timestamp,
last_updated_timestamp
FROM aws.mailmanager.address_lists
WHERE region = '{{ region }}' -- required
;

list_address_lists

Lists address lists for this account.

SELECT
address_list_arn,
address_list_id,
address_list_name,
created_timestamp,
last_updated_timestamp
FROM aws.mailmanager.address_lists
WHERE region = '{{ region }}' -- required
;

INSERT examples

register_member_to_address_list

Adds a member to an address list.

INSERT INTO aws.mailmanager.address_lists (
AddressListId,
Address,
region
)
SELECT 
'{{ AddressListId }}' /* required */,
'{{ Address }}' /* required */,
'{{ region }}'
;

create_address_list

Creates a new address list.

INSERT INTO aws.mailmanager.address_lists (
ClientToken,
AddressListName,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ AddressListName }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
address_list_id
;

Manifest

# Description fields are for documentation purposes
- name: address_lists
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the address_lists resource.
  - name: AddressListId
    value: "{{ AddressListId }}"
    description: |
      The unique identifier of the address list where the address should be added.
  - name: Address
    value: "{{ Address }}"
    description: |
      The address to be added to the address list.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that Amazon SES uses to recognize subsequent retries of the same request.
  - name: AddressListName
    value: "{{ AddressListName }}"
    description: |
      A user-friendly name for the address list.
  - name: Tags
    description: |
      The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

deregister_member_from_address_list

Removes a member from an address list.

DELETE FROM aws.mailmanager.address_lists
WHERE region = '{{ region }}' --required
;

delete_address_list

Deletes an address list.

DELETE FROM aws.mailmanager.address_lists
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

start_address_list_import_job

Starts an import job for an address list.

EXEC aws.mailmanager.address_lists.start_address_list_import_job 
@region='{{ region }}' --required 
@@json=
'{
"JobId": "{{ JobId }}"
}'
;

stop_address_list_import_job

Stops an ongoing import job for an address list.

EXEC aws.mailmanager.address_lists.stop_address_list_import_job 
@region='{{ region }}' --required 
@@json=
'{
"JobId": "{{ JobId }}"
}'
;