primary_emails

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

Overview

Name	primary_emails
Type	Resource
Id	aws.account.primary_emails

Fields

The following fields are returned by SELECT queries:

get_primary_email

Name	Datatype	Description
primary_email	string	Retrieves the primary email address associated with the specified account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_primary_email	select	region		Retrieves the primary email address for the specified account.
accept_primary_email_update	exec	region, AccountId, PrimaryEmail, Otp		Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
start_primary_email_update	exec	region, AccountId, PrimaryEmail		Starts the process to update the primary email address for the specified account.

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_primary_email

Retrieves the primary email address for the specified account.

SELECT
primary_email
FROM aws.account.primary_emails
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

accept_primary_email_update

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.

EXEC aws.account.primary_emails.accept_primary_email_update 
@region='{{ region }}' --required 
@@json=
'{
"AccountId": "{{ AccountId }}", 
"PrimaryEmail": "{{ PrimaryEmail }}", 
"Otp": "{{ Otp }}"
}'
;

start_primary_email_update

Starts the process to update the primary email address for the specified account.

EXEC aws.account.primary_emails.start_primary_email_update 
@region='{{ region }}' --required 
@@json=
'{
"AccountId": "{{ AccountId }}", 
"PrimaryEmail": "{{ PrimaryEmail }}"
}'
;