AWS SESアクション

このページでは、ワークフロー自動化アクションカタログで利用可能なAWS Simple Email Service（SES）アクションのリファレンスを提供します。これらのアクションを使用して、電子メールテンプレートを作成、更新、取得、削除し、Amazon SESを介して電子メールを送信します。

前提条件

前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。

テンプレートを作成する

アクション識別子はaws.ses.createTemplateです。

Amazon SESで、テンプレート化されたEメールを送信するためのEメールテンプレートを作成します。

重要

textPartまたはhtmlPartの少なくとも1つを指定する必要があります。SESでは、テンプレートの本文コンテンツが少なくとも1つの形式で指定されている必要があります。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。テンプレートが作成されるAWSリージョン。	`us-east-2`
`templateName`	弦	必須。作成するテンプレートの名前。	`WelcomeEmailTemplate`
`subjectPart`	弦	必須。このテンプレートを使用して送信されるメールの件名。 `{{variableName}}` 構文を使用したテンプレート変数をサポートします。	`Welcome to Our Service`
`textPart`	弦	オプション。メール本文のプレーンテキスト版。 `textPart` または `htmlPart` の少なくとも1つを指定する必要があります。	`Hello, welcome aboard.`
`htmlPart`	弦	オプション。 Eメール本文のHTMLバージョン。 `textPart` または `htmlPart` の少なくとも1つを指定する必要があります。	`<h1>Hello</h1><p>Welcome aboard.</p>`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "created", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	create_template boto3リファレンスを参照してください。成功すると空のオブジェクト `{}` を返します。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (AlreadyExistsException) when calling the CreateTemplate operation: Template WelcomeEmailTemplate already exists"`

出力

タイプ

例

response

オブジェクト

create_template boto3リファレンス

を参照してください。成功すると空のオブジェクト

{}

を返します。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (AlreadyExistsException) when calling the CreateTemplate operation: Template WelcomeEmailTemplate already exists"

ワークフローの例

name: create-ses-template
description: 'Create an email template in Amazon SES'
steps:
  - name: createWelcomeTemplate
    type: action
    action: aws.ses.createTemplate
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      templateName: WelcomeEmailTemplate
      subjectPart: "Welcome to Our Service"
      textPart: "Hello, welcome aboard."
      htmlPart: "<h1>Hello</h1><p>Welcome aboard.</p>"
    next: end

テンプレートを更新する

アクション識別子はaws.ses.updateTemplateです。

Amazon SESの既存のメールテンプレートを更新します。テンプレートがすでに存在している必要があります。

重要

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。テンプレートが存在するAWSリージョン。	`us-east-2`
`templateName`	弦	必須。更新するテンプレートの名前。すでに存在している必要があります。	`WelcomeEmailTemplate`
`subjectPart`	弦	必須。更新された件名。 `{{variableName}}` 構文を使用したテンプレート変数をサポートします。	`Welcome to Our Service (Updated)`
`textPart`	弦	オプション。更新されたメール本文のプレーンテキスト版。 `textPart` または `htmlPart` の少なくとも1つを指定する必要があります。	`Hi, thanks again for signing up.`
`htmlPart`	弦	オプション。更新されたEメール本文のHTMLバージョン。 `textPart` または `htmlPart` の少なくとも1つを指定する必要があります。	`<h1>Welcome!</h1><p>Thanks again for signing up.</p>`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "updated", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	update_template boto3リファレンスを参照してください。成功すると空のオブジェクト `{}` を返します。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (TemplateDoesNotExistException) when calling the UpdateTemplate operation: Template (WelcomeEmailTemplate) does not exist"`

出力

タイプ

例

response

オブジェクト

update_template boto3リファレンス

を参照してください。成功すると空のオブジェクト

{}

を返します。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (TemplateDoesNotExistException) when calling the UpdateTemplate operation: Template (WelcomeEmailTemplate) does not exist"

ワークフローの例

name: update-ses-template
description: 'Update an email template in Amazon SES'
steps:
  - name: updateWelcomeTemplate
    type: action
    action: aws.ses.updateTemplate
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      templateName: WelcomeEmailTemplate
      subjectPart: "Welcome to Our Service (Updated)"
      textPart: "Hi, thanks again for signing up."
      htmlPart: "<h1>Welcome!</h1><p>Thanks again for signing up.</p>"
    next: end

