Esta página fornece uma referência para as ações do AWS Simple Email Service (SES) disponíveis no catálogo de ações de automação de fluxo de trabalho. Use estas ações para criar, atualizar, recuperar e excluir modelos de e-mail e para enviar e-mails pelo Amazon SES.
Pré-requisitos
Para pré-requisitos e configuração de credenciais, consulte Configurar credenciais da AWS.
Criar um modelo
O identificador da ação é aws.ses.createTemplate.
Cria um modelo de e-mail no Amazon SES para o envio de e-mails com modelo.
Importante
Pelo menos um de textPart ou htmlPart deve ser fornecido. O SES exige que o modelo tenha conteúdo de corpo em pelo menos um formato.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS onde o modelo será criado. |
|
| Corda | Obrigatório. Nome do modelo a ser criado. |
|
| Corda | Obrigatório. Linha de assunto para e-mails enviados com este modelo. Oferece suporte a variáveis de modelo usando a sintaxe
. |
|
| Corda | Opcional. Versão em texto simples do corpo do e-mail. Pelo menos um entre
ou
deve ser fornecido. |
|
| Corda | Opcional. Versão em HTML do corpo do e-mail. Pelo menos um entre
ou
deve ser fornecido. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para create_template . Retorna um objeto vazio
em caso de sucesso. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: create-ses-templatedescription: '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: endAtualizar um modelo
O identificador da ação é aws.ses.updateTemplate.
Atualiza um modelo de e-mail existente no Amazon SES. O modelo já deve existir.
Importante
Pelo menos um de textPart ou htmlPart deve ser fornecido. O SES exige que o modelo tenha conteúdo de corpo em pelo menos um formato.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS onde o modelo existe. |
|
| Corda | Obrigatório. Nome do modelo a ser atualizado. Já deve existir. |
|
| Corda | Obrigatório. Linha de assunto atualizada. Oferece suporte a variáveis de modelo usando a sintaxe
. |
|
| Corda | Opcional. Versão em texto simples atualizada do corpo do e-mail. Pelo menos um entre
ou
deve ser fornecido. |
|
| Corda | Opcional. Versão em HTML atualizada do corpo do e-mail. Pelo menos um entre
ou
deve ser fornecido. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para update_template . Retorna um objeto vazio
em caso de sucesso. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: update-ses-templatedescription: '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: endExcluir um modelo
O identificador da ação é aws.ses.deleteTemplate.
Exclui um modelo de e-mail do Amazon SES. Esta ação é idempotente — ela é bem-sucedida mesmo se o modelo nomeado não existir.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS onde o modelo existe. |
|
| Corda | Obrigatório. Nome do modelo a ser excluído. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para delete_template . Retorna um objeto vazio
em caso de sucesso. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: delete-ses-templatedescription: '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: endObter um modelo
O identificador da ação é aws.ses.getTemplate.
Recupera um modelo de e-mail existente do Amazon SES, incluindo seu assunto, corpo em texto simples e corpo em HTML.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS onde o modelo existe. |
|
| Corda | Obrigatório. Nome do modelo a ser recuperado. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para get_template . Contém um objeto
com
,
,
e
. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: get-ses-templatedescription: '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: endListar modelos
O identificador da ação é aws.ses.listTemplates.
Lista os modelos de e-mail presentes na sua conta do Amazon SES na região atual.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS da qual listar os modelos. |
|
| Inteiro | Opcional. Número máximo de modelos a serem retornados por página. Deve estar entre 1 e 100. O padrão é 10. |
|
| Corda | Opcional. Token de paginação de uma resposta anterior para recuperar a próxima página de resultados. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para list_templates . Contém uma matriz
de objetos com
e
, além de um
para paginação. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: list-ses-templatesdescription: '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: endEnviar um e-mail
O identificador da ação é aws.ses.sendEmail.
Envia um e-mail pelo Amazon SES. O endereço source deve ser uma identidade verificada do SES.
Importante
Pelo menos um entre toAddresses, ccAddresses ou bccAddresses deve ser fornecido, e pelo menos um entre bodyText ou bodyHtml deve ser fornecido. A contagem combinada de destinatários em todos os três campos de endereço não pode exceder 50. Todos os endereços de e-mail devem ser ASCII de 7 bits — os domínios Unicode devem ser codificados em Punycode.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS a partir da qual o e-mail será enviado. |
|
| Corda | Obrigatório. Endereço de e-mail do remetente. Deve ser uma identidade verificada do SES. |
|
| Corda | Obrigatório. Linha de assunto do e-mail. |
|
| Lista | Opcional. Lista de endereços de destinatários Para. Pelo menos um entre
,
ou
deve ser fornecido. |
|
| Lista | Opcional. Lista de endereços de destinatários CC. Pelo menos um entre
,
ou
deve ser fornecido. |
|
| Lista | Opcional. Lista de endereços de destinatários Cco. Pelo menos um de
,
ou
deve ser fornecido. |
|
| Corda | Opcional. Corpo do e-mail em texto simples. Pelo menos um entre
ou
deve ser fornecido. |
|
| Corda | Opcional. Corpo do e-mail em HTML. Pelo menos um entre
ou
deve ser fornecido. |
|
| Corda | Opcional. Conjunto de caracteres para o assunto. O padrão é
. |
|
| Corda | Opcional. Conjunto de caracteres para o corpo em texto simples. O padrão é
. |
|
| Corda | Opcional. Conjunto de caracteres para o corpo em HTML. O padrão é
. |
|
| Lista | Opcional. Endereços de resposta. |
|
| Corda | Opcional. Endereço de e-mail para notificações de devolução e reclamação. |
|
| Corda | Opcional. ARN de uma identidade verificada a ser usada para autorização de envio. |
|
| Corda | Opcional. ARN de uma identidade verificada associada a
, para autorização de envio. |
|
| Corda | Opcional. Nome de um conjunto de configuração a ser usado para este envio. |
|
| Lista | Opcional. Tags de mensagem como uma lista de objetos
. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para send_email . Contém uma string
em caso de sucesso. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: send-ses-emaildescription: '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: endEnviar um e-mail com modelo
O identificador da ação é aws.ses.sendTemplatedEmail.
Envia um e-mail usando um modelo existente do Amazon SES, substituindo os valores de espaço reservado de templateData no modelo. O endereço source e o template referenciado já devem existir.
Importante
Pelo menos um entre toAddresses, ccAddresses ou bccAddresses deve ser fornecido. Omitir todos os três resulta em um erro da API da AWS no momento do envio. A contagem combinada de destinatários não pode exceder 50, e templateData não pode exceder 262.144 caracteres.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS a partir da qual o e-mail será enviado. |
|
| Corda | Obrigatório. Endereço de e-mail do remetente. Deve ser uma identidade verificada do SES. |
|
| Corda | Obrigatório. Nome do modelo do SES a ser usado. Já deve existir. |
|
| Corda | Obrigatório. String JSON de pares de valor principal para substituir nos espaços reservados do modelo. Máximo de 262.144 caracteres. |
|
| Lista | Opcional. Lista de endereços de destinatários Para. Pelo menos um entre
,
ou
deve ser fornecido. |
|
| Lista | Opcional. Lista de endereços de destinatários CC. Pelo menos um entre
,
ou
deve ser fornecido. |
|
| Lista | Opcional. Lista de endereços de destinatários Cco. Pelo menos um de
,
ou
deve ser fornecido. |
|
| Lista | Opcional. Endereços de resposta. |
|
| Corda | Opcional. Endereço de e-mail para notificações de devolução e reclamação. |
|
| Corda | Opcional. ARN de uma identidade verificada a ser usada para autorização de envio. |
|
| Corda | Opcional. ARN de uma identidade verificada associada a
, para autorização de envio. |
|
| Corda | Opcional. ARN de conta cruzada do modelo, como uma alternativa a
. |
|
| Corda | Opcional. Nome de um conjunto de configuração a ser usado para este envio. |
|
| Lista | Opcional. Tags de mensagem como uma lista de objetos
. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para send_templated_email . Contém uma string
em caso de sucesso. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: send-ses-templated-emaildescription: '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: endEnviar e-mails em massa com modelo
O identificador da ação é aws.ses.sendBulkTemplatedEmail.
Envia um e-mail com modelo para vários destinatários em uma única chamada, com substituição de dados do modelo por destinatário. O endereço source e o template referenciado já devem existir.
Importante
A AWS limita esta ação a 50 entradas destinations por chamada, com até 50 destinatários (combinando Para/Cc/Cco) por destino e um tamanho máximo de mensagem gerada de 10 MB. Exceder qualquer um desses limites produz um erro de API da AWS no momento do envio.
Cada entrada em destinations aceita os seguintes campos:
destination— Obrigatório. Objeto comtoAddresses,ccAddressese/oubccAddresses(cada um sendo uma lista de strings).replacementTemplateData— Opcional. String JSON de valores de espaço reservado por destinatário. SubstituidefaultTemplateDatapara este destinatário.replacementTags— Opcional. Lista de objetos{"name": "...", "value": "..."}que substituemdefaultTagspara este destinatário.
A tabela a seguir descreve os campos de entrada para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
| Corda | Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS. |
|
| Corda | Opcional. ID da chave de acesso da AWS. Passe como um segredo. |
|
| Corda | Opcional. Chave de acesso secreta da AWS. Passe como um segredo. |
|
| Corda | Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo. |
|
| Corda | Obrigatório. Região da AWS de onde enviar os e-mails. |
|
| Corda | Obrigatório. Endereço de e-mail do remetente. Deve ser uma identidade verificada do SES. |
|
| Corda | Obrigatório. Nome do modelo do SES a ser usado. Já deve existir. |
|
| Corda | Obrigatório. String JSON de valores de espaço reservado de fallback usados para qualquer destino que não forneça seu próprio
. |
|
| Lista | Obrigatório. Lista de objetos de destino por destinatário. Cada entrada exige um objeto
com pelo menos um de
,
ou
. Até 50 entradas por chamada. |
|
| Lista | Opcional. Endereços de resposta aplicados a todos os destinos. |
|
| Corda | Opcional. Endereço de e-mail para notificações de devolução e reclamação. |
|
| Corda | Opcional. ARN de uma identidade verificada a ser usada para autorização de envio. |
|
| Corda | Opcional. ARN de uma identidade verificada associada a
, para autorização de envio. |
|
| Corda | Opcional. ARN de conta cruzada do modelo, como uma alternativa a
. |
|
| Corda | Opcional. Nome de um conjunto de configuração a ser usado para este envio. |
|
| Lista | Opcional. Tags de mensagem padrão aplicadas a todos os destinos como uma lista de objetos
. Destinos individuais podem sobrescrevê-los com
. |
|
| Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve os campos de saída para esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Objeto | Consulte a referência do boto3 para send_bulk_templated_email . Contém uma matriz
com uma entrada por destino, cada uma com uma string
,
opcional e
. |
| Boleano |
ou
|
| Corda |
|
Exemplo de fluxo de trabalho
name: send-ses-bulk-templated-emaildescription: '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