

# 连接到 SendGrid
<a name="connecting-to-data-sendgrid"></a>

SendGrid 是一个用于收发交易和营销电子邮件的客户沟通平台。
+ SendGrid 连接器可帮助创建和管理联系人列表，以及创建电子邮件营销活动。
+ SendGrid 让在线企业、非营利组织和其他在线实体能够创建和发送营销电子邮件给大量受众，同时监控受众与这些电子邮件的互动情况。

**Topics**
+ [AWS Glue 支持 SendGrid](sendgrid-support.md)
+ [包含创建和使用连接的 API 操作的策略](sendgrid-configuring-iam-permissions.md)
+ [配置 SendGrid](sendgrid-configuring.md)
+ [配置 SendGrid 连接](sendgrid-configuring-connections.md)
+ [从 SendGrid 实体读取内容](sendgrid-reading-from-entities.md)
+ [SendGrid 连接选项](sendgrid-connection-options.md)
+ [SendGrid 限制](sendgrid-limitations.md)

# AWS Glue 支持 SendGrid
<a name="sendgrid-support"></a>

AWS Glue 对 SendGrid 的支持情况如下：

**是否支持作为来源？**  
是。可以使用 AWS Glue ETL 作业查询 SendGrid 中的数据。

**是否支持作为目标？**  
否。

**支持的 SendGrid API 版本**  
支持以下 SendGrid API 版本：
+ v3

# 包含创建和使用连接的 API 操作的策略
<a name="sendgrid-configuring-iam-permissions"></a>

以下示例策略描述了创建和使用连接所需的 AWS IAM 权限。如果您要创建新角色，请创建包含以下内容的策略：

------
#### [ JSON ]

****  

```
{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "glue:ListConnectionTypes",
        "glue:DescribeConnectionType",
        "glue:RefreshOAuth2Tokens",
        "glue:ListEntities",
        "glue:DescribeEntity"
      ],
      "Resource": "*"
    }
  ]
}
```

------

如果您不想使用上述方法，也可以使用以下托管 IAM 策略：
+ [AWSGlueServiceRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSGlueServiceRole) – 授予对各种 AWS Glue 进程代表您运行所需的资源的访问权限。这些资源包括 AWS Glue、Amazon S3、IAM、CloudWatch Logs 和 Amazon EC2。如果您遵循此策略中指定的资源的命名约定，则 AWS Glue 进程具有所需的权限。此策略通常附加到在定义爬网程序、作业和开发终端节点时指定的角色。
+ [AWSGlueConsoleFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AWSGlueConsoleFullAccess)：当策略所附加到的身份使用 AWS 管理控制台时，授予对 AWS Glue 资源的完全访问权限。如果遵循此策略中指定的资源的命名约定，则用户具有完全控制台功能。此策略通常附加到 AWS Glue 控制台的用户。

# 配置 SendGrid
<a name="sendgrid-configuring"></a>

必须满足以下要求，才能使用 AWS Glue 从 SendGrid 传输数据：

## 最低要求
<a name="sendgrid-configuring-min-requirements"></a>

以下是最低要求：
+ 拥有一个包含 API 密钥的 SendGrid 账户。
+ SendGrid 账户拥有有效许可证的 API 访问权限。

如果满足这些要求，就可以将 AWS Glue 连接到 SendGrid 账户。对于常见连接，无需在 SendGrid 中执行其他操作。

# 配置 SendGrid 连接
<a name="sendgrid-configuring-connections"></a>

SendGrid 支持自定义身份验证。

