email_monitoring_configurations

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

Overview

Name	email_monitoring_configurations
Type	Resource
Id	aws.workmail.email_monitoring_configurations

Fields

The following fields are returned by SELECT queries:

describe_email_monitoring_configuration

Name	Datatype	Description
log_group_arn	string	The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration. (pattern: <code>arn:aws:logs:[a-z-0-9]*:[0-9]{12}:log-group:([.-_/#A-Za-z0-9]+):*$</code>)
role_arn	string	The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration. (pattern: <code>arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_email_monitoring_configuration	select	region		Describes the current email monitoring configuration for a specified organization.
put_email_monitoring_configuration	replace	region, OrganizationId, LogGroupArn		Creates or updates the email monitoring configuration for a specified organization.
delete_email_monitoring_configuration	delete	region		Deletes the email monitoring configuration for a specified organization.

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_email_monitoring_configuration

Describes the current email monitoring configuration for a specified organization.

SELECT
log_group_arn,
role_arn
FROM aws.workmail.email_monitoring_configurations
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_email_monitoring_configuration

Creates or updates the email monitoring configuration for a specified organization.

REPLACE aws.workmail.email_monitoring_configurations
SET 
OrganizationId = '{{ OrganizationId }}',
RoleArn = '{{ RoleArn }}',
LogGroupArn = '{{ LogGroupArn }}'
WHERE 
region = '{{ region }}' --required
AND OrganizationId = '{{ OrganizationId }}' --required
AND LogGroupArn = '{{ LogGroupArn }}' --required;

DELETE examples

delete_email_monitoring_configuration

Deletes the email monitoring configuration for a specified organization.

DELETE FROM aws.workmail.email_monitoring_configurations
WHERE region = '{{ region }}' --required
;