# 工作流程
工作流 API 介绍与在 AWS Glue 中创建、更新或查看工作流相关的数据类型和 API。您可以在 90 天内访问工作流和任务运行的任务运行历史记录。
## 数据类型
+ [JobNodeDetails 结构](#aws-glue-api-workflow-JobNodeDetails)
+ [CrawlerNodeDetails 结构](#aws-glue-api-workflow-CrawlerNodeDetails)
+ [TriggerNodeDetails 结构](#aws-glue-api-workflow-TriggerNodeDetails)
+ [Crawl 结构](#aws-glue-api-workflow-Crawl)
+ [Node 结构](#aws-glue-api-workflow-Node)
+ [Edge 结构](#aws-glue-api-workflow-Edge)
+ [Workflow 结构](#aws-glue-api-workflow-Workflow)
+ [WorkflowGraph 结构](#aws-glue-api-workflow-WorkflowGraph)
+ [WorkflowRun 结构](#aws-glue-api-workflow-WorkflowRun)
+ [WorkflowRunStatistics 结构](#aws-glue-api-workflow-WorkflowRunStatistics)
+ [StartingEventBatchCondition 结构](#aws-glue-api-workflow-StartingEventBatchCondition)
+ [Blueprint 结构](#aws-glue-api-workflow-Blueprint)
+ [BlueprintDetails 结构](#aws-glue-api-workflow-BlueprintDetails)
+ [LastActiveDefinition 结构](#aws-glue-api-workflow-LastActiveDefinition)
+ [BlueprintRun 结构](#aws-glue-api-workflow-BlueprintRun)
## JobNodeDetails 结构
工作流程中展示的作业节点的详细信息。
**字段**
+ `JobRuns` – [JobRun](aws-glue-api-jobs-runs.md#aws-glue-api-jobs-runs-JobRun) 对象的数组。
作业节点表示的作业运行的信息。
## CrawlerNodeDetails 结构
工作流程中存在的爬网程序节点的详细信息。
**字段**
+ `Crawls` – [爬网](#aws-glue-api-workflow-Crawl) 对象的数组。
爬网节点表示的爬网的列表。
## TriggerNodeDetails 结构
工作流程中存在的触发器节点的详细信息。
**字段**
+ `Trigger` – 一个 [触发器](aws-glue-api-jobs-trigger.md#aws-glue-api-jobs-trigger-Trigger) 对象。
触发器节点表示的触发器的信息。
## Crawl 结构
工作流程中的爬网的详细信息。
**字段**
+ `State` – UTF-8 字符串（有效值：`RUNNING` \$1 `CANCELLING` \$1 `CANCELLED` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ERROR`）。
爬网程序的状态。
+ `StartedOn` – 时间戳。
爬网操作的开始日期和时间。
+ `CompletedOn` – 时间戳。
爬网操作的完成日期和时间。
+ `ErrorMessage` – 描述字符串，长度不超过 2048 个字节，与 [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) 匹配。
与爬网关联的错误消息。
+ `LogGroup` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log group string pattern](aws-glue-api-common.md#aws-glue-api-regex-logGroup-id) 匹配。
与爬网关联的日志组。
+ `LogStream` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节，与 [Log-stream string pattern](aws-glue-api-common.md#aws-glue-api-regex-logStream-id) 匹配。
与爬网关联的日志流。
## Node 结构
节点在工作流图表中表示 AWS Glue 组件（触发器、爬网程序或任务）。
**字段**
+ `Type` – UTF-8 字符串（有效值：`CRAWLER` \$1 `JOB` \$1 `TRIGGER`）。
节点表示的 AWS Glue 组件的类型。
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
节点表示的 AWS Glue 组件的名称。
+ `UniqueId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
分配给工作流程中的节点的唯一 ID。
+ `TriggerDetails` – 一个 [TriggerNodeDetails](#aws-glue-api-workflow-TriggerNodeDetails) 对象。
触发器的详细信息（当节点表示触发器时）。
+ `JobDetails` – 一个 [JobNodeDetails](#aws-glue-api-workflow-JobNodeDetails) 对象。
作业的详细信息（当节点表示作业时）。
+ `CrawlerDetails` – 一个 [CrawlerNodeDetails](#aws-glue-api-workflow-CrawlerNodeDetails) 对象。
爬网程序的详细信息（当节点表示爬网程序时）。
## Edge 结构
边缘表示两个 AWS Glue 组件之间的定向连接，这两个组件是边缘所属的工作流的一部分。
**字段**
+ `SourceId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
边缘在其中启动的工作流程中节点的唯一 ID。
+ `DestinationId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
边缘在其中终止的工作流程中节点的唯一 ID。
## Workflow 结构
工作流是为完成复杂 ETL 任务而运行的多个相互依赖的 AWS Glue 任务和爬网程序的集合。工作流管理其所有任务和爬网程序的执行和监控。
**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
工作流的名称。
+ `Description` – UTF-8 字符串。
工作流程的描述。
+ `DefaultRunProperties` – 键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
要用作每个工作流程执行的一部分的属性的集合。运行属性可供工作流中的每个任务使用。任务可以修改工作流中后续任务的属性。
+ `CreatedOn` – 时间戳。
工作流程的创建日期和时间。
+ `LastModifiedOn` – 时间戳。
工作流程的最后修改日期和时间。
+ `LastRun` – 一个 [WorkflowRun](#aws-glue-api-workflow-WorkflowRun) 对象。
有关上次工作流程执行的信息。
+ `Graph` – 一个 [WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph) 对象。
将属于工作流的所有 AWS Glue 组件表示为节点，并将它们之间的定向连接表示为边缘的图表。
+ `CreationStatus` – UTF-8 字符串（有效值：`CREATING` \$1 `CREATED` \$1 `CREATION_FAILED`）。
工作流程的创建状态。
+ `MaxConcurrentRuns` – 数字（整数）。
您可以使用此参数防止系统对数据进行多次不必要的更新，来控制成本，或者在某些情况下，防止系统超过任何组件任务的最大并发运行次数。如果您将此参数留空，则系统对并发工作流运行的次数没有限制。
+ `BlueprintDetails` – 一个 [BlueprintDetails](#aws-glue-api-workflow-BlueprintDetails) 对象。
此结构指示创建此特定工作流的蓝图的详细信息。
## WorkflowGraph 结构
工作流图表表示完整的工作流，其中包含工作流中存在的所有 AWS Glue 组件以及它们之间的所有定向连接。
**字段**
+ `Nodes` – [节点](#aws-glue-api-workflow-Node) 对象的数组。
属于工作流程的表示为节点的 AWS Glue 组件的列表。
+ `Edges` – [Edge](#aws-glue-api-workflow-Edge) 对象的数组。
属于工作流程的节点之间的所有定向连接的列表。
## WorkflowRun 结构
工作流程运行是提供所有运行时信息的工作流程的执行。
**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
已运行的工作流的名称。
+ `WorkflowRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
此工作流程运行的 ID。
+ `PreviousRunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
先前工作流运行的 ID。
+ `WorkflowRunProperties` – 键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
运行期间设置的工作流程运行属性。
+ `StartedOn` – 时间戳。
工作流程运行的开始日期和时间。
+ `CompletedOn` – 时间戳。
工作流程运行的完成日期和时间。
+ `Status` – UTF-8 字符串（有效值：`RUNNING` \$1 `COMPLETED` \$1 `STOPPING` \$1 `STOPPED` \$1 `ERROR`）。
工作流程运行的状态。
+ `ErrorMessage` – UTF-8 字符串。
此错误消息描述了在启动工作流运行时可能发生的任何错误。目前唯一的错误消息是“超过工作流的并发运行：`foo`。”
+ `Statistics` – 一个 [WorkflowRunStatistics](#aws-glue-api-workflow-WorkflowRunStatistics) 对象。
运行的统计数据。
+ `Graph` – 一个 [WorkflowGraph](#aws-glue-api-workflow-WorkflowGraph) 对象。
将属于工作流的所有 AWS Glue 组件表示为节点，并将它们之间的定向连接表示为边缘的图表。
+ `StartingEventBatchCondition` – 一个 [StartingEventBatchCondition](#aws-glue-api-workflow-StartingEventBatchCondition) 对象。
启动工作流运行的批处理条件。
## WorkflowRunStatistics 结构
工作流程运行统计数据提供了有关工作流程运行的统计数据。
**字段**
+ `TotalActions` – 数字（整数）。
工作流程运行中的操作的总数。
+ `TimeoutActions` – 数字（整数）。
超时操作的总数。
+ `FailedActions` – 数字（整数）。
失败操作的总数。
+ `StoppedActions` – 数字（整数）。
已停止操作的总数。
+ `SucceededActions` – 数字（整数）。
成功操作的总数。
+ `RunningActions` – 数字（整数）。
处于正在运行状态的操作的总数。
+ `ErroredActions` – 数字（整数）。
指示工作流运行中处于 ERROR 状态的任务计数。
+ `WaitingActions` – 数字（整数）。
指示工作流运行中处于 WAITING 状态的任务运行计数。
## StartingEventBatchCondition 结构
启动工作流运行的批处理条件。批处理大小中的事件数到达（在这种情况下，BatchSize 成员为非零），或批处理时间已过期（在这种情况下，BatchWindow 成员为非零）。
**字段**
+ `BatchSize` – 数字（整数）。
批处理中的事件数。
+ `BatchWindow` – 数字（整数）。
批处理时间的持续时间，以秒为单位。
## Blueprint 结构
蓝图的详细信息。
**字段**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。
蓝图的描述。
+ `CreatedOn` – 时间戳。
蓝图的注册日期和时间。
+ `LastModifiedOn` – 时间戳。
蓝图的上次修改日期和时间。
+ `ParameterSpec` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。
指示蓝图参数规范列表的 JSON 字符串。
+ `BlueprintLocation` – UTF-8 字符串。
指定 Amazon S3 中发布蓝图的路径。
+ `BlueprintServiceLocation` – UTF-8 字符串。
当您调用 `CreateBlueprint/UpdateBlueprint` 将蓝图注册到 AWS Glue 时，指定 Amazon S3 中复制蓝图的路径。
+ `Status` – UTF-8 字符串（有效值：`CREATING` \$1 `ACTIVE` \$1 `UPDATING` \$1 `FAILED`）。
蓝图注册的状态。
+ 正在创建 – 正在进行蓝图注册。
+ 激活 – 蓝图已成功注册。
+ 正在更新 – 正在更新蓝图注册。
+ 失败 – 蓝图注册失败。
+ `ErrorMessage` – UTF-8 字符串。
错误消息。
+ `LastActiveDefinition` – 一个 [LastActiveDefinition](#aws-glue-api-workflow-LastActiveDefinition) 对象。
如果蓝图有多个版本，且最新版本出现一些错误，则此属性指示该服务可用的最后一个成功的蓝图定义。
## BlueprintDetails 结构
蓝图的详细信息。
**字段**
+ `BlueprintName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
此蓝图的运行 ID。
## LastActiveDefinition 结构
如果蓝图有多个版本，且最新版本出现一些错误，则此属性指示该服务可用的最后一个成功的蓝图定义。
**字段**
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。
蓝图的描述。
+ `LastModifiedOn` – 时间戳。
蓝图的上次修改日期和时间。
+ `ParameterSpec` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。
指定蓝图参数的 JSON 字符串。
+ `BlueprintLocation` – UTF-8 字符串。
指定 Amazon S3 中由 AWS Glue 开发人员发布的蓝图的路径。
+ `BlueprintServiceLocation` – UTF-8 字符串。
当您创建或更新蓝图时，指定 Amazon S3 中复制蓝图的路径。
## BlueprintRun 结构
蓝图运行的详细信息。
**字段**
+ `BlueprintName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
此蓝图运行的运行 ID。
+ `WorkflowName` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
因蓝图运行成功而创建的工作流的名称。如果蓝图运行出现错误，则不会创建工作流。
+ `State` – UTF-8 字符串（有效值：`RUNNING` \$1 `SUCCEEDED` \$1 `FAILED` \$1 `ROLLING_BACK`）。
蓝图运行的状态。可能的值有：
+ 正在运行 – 正在进行蓝图运行。
+ 成功 – 蓝图运行已成功完成。
+ 失败 – 蓝图运行失败，已完成回滚。
+ 回滚 – 蓝图运行失败，正在回滚。
+ `StartedOn` – 时间戳。
蓝图运行的开始日期和时间。
+ `CompletedOn` – 时间戳。
蓝图运行的完成日期和时间。
+ `ErrorMessage` – UTF-8 字符串。
表示运行蓝图时出现的任何错误。
+ `RollbackErrorMessage` – UTF-8 字符串。
如果在创建工作流实体时出现任何错误，我们会尝试回滚至创建实体的该点，然后将实体删除。此属性指示尝试删除创建的实体时出现的错误。
+ `Parameters` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。
以字符串形式显示的蓝图参数。您必须为 `Blueprint$ParameterSpec` 中定义的参数规范所需的每个键提供一个值。
+ `RoleArn` – UTF-8 字符串，不少于 1 个字节或超过 1024 个字节，与 [Custom string pattern #30](aws-glue-api-common.md#regex_30) 匹配。
角色 ARN。此角色将由 AWS Glue 服务代入，并将用于创建工作流和工作流的其他实体。
## 操作
+ [CreateWorkflow 操作（Python：create\$1workflow）](#aws-glue-api-workflow-CreateWorkflow)
+ [UpdateWorkflow 操作（Python：update\$1workflow）](#aws-glue-api-workflow-UpdateWorkflow)
+ [DeleteWorkflow 操作（Python：delete\$1workflow）](#aws-glue-api-workflow-DeleteWorkflow)
+ [GetWorkflow 操作（Python：get\$1workflow）](#aws-glue-api-workflow-GetWorkflow)
+ [ListWorkflows 操作（Python：list\$1workflows）](#aws-glue-api-workflow-ListWorkflows)
+ [BatchGetWorkflows 操作（Python：batch\$1get\$1workflows）](#aws-glue-api-workflow-BatchGetWorkflows)
+ [GetWorkflowRun 操作（Python：get\$1workflow\$1run）](#aws-glue-api-workflow-GetWorkflowRun)
+ [GetWorkflowRuns 操作（Python：get\$1workflow\$1runs）](#aws-glue-api-workflow-GetWorkflowRuns)
+ [GetWorkflowRunProperties 操作（Python：get\$1workflow\$1run\$1properties）](#aws-glue-api-workflow-GetWorkflowRunProperties)
+ [PutWorkflowRunProperties 操作（Python：put\$1workflow\$1run\$1properties）](#aws-glue-api-workflow-PutWorkflowRunProperties)
+ [CreateBlueprint 操作（Python：create\$1blueprint）](#aws-glue-api-workflow-CreateBlueprint)
+ [UpdateBlueprint 操作（Python：update\$1blueprint）](#aws-glue-api-workflow-UpdateBlueprint)
+ [DeleteBlueprint 操作（Python：delete\$1blueprint）](#aws-glue-api-workflow-DeleteBlueprint)
+ [ListBlueprints 操作（Python：list\$1blueprint）](#aws-glue-api-workflow-ListBlueprints)
+ [BatchGetBlueprints 操作（Python：batch\$1get\$1blueprints）](#aws-glue-api-workflow-BatchGetBlueprints)
+ [StartBlueprintRun 操作（Python：start\$1blueprint\$1run）](#aws-glue-api-workflow-StartBlueprintRun)
+ [GetBlueprintRun 操作（Python：get\$1blueprint\$1run）](#aws-glue-api-workflow-GetBlueprintRun)
+ [GetBlueprintRuns 操作（Python：get\$1blueprint\$1runs）](#aws-glue-api-workflow-GetBlueprintRuns)
+ [StartWorkflowRun 操作（Python：start\$1workflow\$1run）](#aws-glue-api-workflow-StartWorkflowRun)
+ [StopWorkflowRun 操作（Python：stop\$1workflow\$1run）](#aws-glue-api-workflow-StopWorkflowRun)
+ [ResumeWorkflowRun 操作（Python：resume\$1workflow\$1run）](#aws-glue-api-workflow-ResumeWorkflowRun)
## CreateWorkflow 操作（Python：create\$1workflow）
创建新的工作流程。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要向工作流程分配的名称。它应在您的账户中是唯一的。
+ `Description` – UTF-8 字符串，长度不超过 12 万个字节。
工作流程的描述。
+ `DefaultRunProperties` – 键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
要用作每个工作流程执行的一部分的属性的集合。
可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。
+ `Tags` – 键值对的映射数组，不超过 50 对。
每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。
每个值是一个 UTF-8 字符串，不超过 256 个字节。
要用于此工作流程的标签。
+ `MaxConcurrentRuns` – 数字（整数）。
您可以使用此参数防止系统对数据进行多次不必要的更新，来控制成本，或者在某些情况下，防止系统超过任何组件任务的最大并发运行次数。如果您将此参数留空，则系统对并发工作流运行的次数没有限制。
**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
作为请求的一部分提供的工作流程的名称。
**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
## UpdateWorkflow 操作（Python：update\$1workflow）
更新现有工作流程。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要更新的工作流程的名称。
+ `Description` – UTF-8 字符串，长度不超过 12 万个字节。
工作流程的描述。
+ `DefaultRunProperties` – 键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
要用作每个工作流程执行的一部分的属性的集合。
可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。
+ `MaxConcurrentRuns` – 数字（整数）。
您可以使用此参数防止系统对数据进行多次不必要的更新，来控制成本，或者在某些情况下，防止系统超过任何组件任务的最大并发运行次数。如果您将此参数留空，则系统对并发工作流运行的次数没有限制。
**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
输入中指定的工作流程的名称。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
## DeleteWorkflow 操作（Python：delete\$1workflow）
删除工作流程。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要删除的工作流程的名称。
**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
输入中指定的工作流程的名称。
**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
## GetWorkflow 操作（Python：get\$1workflow）
检索工作流程的资源元数据。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要检索的工作流程的名称。
+ `IncludeGraph` – 布尔值。
指定在返回工作流程资源元数据时是否包含图表。
**响应**
+ `Workflow` – 一个 [工作流](#aws-glue-api-workflow-Workflow) 对象。
工作流程的资源元数据。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## ListWorkflows 操作（Python：list\$1workflows）
列出账户中创建的工作流程的名称。
**请求**
+ `NextToken` – UTF-8 字符串。
延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 25。
要返回的列表的最大大小。
**响应**
+ `Workflows` – UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。
账户中工作流程的名称的列表。
+ `NextToken` – UTF-8 字符串。
延续令牌（如果尚未返回所有工作流程名称）。
**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## BatchGetWorkflows 操作（Python：batch\$1get\$1workflows）
返回一系列给定工作流程名称的资源元数据列表。调用 `ListWorkflows` 操作后，您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限，包括使用标签的权限条件。
**请求**
+ `Names` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。
触发器名称的列表，这些名称可能是通过 `ListWorkflows` 操作返回的名称。
+ `IncludeGraph` – 布尔值。
指定在返回工作流程资源元数据时是否包含图表。
**响应**
+ `Workflows` – [工作流](#aws-glue-api-workflow-Workflow)对象的数组，不少于 1 个或不超过 25 个结构。
工作流程资源元数据的列表。
+ `MissingWorkflows` – UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。
未找到工作流程名称的列表。
**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
## GetWorkflowRun 操作（Python：get\$1workflow\$1run）
检索给定工作流程运行的元数据。您可以在 90 天内访问工作流和任务运行的任务运行历史记录。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要运行的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
工作流程运行的 ID。
+ `IncludeGraph` – 布尔值。
指定是否在响应中包含工作流程图表。
**响应**
+ `Run` – 一个 [WorkflowRun](#aws-glue-api-workflow-WorkflowRun) 对象。
请求的工作流程运行元数据。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetWorkflowRuns 操作（Python：get\$1workflow\$1runs）
检索给定工作流程的所有运行的元数据。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要返回其运行元数据的工作流程的名称。
+ `IncludeGraph` – 布尔值。
指定是否在响应中包含工作流程图表。
+ `NextToken` – UTF-8 字符串。
响应的最大大小。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。
要包含在响应中的工作流程运行的最大数目。
**响应**
+ `Runs` – [WorkflowRun](#aws-glue-api-workflow-WorkflowRun)对象的数组，不少于 1 个或不超过 1000 个结构。
工作流程运行元数据对象的列表。
+ `NextToken` – UTF-8 字符串。
延续令牌（如果尚未返回所有请求的工作流程运行）。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetWorkflowRunProperties 操作（Python：get\$1workflow\$1run\$1properties）
检索运行期间已测试的工作流程运行属性。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
已运行的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
应返回其运行属性的工作流程运行的 ID。
**响应**
+ `RunProperties` – 键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
指定运行期间已测试的工作流程运行属性。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## PutWorkflowRunProperties 操作（Python：put\$1workflow\$1run\$1properties）
为给定工作流程运行放置指定的工作流程运行属性。如果指定的运行中已存在属性，则重写该值，否则将该属性添加到现有属性。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
已运行的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
应更新其运行属性的工作流程运行的 ID。
+ `RunProperties` – *必填*：键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
为指定的运行放置的属性。
可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。
**响应**
+ *无响应参数。*
**错误**
+ `AlreadyExistsException`
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentModificationException`
## CreateBlueprint 操作（Python：create\$1blueprint）
在 AWS Glue 中注册蓝图。
**请求**
+ `Name` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。
蓝图的描述。
+ `BlueprintLocation` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 8192 个字节，与 [Custom string pattern #32](aws-glue-api-common.md#regex_32) 匹配。
指定 Amazon S3 中发布蓝图的路径。
+ `Tags` – 键值对的映射数组，不超过 50 对。
每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。
每个值是一个 UTF-8 字符串，不超过 256 个字节。
应用于此蓝图的标签。
**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
返回已注册的蓝图的名称。
**错误**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`
## UpdateBlueprint 操作（Python：update\$1blueprint）
更新已注册的蓝图。
**请求**
+ `Name` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `Description` – UTF-8 字符串，长度不少于 1 个字节或超过 512 个字节。
蓝图的描述。
+ `BlueprintLocation` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 8192 个字节，与 [Custom string pattern #32](aws-glue-api-common.md#regex_32) 匹配。
指定 Amazon S3 中发布蓝图的路径。
**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
返回已更新的蓝图的名称。
**错误**
+ `EntityNotFoundException`
+ `ConcurrentModificationException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `IllegalBlueprintStateException`
## DeleteBlueprint 操作（Python：delete\$1blueprint）
删除现有蓝图。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要删除的蓝图的名称。
**响应**
+ `Name` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
返回已删除的蓝图的名称。
**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
## ListBlueprints 操作（Python：list\$1blueprint）
列出账户中的所有蓝图名称。
**请求**
+ `NextToken` – UTF-8 字符串。
延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 25。
要返回的列表的最大大小。
+ `Tags` – 键值对的映射数组，不超过 50 对。
每个键都是一个 UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。
每个值是一个 UTF-8 字符串，不超过 256 个字节。
通过 AWS 资源标签筛选列表。
**响应**
+ `Blueprints` – UTF-8 字符串数组。
账户中蓝图的名称列表。
+ `NextToken` – UTF-8 字符串。
延续令牌（如果所有蓝图名称尚未返回）。
**错误**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## BatchGetBlueprints 操作（Python：batch\$1get\$1blueprints）
检索有关蓝图列表的信息。
**请求**
+ `Names` – *必填：*UTF-8 字符串数组，不少于 1 个或不超过 25 个字符串。
蓝图名称的列表。
+ `IncludeBlueprint` – 布尔值。
指定是否在响应中包含蓝图。
+ `IncludeParameterSpec` – 布尔值。
指定是否在响应中包含蓝图的参数（作为 JSON 字符串）。
**响应**
+ `Blueprints` – [Blueprint](#aws-glue-api-workflow-Blueprint) 对象的数组。
返回作为 `Blueprints` 对象的蓝图列表。
+ `MissingBlueprints` – UTF-8 字符串数组。
返回未找到的 `BlueprintNames`。
**错误**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
## StartBlueprintRun 操作（Python：start\$1blueprint\$1run）
启动指定的蓝图的新运行。
**请求**
+ `BlueprintName` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `Parameters` – UTF-8 字符串，长度不少于 1 个字节或超过 131072 个字节。
指定作为 `BlueprintParameters` 对象的参数。
+ `RoleArn` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 1024 个字节，与 [Custom string pattern #30](aws-glue-api-common.md#regex_30) 匹配。
指定用于创建工作流的 IAM 角色。
**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
此蓝图运行的运行 ID。
**错误**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `ResourceNumberLimitExceededException`
+ `EntityNotFoundException`
+ `IllegalBlueprintStateException`
## GetBlueprintRun 操作（Python：get\$1blueprint\$1run）
检索蓝图运行的详细信息。
**请求**
+ `BlueprintName` – *必填*：UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节，与 [Custom string pattern #31](aws-glue-api-common.md#regex_31) 匹配。
蓝图的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要检索的蓝图运行的运行 ID。
**响应**
+ `BlueprintRun` – 一个 [BlueprintRun](#aws-glue-api-workflow-BlueprintRun) 对象。
返回 `BlueprintRun` 对象。
**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetBlueprintRuns 操作（Python：get\$1blueprint\$1runs）
检索指定蓝图的蓝图运行详细信息。
**请求**
+ `BlueprintName` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
蓝图的名称。
+ `NextToken` – UTF-8 字符串。
延续令牌 (如果这是延续请求)。
+ `MaxResults` – 数字（整数），不小于 1 或大于 1000。
要返回的列表的最大大小。
**响应**
+ `BlueprintRuns` – [BlueprintRun](#aws-glue-api-workflow-BlueprintRun) 对象的数组。
返回 `BlueprintRun` 对象的列表。
+ `NextToken` – UTF-8 字符串。
延续令牌（如果所有请求的蓝图运行尚未返回）。
**错误**
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
## StartWorkflowRun 操作（Python：start\$1workflow\$1run）
启动指定的工作流程的新运行。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要启动的工作流程的名称。
+ `RunProperties` – 键值对的映射数组。
每个键是一个 UTF-8 字符串，不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
每个值是一个 UTF-8 字符串。
新工作流运行的工作流运行属性。
可能会记录运行属性。不要将明文密钥作为属性传递。如果要在工作流运行内使用密钥，请通过 AWS Glue 连接、AWS Secrets Manager 或其他密钥管理机制检索密钥。
**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
新运行的 ID。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `ConcurrentRunsExceededException`
## StopWorkflowRun 操作（Python：stop\$1workflow\$1run）
停止执行指定的工作流程运行。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要停止的工作流程的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要停止的工作流程运行的 ID。
**响应**
+ *无响应参数。*
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `IllegalWorkflowStateException`
## ResumeWorkflowRun 操作（Python：resume\$1workflow\$1run）
重新启动上一个部分完成的工作流运行的选定节点，并恢复工作流运行。然后，所选节点以及这些节点下游的所有节点就会运行。
**请求**
+ `Name` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要检索的工作流的名称。
+ `RunId` – *必填：*UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
要停止的工作流运行的 ID。
+ `NodeIds` – *必填*：UTF-8 字符串数组。
要重新启动的节点的节点 ID 的列表。要重新启动的节点必须在原始运行中尝试运行。
**响应**
+ `RunId` – UTF-8 字符串，长度不少于 1 个字节或超过 255 个字节，与 [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) 匹配。
分配给恢复的工作流运行的新 ID。工作流运行的每个恢复都将有一个新的运行 ID。
+ `NodeIds` – UTF-8 字符串数组。
实际重新启动的节点的节点 ID 列表。
**错误**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentRunsExceededException`
+ `IllegalWorkflowStateException`