Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

update-email-channel

Description

Enables the email channel for an application or updates the status and settings of the email channel for an application.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-email-channel
--application-id <value>
--email-channel-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--email-channel-request (structure)

Specifies the status and settings of the email channel for an application.

Shorthand Syntax:

ConfigurationSet=string,Enabled=boolean,FromAddress=string,Identity=string,RoleArn=string

JSON Syntax:

{
  "ConfigurationSet": "string",
  "Enabled": true|false,
  "FromAddress": "string",
  "Identity": "string",
  "RoleArn": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

EmailChannelResponse -> (structure)

Provides information about the status and settings of the email channel for an application.

ApplicationId -> (string)

The unique identifier for the application that the email channel applies to.

ConfigurationSet -> (string)

The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API .

CreationDate -> (string)

The date and time, in ISO 8601 format, when the email channel was enabled.

Enabled -> (boolean)

Specifies whether the email channel is enabled for the application.

FromAddress -> (string)

The verified email address that you send email from when you send email through the channel.

HasCredential -> (boolean)

(Not used) This property is retained only for backward compatibility.

Id -> (string)

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

Identity -> (string)

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.

IsArchived -> (boolean)

Specifies whether the email channel is archived.

LastModifiedBy -> (string)

The user who last modified the email channel.

LastModifiedDate -> (string)

The date and time, in ISO 8601 format, when the email channel was last modified.

MessagesPerSecond -> (integer)

The maximum number of emails that you can send through the channel each second.

Platform -> (string)

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

RoleArn -> (string)

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

Version -> (integer)

The current version of the email channel.