テンプレートを削除する

アクション識別子はaws.ses.deleteTemplateです。

Amazon SESからEメールテンプレートを削除します。このアクションはべき等です — 指定されたテンプレートが存在しない場合でも成功します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。テンプレートが存在するAWSリージョン。	`us-east-2`
`templateName`	弦	必須。削除するテンプレートの名前。	`WelcomeEmailTemplate`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "deleted", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	delete_template boto3リファレンスを参照してください。成功すると空のオブジェクト `{}` を返します。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (AccessDenied) when calling the DeleteTemplate operation: User is not authorized to perform ses:DeleteTemplate"`

出力

タイプ

例

response

オブジェクト

delete_template boto3リファレンス

を参照してください。成功すると空のオブジェクト

{}

を返します。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (AccessDenied) when calling the DeleteTemplate operation: User is not authorized to perform ses:DeleteTemplate"

ワークフローの例

name: delete-ses-template
description: 'Delete an email template from Amazon SES'
steps:
  - name: deleteWelcomeTemplate
    type: action
    action: aws.ses.deleteTemplate
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      templateName: WelcomeEmailTemplate
    next: end

テンプレートを取得する

アクション識別子はaws.ses.getTemplateです。

Amazon SESから、件名、プレーンテキスト本文、およびHTML本文を含む既存のEメールテンプレートを取得します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。テンプレートが存在するAWSリージョン。	`us-east-2`
`templateName`	弦	必須。取得するテンプレートの名前。	`WelcomeEmailTemplate`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "template", "expression": ".response.Template"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	get_template boto3リファレンスを参照してください。 `TemplateName` 、 `SubjectPart` 、 `TextPart` 、および `HtmlPart` を持つ `Template` オブジェクトが含まれます。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (TemplateDoesNotExistException) when calling the GetTemplate operation: Template (WelcomeEmailTemplate) does not exist"`

出力

タイプ

例

response

オブジェクト

get_template boto3リファレンス

を参照してください。

TemplateName

、

SubjectPart

、

TextPart

、および

HtmlPart

を持つ

Template

オブジェクトが含まれます。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (TemplateDoesNotExistException) when calling the GetTemplate operation: Template (WelcomeEmailTemplate) does not exist"

ワークフローの例

name: get-ses-template
description: 'Retrieve an email template from Amazon SES'
steps:
  - name: getWelcomeTemplate
    type: action
    action: aws.ses.getTemplate
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      templateName: WelcomeEmailTemplate
      selectors:
        - name: template
          expression: ".response.Template"
    next: end

テンプレートを一覧表示する

アクション識別子はaws.ses.listTemplatesです。

現在のリージョンのAmazon SESアカウントに存在するメールテンプレートを一覧表示します。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。テンプレートを一覧表示するAWSリージョン。	`us-east-2`
`maxItems`	整数	オプション。 1ページあたりに返すテンプレートの最大数。指定できる値は1～100です。デフォルトは10です。	`50`
`nextToken`	弦	オプション。次のページの結果を取得するための、前回のレスポンスのページネーショントークンです。	`some-pagination-token`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "templates", "expression": ".response.TemplatesMetadata"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	list_templates boto3リファレンスを参照してください。 `Name` と `CreatedTimestamp` を持つオブジェクトの `TemplatesMetadata` 配列と、ページネーション用の `NextToken` が含まれます。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (AccessDenied) when calling the ListTemplates operation: User is not authorized to perform ses:ListTemplates"`

出力

タイプ

例

response

オブジェクト

list_templates boto3リファレンス

を参照してください。

Name

と

CreatedTimestamp

を持つオブジェクトの

TemplatesMetadata

配列と、ページネーション用の

NextToken

が含まれます。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (AccessDenied) when calling the ListTemplates operation: User is not authorized to perform ses:ListTemplates"

ワークフローの例

name: list-ses-templates
description: 'List email templates in Amazon SES'
steps:
  - name: listSesTemplates
    type: action
    action: aws.ses.listTemplates
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      maxItems: 50
      selectors:
        - name: templates
          expression: ".response.TemplatesMetadata"
    next: end

メールを送信

アクション識別子はaws.ses.sendEmailです。

Amazon SES経由でEメールを送信します。sourceアドレスは、検証済みのSES IDである必要があります。

重要

