AWS API Changes

2021/12/21 - Amazon WorkMail - 3 new api methods

Changes This release allows customers to change their email monitoring configuration in Amazon WorkMail.

DeleteEmailMonitoringConfiguration (new)

Link ¶

Deletes the email monitoring configuration for a specified organization.

Request Syntax

client.delete_email_monitoring_configuration(
    OrganizationId='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The ID of the organization from which the email monitoring configuration is deleted.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DescribeEmailMonitoringConfiguration (new)

Link ¶

Describes the current email monitoring configuration for a specified organization.

See also: AWS API Documentation

Request Syntax

client.describe_email_monitoring_configuration(
    OrganizationId='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The ID of the organization for which the email monitoring configuration is described.

rtype:

dict

returns:

Response Syntax

{
    'RoleArn': 'string',
    'LogGroupArn': 'string'
}

Response Structure

(dict) --
- RoleArn (string) --
  
  The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
- LogGroupArn (string) --
  
  The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

PutEmailMonitoringConfiguration (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.put_email_monitoring_configuration(
    OrganizationId='string',
    RoleArn='string',
    LogGroupArn='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The ID of the organization for which the email monitoring configuration is set.

type RoleArn:

string

param RoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

type LogGroupArn:

string

param LogGroupArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --