本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 管理 Transfer Family 使用的事件 Amazon EventBridge
<a name="eventbridge"></a>

Amazon EventBridge 是一种无服务器服务，它使用事件将应用程序组件连接在一起，这可以使您更轻松地构建可扩展的事件驱动应用程序。 Event-driven 架构是一种构建松散耦合的软件系统的风格，这些软件系统通过发出和响应事件来协同工作。事件代表资源或环境中的变化。

与许多 AWS 服务一样， Transfer Family 生成事件并将其发送到 EventBridge 默认事件总线。请注意，默认事件总线会在每个 AWS 账户中自动配置。事件总线是接收事件并将其传送到零个或多个目的地或*目标*的路由器。您可以为事件总线指定规则，该总线在事件到达时对其进行评估。每条规则都会检查事件是否与规则的*事件模式*相匹配。如果事件匹配，则事件总线将事件发送到一个或多个指定目标。

![AWS 服务将事件发送到 EventBridge 默认事件总线。如果事件与规则的事件模式相匹配，则 EventBridge 将该事件发送到为该规则指定的目标。](https://docs.aws.amazon.com/zh_cn/transfer/latest/userguide/images/eventbridge-integration-how-it-works.png)


**Topics**
+ [Transfer Family events](#supported-events)
+ [正在发送 Transfer Family 使用的事件 EventBridge 规则](#eventbridge-using-events-rules)
+ [Amazon EventBridge 权限](#eventbridge-permissions)
+ [额外 EventBridge 资源](#eventbridge-additonal-resources)
+ [Transfer Family 活动详细信息参考](events-detail-reference.md)

## Transfer Family events
<a name="supported-events"></a>

Transfer Family 自动将事件发送到默认 EventBridge 事件总线。您可以在事件总线上创建规则，其中每条规则都包含一个事件模式和一个或多个目标。

与规则的事件模式相匹配的事件会尽*最大努力*或*持久*地传送到指定的目标（请注意，某些事件可能会出现顺序交付）。这些配送级别在《*亚马逊 EventBridge 活动参考》[中的 AWS 服务事件](https://docs.aws.amazon.com/eventbridge/latest/ref/event-delivery-level.html)配送等级中进行了描述*。
+ Server-level SFTP、FTPS 和 FTP 服务器的活动是在尽最大努力的基础上提供的。
+ SFTP 连接器事件是在持久的基础上传送的。
+ AS2 活动是在持久的基础上举办的。

以下事件由生成 Transfer Family。有关更多信息，请参阅《Amazon EventBridge 用户指南》**中的 [EventBridge 事件](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html)。

### SFTP、FTPS 和 FTP 服务器事件
<a name="supported-events-servers"></a>

下表列出了按事件类型组织的 SFTP、FTPS 和 FTP 服务器的事件。

**文件上传和下载活动 **


| 事件详细信息类型 | 说明 | 
| --- | --- | 
| [FTP 服务器文件下载已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功下载了 FTP 协议的文件。 | 
| [FTP 服务器文件下载失败 ](events-detail-reference.md#event-detail-server-events) | 尝试下载 FTP 协议的文件失败。 | 
| [FTP 服务器文件上传已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功上传 FTP 协议的文件。 | 
| [FTP 服务器文件上传失败 ](events-detail-reference.md#event-detail-server-events) | 尝试上传使用 FTP 协议的文件失败。 | 
| [FTPS 服务器文件下载已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功下载 FTPS 协议的文件。 | 
| [FTPS 服务器文件下载失败 ](events-detail-reference.md#event-detail-server-events) | 尝试下载 FTPS 协议的文件失败。 | 
| [FTPS 服务器文件上传已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功上传 FTPS 协议的文件。 | 
| [FTPS 服务器文件上传失败 ](events-detail-reference.md#event-detail-server-events) | 尝试上传使用 FTPS 协议的文件失败。 | 
| [SFTP 服务器文件下载已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功下载 SFTP 协议的文件。 | 
| [SFTP 服务器文件下载失败 ](events-detail-reference.md#event-detail-server-events) | 尝试下载 SFTP 协议的文件失败。 | 
| [SFTP 服务器文件上传已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功上传 SFTP 协议的文件。 | 
| [SFTP 服务器文件上传失败 ](events-detail-reference.md#event-detail-server-events) | 尝试上传使用 SFTP 协议的文件失败。 | 

**其他文件操作事件 **


| 事件详细信息类型 | 说明 | 
| --- | --- | 
| [FTP 服务器目录创建已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功为 FTP 协议创建了一个目录。 | 
| [创建 FTP 服务器目录失败 ](events-detail-reference.md#event-detail-server-events) | 尝试创建 FTP 协议的目录失败。 | 
| [FTP 服务器目录删除已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功删除 FTP 协议的目录。 | 
| [FTP 服务器目录删除失败 ](events-detail-reference.md#event-detail-server-events) | 尝试删除 FTP 协议的目录失败。 | 
| [FTP 服务器文件删除已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功删除 FTP 协议的文件。 | 
| [FTP 服务器文件删除失败 ](events-detail-reference.md#event-detail-server-events) | 尝试删除 FTP 协议的文件失败。 | 
| [FTP 服务器文件重命名已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功重命名了 FTP 协议的文件。 | 
| [FTP 服务器文件重命名失败 ](events-detail-reference.md#event-detail-server-events) | 尝试重命名 FTP 协议的文件失败。 | 
| [FTPS 服务器目录创建已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功为 FTPS 协议创建了一个目录。 | 
| [FTPS 服务器目录创建失败 ](events-detail-reference.md#event-detail-server-events) | 尝试创建 FTPS 协议的目录失败。 | 
| [FTPS 服务器目录删除已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功删除 FTPS 协议的目录。 | 
| [FTPS 服务器目录删除失败 ](events-detail-reference.md#event-detail-server-events) | 尝试删除 FTPS 协议的目录失败。 | 
| [FTPS 服务器文件删除已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功删除 FTPS 协议的文件。 | 
| [FTPS 服务器文件删除失败 ](events-detail-reference.md#event-detail-server-events) | 尝试删除 FTPS 协议的文件失败。 | 
| [FTPS 服务器文件重命名已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功重命名了 FTPS 协议的文件。 | 
| [FTPS 服务器文件重命名失败 ](events-detail-reference.md#event-detail-server-events) | 尝试重命名 FTPS 协议的文件失败。 | 
| [SFTP 服务器目录创建已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功为 SFTP 协议创建了一个目录。 | 
| [创建 SFTP 服务器目录失败 ](events-detail-reference.md#event-detail-server-events) | 尝试创建 SFTP 协议的目录失败。 | 
| [SFTP 服务器目录删除已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功删除 SFTP 协议的目录。 | 
| [SFTP 服务器目录删除失败 ](events-detail-reference.md#event-detail-server-events) | 尝试删除 SFTP 协议的目录失败。 | 
| [SFTP 服务器文件删除已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功删除 SFTP 协议的文件。 | 
| [SFTP 服务器文件删除失败 ](events-detail-reference.md#event-detail-server-events) | 尝试删除 SFTP 协议的文件失败。 | 
| [SFTP 服务器文件重命名已完成 ](events-detail-reference.md#event-detail-server-events) | 已成功重命名了 SFTP 协议的文件。 | 
| [SFTP 服务器文件重命名失败 ](events-detail-reference.md#event-detail-server-events) | 尝试重命名 SFTP 协议的文件失败。 | 

### SFTP 连接器事件
<a name="supported-events-connectors"></a>

**注意**  
这些事件的交付 EventBridge 级别为持久级别，如*亚马逊 EventBridge 活动参考中的 AWS 服务事件[https://docs.aws.amazon.com/eventbridge/latest/ref/event-delivery-level.html](https://docs.aws.amazon.com/eventbridge/latest/ref/event-delivery-level.html)交付级别中所述*。


| 事件详细信息类型 | 说明 | 
| --- | --- | 
| [SFTP 连接器文件发送已完成 ](events-detail-reference.md#event-detail-sftp-connector-events) | 从连接器到远程 SFTP 服务器的文件传输已成功完成。 | 
| [SFTP 连接器文件发送失败 ](events-detail-reference.md#event-detail-sftp-connector-events) | 从连接器到远程 SFTP 服务器的文件传输失败。 | 
| [SFTP 连接器文件检索已完成 ](events-detail-reference.md#event-detail-sftp-connector-events) | 从远程 SFTP 服务器到连接器的文件传输已成功完成。 | 
| [SFTP 连接器文件检索失败 ](events-detail-reference.md#event-detail-sftp-connector-events) | 从远程 SFTP 服务器到连接器的文件传输失败。 | 
| [SFTP 连接器目录列表已完成 ](events-detail-reference.md#event-detail-sftp-connector-events) | 已成功完成的启动文件目录列表调用。 | 
| [SFTP 连接器目录列表失败 ](events-detail-reference.md#event-detail-sftp-connector-events) | 启动文件目录列表失败。 | 
| [SFTP 连接器远程移动已完成 ](events-detail-reference.md#event-detail-sftp-connector-events) | 已在远程服务器上成功移动或重命名文件或目录。 | 
| [SFTP 连接器远程移动失败 ](events-detail-reference.md#event-detail-sftp-connector-events) | 无法在远程服务器上移动或重命名文件或目录。 | 
| [SFTP 连接器远程删除已完成 ](events-detail-reference.md#event-detail-sftp-connector-events) | 已成功删除远程服务器上的文件或目录。 | 
| [SFTP 连接器远程删除失败 ](events-detail-reference.md#event-detail-sftp-connector-events) | 无法删除远程服务器上的文件或目录。 | 

### AS2 活动
<a name="supported-events-as2"></a>

**注意**  
这些事件的交付 EventBridge 级别为持久级别，如*亚马逊 EventBridge 活动参考中的 AWS 服务事件[https://docs.aws.amazon.com/eventbridge/latest/ref/event-delivery-level.html](https://docs.aws.amazon.com/eventbridge/latest/ref/event-delivery-level.html)交付级别中所述*。


| 事件详细信息类型 | 说明 | 
| --- | --- | 
| [AS2 有效载荷接收已完成 ](events-detail-reference.md#event-detail-as2-server-events) | 已收到 AS2 消息的有效载荷。 | 
| [AS2 负载接收失败 ](events-detail-reference.md#event-detail-as2-server-events) | 尚未收到 AS2 消息的有效载荷。 | 
| [AS2 有效载荷发送已完成 ](events-detail-reference.md#event-detail-as2-server-events) | AS2 消息的有效载荷已成功发送。 | 
| [AS2 有效载荷发送失败 ](events-detail-reference.md#event-detail-as2-server-events) | AS2 消息的有效载荷发送失败。 | 
| [AS2 MDN 接收已完成 ](events-detail-reference.md#event-detail-as2-server-events) | 已收到 AS2 消息的邮件处置通知。 | 
| [AS2 MDN 接收失败 ](events-detail-reference.md#event-detail-as2-server-events) | 尚未收到 AS2 消息的留言处置通知。 | 
| [AS2 MDN 发送已完成 ](events-detail-reference.md#event-detail-as2-server-events) | AS2 消息的留言处置通知已成功发送。 | 
| [AS2 MDN 发送失败 ](events-detail-reference.md#event-detail-as2-server-events) | AS2 消息的邮件处置通知发送失败。 | 

## 正在发送 Transfer Family 使用的事件 EventBridge 规则
<a name="eventbridge-using-events-rules"></a>

如果您希望 EventBridge 默认事件总线向目标发送 Transfer Family 事件，则必须创建一条规则，其中包含与所需事件中的数据相匹配 Transfer Family 的事件模式。

**要捕获 AWS Transfer Family 亚马逊的活动 EventBridge**

1. 登录 AWS 管理控制台 并打开亚马逊 EventBridge 控制台，网址为[https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/)。

1. 在导航窗格中，选择**规则**，然后选择**创建规则**。

1. 输入规则的描述性名称，也可以选择输入描述。

1. 对于**规则类型**，选择带有事件模式的**规则，**然后选择**下一步**。

1. 在 “**事件来源” ** 部分，选择**AWS 活动或 EventBridge 合作伙伴活动**。

1. 在 “**创建方法**” 部分中，选择 “**使用图案表单” **。

1. 在 “**事件模式**” 部分中，提供以下信息。

   1. 对于**事件源**，选择**AWS 服务**。

   1. 要获得**AWS 服务**，请选择 “**转移” **。

   1. 对于**事件类型**，选择要触发规则的 Transfer Family 事件类型。

      根据您的**活动类型**选择，您可能会看到 “**活动类型规范 1**” 部分。

   1. 如果您看到 “**事件类型规范 1” ** 部分，请选择要捕获的特定事件（或选择**任何事件**以捕获所选事件类型的所有事件）。

   1. （可选）使用**事件模式**编辑器为事件详细信息指定过滤器。

   1. 选择**下一步**。

1. 从 “选择目标**” 中的可用选项中选择一个目标**。从以下可用目标中选择。
   + **AWS 服务**。常用的选项包括用于无服务器计算的 Lambda 函数、用于消息处理的 Amazon SQS 队列、用于通知和协调工作流程的 Amazon SNS 主题。 AWS Step Functions 
   + **EventBridge API 目的地**。如果您想将事件发送到外部的 HTTP 终端节点 AWS，则可以使用 API 目标作为目标。
   + **EventBridge 活动巴士**。您可以将事件发送到另一个事件总线，该总线位于同一账户和地区，也可以发送到不同的账户或区域。

     有关创建事件总线规则的全面说明，请参阅《*亚马逊 EventBridge 用户指南》[中的](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule.html)创建对事件做出反应的规则*。

   有关选择目标的帮助，请参阅*亚马逊 EventBridge 用户指南[中的](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule.html#eb-create-rule-target)选择目标*。

1. 为目标配置任何其他选项，然后选择 “**下一步” **。

1. （可选）向规则添加标签，然后选择**下一步**。

1. 在 “**查看并创建” ** 屏幕中，如果一切正常，请选择 “**创建规则” **。

### 为以下对象创建事件模式 Transfer Family events
<a name="eventbridge-using-events-rules-patterns"></a>

将事件 Transfer Family 传送到默认事件总线时， EventBridge 使用为每条规则定义的事件模式来确定是否应将该事件传送到规则的目标。事件模式与所需 Transfer Family 事件中的数据相匹配。每个事件模式都是一个 JSON 对象，其中包含以下内容：
+ 标识发送事件的服务的 `source` 属性。对于 Transfer Family 事件，来源是`aws.transfer`。
+ （可选）包含要匹配的事件类型数组的`detail-type`属性。
+ （可选）包含任何其他要匹配的事件数据的`detail`属性。

例如，以下事件模式与来自的所有事件相匹配 Transfer Family：

```
{
  "source": ["aws.transfer"]
}
```

以下事件模式示例与所有 SFTP 连接器事件相匹配：

```
{
  "source": ["aws.transfer"],
  "detail-type": ["SFTP Connector File Send Completed", "SFTP Connector File Retrieve Completed",
                  "SFTP Connector File Retrieve Failed", "SFTP Connector File Send Failed"]
}
```

以下事件模式示例与所有 Transfer Family 失败事件相匹配：

```
{
  "source": ["aws.transfer"],
  "detail-type": [{"wildcard", "*Failed"}]
}
```

以下事件模式示例与用户{{username}}成功下载的 SFTP 相匹配：

```
{
  "source": ["aws.transfer"],
  "detail-type": ["SFTP Server File Download Completed"],
  "detail": {
    "username": [{{username}}]
  }
}
```

有关写入事件模式的更多信息，请参阅《EventBridge 用户指南》**中的[事件模式](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)。

### 测试事件模式 Transfer Family 中的事件 EventBridge
<a name="eventbridge-using-events-testing"></a>

您可以使用 EventBridge 沙盒快速定义和测试事件模式，而不必完成创建或编辑规则的更广泛过程。使用沙盒，您可以定义事件模式并使用示例事件来确认该模式与所需事件相匹配。 EventBridge 使您可以选择通过直接从沙箱中使用该事件模式来创建新规则。

有关更多信息，请参阅《*EventBridge 用户指南*》[中的使用 EventBridge 沙盒](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-pattern-sandbox.html)测试事件模式。

## Amazon EventBridge 权限
<a name="eventbridge-permissions"></a>

Transfer Family 不需要任何额外的权限即可将事件传送到 Amazon EventBridge。

您指定的目标可能需要特定的权限或配置。有关为目标使用特定服务的更多详细信息，请参阅《Amazon EventBridge 用户指南》**中的 [Amazon EventBridge 目标](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html)。

## 额外 EventBridge 资源
<a name="eventbridge-additonal-resources"></a>

有关如何使用 EventBridge 来处理和管理事件*[的更多信息，请参阅《](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html)*Amazon EventBridge 用户指南》中的以下主题。
+ 有关事件总线工作原理的详细信息，请参阅 [Amazon EventBridge 事件总线](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html)。
+ 有关事件结构的信息，请参阅[事件](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html)。
+ 有关构造事件模式 EventBridge 以便在将事件与规则进行匹配时使用的信息，请参阅[事件模式](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)。
+ 有关创建规则以指定 EventBridge 所处理事件的信息，请参阅[规则](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rules.html)。
+ 有关如何指定向哪些服务或其他目的地 EventBridge 发送匹配事件的信息，请参阅[目标](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html)。