有关生成自定义身份验证所需 API 密钥的 SendGrid 公共文档，请参阅 [Authentication](https://www.twilio.com/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/authentication)。

要配置 SendGrid 连接，请执行以下操作：

1. 在 AWS Secrets Manager 中，创建一个包含以下详细信息的密钥：

   1. 对于客户管理型关联应用程序，密钥应包含关联应用程序的消费者密钥，且以 `api_key` 为键。

   1. 注意：必须在 AWS Glue 中为连接创建一个密钥。

1. 在 AWS Glue Glue Studio 中，按照以下步骤在**数据连接**下创建连接：

   1. 选择**连接类型**时，请选择 SendGrid。

   1. 提供想要连接到的 SendGrid 实例的 `INSTANCE_URL`。

   1. 选择 AWS Glue 可以代入并有权执行以下操作的 AWS IAM 角色：

------
#### [ JSON ]

****  

      ```
      {
        "Version":"2012-10-17",		 	 	 
        "Statement": [
          {
            "Effect": "Allow",
            "Action": [
              "secretsmanager:DescribeSecret",
              "secretsmanager:GetSecretValue",
              "secretsmanager:PutSecretValue",
              "ec2:CreateNetworkInterface",
              "ec2:DescribeNetworkInterfaces",
              "ec2:DeleteNetworkInterface"
            ],
            "Resource": "*"
          }
        ]
      }
      ```

------

   1. 在 AWS Glue 中选择您要用于此连接的 `secretName`，然后放置令牌。

   1. 如果要使用网络，请选择网络选项。

1. 向与您的 AWS Glue 作业关联的 IAM 角色授予读取 `secretName` 的权限。

# 从 SendGrid 实体读取内容
<a name="sendgrid-reading-from-entities"></a>

**先决条件**

要从中读取内容的 SendGrid 对象。需要 `lists`、`singlesends` 或 `segments` 等对象名称。

**源支持的实体**：


| 实体 | 可以筛选 | 支持限制 | 支持排序依据 | 支持 Select \$1 | 支持分区 | 
| --- | --- | --- | --- | --- | --- | 
| Lists | 否 | 是 | 否 | 是 | 否 | 
| 单次发送 | 支持 | 是 | 否 | 是 | 否 | 
| 营销活动统计数据-自动化 | 支持 | 是 | 否 | 是 | 否 | 
| 营销活动统计数据-单次发送 | 支持 | 是 | 否 | 是 | 否 | 
| Segments | 是 | 否 | 否 | 是 | 否 | 
| 联系人 | 是 | 否 | 否 | 是 | 否 | 
| 类别 | 否 | 否 | 否 | 是 | 否 | 
| 统计信息 | 是 | 否 | 否 | 是 | 否 | 
| 取消订阅组 | 是 | 否 | 否 | 是 | 否 | 

**示例：**

```
sendgrid_read = glueContext.create_dynamic_frame.from_options(
    connection_type="sendgrid",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "lists",
        "API_VERSION": "v3",
        "INSTANCE_URL": "instanceUrl"
    }
```

**SendGrid 实体和字段详细信息**：

具有静态元数据的实体：

[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/glue/latest/dg/sendgrid-reading-from-entities.html)

**注意**  
在连接器的响应中，“结构体”和“列表”数据类型将转换为“字符串”数据类型，“日期时间”数据类型将转换为“时间戳”数据类型。

## 对查询进行分区
<a name="sendgrid-reading-partitioning-queries"></a>

SendGrid 不支持基于筛选条件的分区或基于记录的分区。

# SendGrid 连接选项
<a name="sendgrid-connection-options"></a>

以下是 SendGrid 的连接选项：
+ `ENTITY_NAME`（字符串）：（必填）用于读取。SendGrid 中对象的名称。
+ `API_VERSION`（字符串）：（必填）用于读取。要使用的 SendGrid Rest API 版本。
+ `INSTANCE_URL`（字符串）：（必填）用于读取。有效的 SendGrid 实例 URL。
+ `SELECTED_FIELDS`（列表<字符串>）–默认：empty(SELECT \$1)。用于读取。您想要为对象选择的列。
+ `FILTER_PREDICATE`（字符串）– 默认：空。用于读取。应采用 Spark SQL 格式。
+ `QUERY`（字符串）– 默认：空。用于读取。完整的 Spark SQL 查询。

# SendGrid 限制
<a name="sendgrid-limitations"></a>

以下是 SendGrid 的限制或说明：
+ 仅 `start_date` 字段上的“统计数据”实体和 `event_timestamp` 字段上的“联系人”实体支持增量拉取。
+ 只有“营销活动统计数据（自动化）”、“营销活动统计数据（单次发送）”、“单次发送”和“列表”实体支持分页。
+ 对于“统计数据”实体，`start_date` 是必要的筛选条件参数。
+ 具有受限访问权限的 API 密钥不支持电子邮件 API 和“统计数据”实体的读取权限。使用具有完全访问权限的 API 密钥。有关更多信息，请参阅 [API Overview](https://www.twilio.com/docs/sendgrid/api-reference/api-keys/create-api-keys#api-overview)。