toAddresses、ccAddresses、またはbccAddressesのいずれか1つ以上を指定し、かつbodyTextまたはbodyHtmlのいずれか1つ以上を指定する必要があります。3つのアドレスフィールド全体での合計受信者数は50を超えることはできません。すべてのEメールアドレスは7ビットASCIIである必要があります — UnicodeドメインはPunycodeでエンコードされている必要があります。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。 Eメールを送信するAWSリージョン。	`us-east-2`
`source`	弦	必須。送信者のメールアドレス。検証済みのSES IDである必要があります。	`no-reply@example.com`
`subject`	弦	必須。メールの件名。	`Welcome to Our Service`
`toAddresses`	リスト	オプション。 To宛先アドレスのリスト。 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` の少なくとも1つを指定する必要があります。	`["recipient@example.com"]`
`ccAddresses`	リスト	オプション。 CC宛先アドレスのリスト。 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` の少なくとも1つを指定する必要があります。	`["cc@example.com"]`
`bccAddresses`	リスト	オプション。 BCC受信者アドレスのリスト。 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` のいずれか1つ以上を指定する必要があります。	`["bcc@example.com"]`
`bodyText`	弦	オプション。プレーンテキストのEメール本文。 `bodyText` または `bodyHtml` のいずれか1つ以上を指定する必要があります。	`Hi there, thanks for signing up.`
`bodyHtml`	弦	オプション。 HTMLメールの本文。 `bodyText` または `bodyHtml` の少なくとも1つを指定する必要があります。	`<h1>Welcome!</h1><p>Thanks for signing up.</p>`
`subjectCharset`	弦	オプション。件名の文字セット。デフォルトは `UTF-8` です。	`UTF-8`
`bodyTextCharset`	弦	オプション。プレーンテキスト本文の文字セット。デフォルトは `UTF-8` です。	`UTF-8`
`bodyHtmlCharset`	弦	オプション。 HTML本文の文字セット。デフォルトは `UTF-8` です。	`UTF-8`
`replyToAddresses`	リスト	オプション。返信先アドレス。	`["reply-to@example.com"]`
`returnPath`	弦	オプション。バウンスおよび苦情通知のメールアドレス。	`bounces@example.com`
`sourceArn`	弦	オプション。送信承認に使用する検証済みIDのARN。	`arn:aws:ses:us-east-2:123456789012:identity/example.com`
`returnPathArn`	弦	オプション。送信承認のための、 `returnPath` に関連付けられた検証済みIDのARN。	`arn:aws:ses:us-east-2:123456789012:identity/example.com`
`configurationSetName`	弦	オプション。この送信に使用する設定セットの名前。	`my-configuration-set`
`tags`	リスト	オプション。 `{"Name": "...", "Value": "..."}` オブジェクトのリストとしてのメッセージタグ。	`[{"Name": "purpose", "Value": "welcome-email"}]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "messageId", "expression": ".response.MessageId"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	send_email boto3リファレンスを参照してください。成功した場合は `MessageId` 文字列が含まれます。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (MessageRejected) when calling the SendEmail operation: Email address is not verified. The following identities failed the check in region US-EAST-2: sender@example.com"`

出力

タイプ

例

response

オブジェクト

send_email boto3リファレンス

を参照してください。成功した場合は

MessageId

文字列が含まれます。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (MessageRejected) when calling the SendEmail operation: Email address is not verified. The following identities failed the check in region US-EAST-2: sender@example.com"

ワークフローの例

name: send-ses-email
description: 'Send an email through Amazon SES'
steps:
  - name: sendWelcomeEmail
    type: action
    action: aws.ses.sendEmail
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      source: no-reply@example.com
      toAddresses:
        - recipient@example.com
      subject: "Welcome to Our Service"
      bodyText: "Hi there, thanks for signing up."
      bodyHtml: "<h1>Welcome!</h1><p>Thanks for signing up.</p>"
      selectors:
        - name: messageId
          expression: ".response.MessageId"
    next: end

テンプレートメールを送信する

アクション識別子はaws.ses.sendTemplatedEmailです。

既存のAmazon SESテンプレートを使用し、templateDataのプレースホルダー値をテンプレートに代入してEメールを送信します。sourceアドレスと参照されるtemplateがすでに存在している必要があります。

重要

