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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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.
ConfigurationSet -> (string)
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
Enabled -> (boolean)
Specifies whether to enable the email channel for the application.
FromAddress -> (string)
The verified email address that you want to send email from when you send email through the channel.
Identity -> (string)
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
RoleArn -> (string)
The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
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 Amazon SES configuration set that’s applied to messages that are sent through the channel.
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 email is sent 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’s used 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 can be sent 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.