Skip to content

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

Description

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

Usage

pinpoint_update_email_channel(ApplicationId, EmailChannelRequest)

Arguments

  • ApplicationId

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

  • EmailChannelRequest

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

Value

A list with the following syntax:

list(
  EmailChannelResponse = list(
    ApplicationId = "string",
    ConfigurationSet = "string",
    CreationDate = "string",
    Enabled = TRUE|FALSE,
    FromAddress = "string",
    HasCredential = TRUE|FALSE,
    Id = "string",
    Identity = "string",
    IsArchived = TRUE|FALSE,
    LastModifiedBy = "string",
    LastModifiedDate = "string",
    MessagesPerSecond = 123,
    Platform = "string",
    RoleArn = "string",
    OrchestrationSendingRoleArn = "string",
    Version = 123
  )
)

Request syntax

svc$update_email_channel(
  ApplicationId = "string",
  EmailChannelRequest = list(
    ConfigurationSet = "string",
    Enabled = TRUE|FALSE,
    FromAddress = "string",
    Identity = "string",
    RoleArn = "string",
    OrchestrationSendingRoleArn = "string"
  )
)