toAddresses、ccAddresses、またはbccAddressesの少なくとも1つを指定する必要があります。3つすべてを省略すると、送信時にAWS APIエラーが発生します。合計宛先数は50を超えることはできず、templateDataは262,144文字を超えることはできません。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。 Eメールを送信するAWSリージョン。	`us-east-2`
`source`	弦	必須。送信者のメールアドレス。検証済みのSES IDである必要があります。	`no-reply@example.com`
`template`	弦	必須。使用するSESテンプレートの名前。すでに存在している必要があります。	`WelcomeEmailTemplate`
`templateData`	弦	必須。テンプレートのプレースホルダーに代入するキーの値のペアのJSON文字列。最大262,144文字。	`{"name": "Alice"}`
`toAddresses`	リスト	オプション。 To宛先アドレスのリスト。 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` の少なくとも1つを指定する必要があります。	`["recipient@example.com"]`
`ccAddresses`	リスト	オプション。 CC宛先アドレスのリスト。 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` の少なくとも1つを指定する必要があります。	`["cc@example.com"]`
`bccAddresses`	リスト	オプション。 BCC受信者アドレスのリスト。 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` のいずれか1つ以上を指定する必要があります。	`["bcc@example.com"]`
`replyToAddresses`	リスト	オプション。返信先アドレス。	`["reply-to@example.com"]`
`returnPath`	弦	オプション。バウンスおよび苦情通知のメールアドレス。	`bounces@example.com`
`sourceArn`	弦	オプション。送信承認に使用する検証済みIDのARN。	`arn:aws:ses:us-east-2:123456789012:identity/example.com`
`returnPathArn`	弦	オプション。送信承認のための、 `returnPath` に関連付けられた検証済みIDのARN。	`arn:aws:ses:us-east-2:123456789012:identity/example.com`
`templateArn`	弦	オプション。 `template` の代替となる、テンプレートのクロスアカウントARN。	`arn:aws:ses:us-east-2:123456789012:template/WelcomeEmailTemplate`
`configurationSetName`	弦	オプション。この送信に使用する設定セットの名前。	`my-configuration-set`
`tags`	リスト	オプション。 `{"Name": "...", "Value": "..."}` オブジェクトのリストとしてのメッセージタグ。	`[{"Name": "purpose", "Value": "welcome-email"}]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "messageId", "expression": ".response.MessageId"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	send_templated_email boto3リファレンスを参照してください。成功した場合は `MessageId` 文字列が含まれます。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (TemplateDoesNotExistException) when calling the SendTemplatedEmail operation: Template (WelcomeEmailTemplate) does not exist"`

出力

タイプ

例

response

オブジェクト

send_templated_email boto3リファレンス

を参照してください。成功した場合は

MessageId

文字列が含まれます。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (TemplateDoesNotExistException) when calling the SendTemplatedEmail operation: Template (WelcomeEmailTemplate) does not exist"

ワークフローの例

name: send-ses-templated-email
description: 'Send a templated email through Amazon SES'
steps:
  - name: sendWelcomeTemplatedEmail
    type: action
    action: aws.ses.sendTemplatedEmail
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      source: no-reply@example.com
      template: WelcomeEmailTemplate
      templateData: '{"name": "Alice"}'
      toAddresses:
        - recipient@example.com
      selectors:
        - name: messageId
          expression: ".response.MessageId"
    next: end

テンプレートメールを一括送信する

アクション識別子はaws.ses.sendBulkTemplatedEmailです。

1回の呼び出しで複数の受信者にテンプレート化されたEメールを送信し、受信者ごとにテンプレートデータを置換します。sourceアドレスと参照されるtemplateはすでに存在している必要があります。

重要

AWSは、このアクションを呼び出しごとに50個のdestinationsエントリに制限しており、宛先ごとに最大50人の受信者（To/Cc/Bccの合計）、生成されるメッセージの最大サイズは10 MBとなります。これらの制限のいずれかを超えると、送信時にAWS APIエラーが発生します。

destinationsの各エントリでは、以下のフィールドを受け付けます：

