Get Email Channel

pinpoint_get_email_channel

R Documentation

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

Description

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

Usage

pinpoint_get_email_channel(ApplicationId)

Arguments

ApplicationId

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

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$get_email_channel(
  ApplicationId = "string"
)