destination — 必須。toAddresses、ccAddresses、および/またはbccAddresses（それぞれ文字列のリスト）を持つオブジェクト。
replacementTemplateData — オプション。宛先ごとのプレースホルダー値のJSON文字列。この宛先のdefaultTemplateDataを上書きします。
replacementTags — オプション。この受信者のdefaultTagsを上書きする{"name": "...", "value": "..."}オブジェクトのリスト。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。メールを送信するAWSリージョン。	`us-east-2`
`source`	弦	必須。送信者のメールアドレス。検証済みのSES IDである必要があります。	`no-reply@example.com`
`template`	弦	必須。使用するSESテンプレートの名前。すでに存在している必要があります。	`WelcomeEmailTemplate`
`defaultTemplateData`	弦	必須。独自の `replacementTemplateData` を提供しない宛先に使用される、フォールバック・プレースホルダー値のJSON文字列。	`{"name": "Guest"}`
`destinations`	リスト	必須。受信者ごとの宛先オブジェクトのリスト。各エントリには、 `toAddresses` 、 `ccAddresses` 、または `bccAddresses` の少なくとも1つを含む `destination` オブジェクトが必要です。1回の呼び出しにつき最大50エントリ。	`[{"destination": {"toAddresses": ["alice@example.com"]}, "replacementTemplateData": "{\"name\": \"Alice\"}"}]`
`replyToAddresses`	リスト	オプション。すべての宛先に適用される返信先アドレス。	`["support@example.com"]`
`returnPath`	弦	オプション。バウンスおよび苦情通知のメールアドレス。	`bounces@example.com`
`sourceArn`	弦	オプション。送信承認に使用する検証済みIDのARN。	`arn:aws:ses:us-east-2:123456789012:identity/example.com`
`returnPathArn`	弦	オプション。送信承認のための、 `returnPath` に関連付けられた検証済みIDのARN。	`arn:aws:ses:us-east-2:123456789012:identity/example.com`
`templateArn`	弦	オプション。 `template` の代替となる、テンプレートのクロスアカウントARN。	`arn:aws:ses:us-east-2:123456789012:template/WelcomeEmailTemplate`
`configurationSetName`	弦	オプション。この送信に使用する設定セットの名前。	`my-configuration-set`
`defaultTags`	リスト	オプション。 `{"Name": "...", "Value": "..."}` オブジェクトのリストとしてすべての宛先に適用されるデフォルトのメッセージタグ。個々の宛先は、 `replacementTags` を使用してこれらを上書きできます。	`[{"Name": "campaign", "Value": "welcome-series"}]`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "sendStatuses", "expression": ".response.Status"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`response`	オブジェクト	send_bulk_templated_email boto3リファレンスを参照してください。宛先ごとに1つのエントリを持つ `Status` 配列が含まれ、それぞれに `Status` 文字列、オプションの `Error` 、および `MessageId` が含まれます。
`success`	ブール値	`true` または `false`
`errorMessage`	弦	`"An error occurred (TemplateDoesNotExistException) when calling the SendBulkTemplatedEmail operation: Template (WelcomeEmailTemplate) does not exist"`

出力

タイプ

例

response

オブジェクト

send_bulk_templated_email boto3リファレンス

を参照してください。宛先ごとに1つのエントリを持つ

Status

配列が含まれ、それぞれに

Status

文字列、オプションの

Error

、および

MessageId

が含まれます。

success

ブール値

true

または

false

errorMessage

弦

"An error occurred (TemplateDoesNotExistException) when calling the SendBulkTemplatedEmail operation: Template (WelcomeEmailTemplate) does not exist"

ワークフローの例

name: send-ses-bulk-templated-email
description: 'Send bulk templated emails through Amazon SES'
steps:
  - name: sendBulkWelcomeEmail
    type: action
    action: aws.ses.sendBulkTemplatedEmail
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: us-east-2
      source: no-reply@example.com
      template: WelcomeEmailTemplate
      defaultTemplateData: '{"name": "Guest"}'
      destinations:
        - destination:
            toAddresses:
              - alice@example.com
          replacementTemplateData: '{"name": "Alice"}'
        - destination:
            toAddresses:
              - bob@example.com
          replacementTemplateData: '{"name": "Bob"}'
      selectors:
        - name: sendStatuses
          expression: ".response.Status"
    next: end

この機械翻訳は、参考として提供されています。

前提条件.css-21sua1{background:none;border:none;width:0;padding:0;}

テンプレートを作成する

重要

テンプレートを更新する

重要

テンプレートを削除する

テンプレートを取得する

テンプレートを一覧表示する

メールを送信

重要

テンプレートメールを送信する

重要

テンプレートメールを一括送信する

重要

前提条件