本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Triggers
触发器 API 介绍与在 AWS Glue 中创建、更新或删除以及启动和停止作业触发器相关的数据类型和 API。
数据类型
Trigger 结构
有关特定触发器的信息。
Fields
-
Name
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.触发器的名称。
-
WorkflowName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.与触发器关联的工作流程的名称。
-
Id
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.留待将来使用。
-
Type
– UTF-8字符串(有效值:SCHEDULED
|内测CONDITIONAL
|内测ON_DEMAND
)。触发器的类型。
-
State
– UTF-8字符串(有效值:CREATING
|内测CREATED
|内测ACTIVATING
|内测ACTIVATED
|内测DEACTIVATING
|内测DEACTIVATED
|内测DELETING
|内测UPDATING
)。触发器的当前状态。
-
Description
– 描述字符串,长度不超过2048字节,匹配 URI address multi-line string pattern.此触发器的描述。
-
用于指定计划的
cron
表达式 (请参阅用于作业和爬网程序的基于时间的计划)。例如,要每天在12:15UTC运行某个项目,您应指定:cron(15 12 * * ? *)
. -
Actions
– 一系列 Action 对象。通过此触发器发起的操作。
-
Predicate
– 一个 谓词 对象。此触发器的谓词,用于定义触发器将在何时触发。
TriggerUpdate结构
提供用于更新触发器的信息的结构。此对象通过完全覆盖以前的触发器定义来更新以前的触发器定义。
Fields
-
Name
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.留待将来使用。
-
Description
– 描述字符串,长度不超过2048字节,匹配 URI address multi-line string pattern.此触发器的描述。
-
用于指定计划的
cron
表达式 (请参阅用于作业和爬网程序的基于时间的计划)。例如,要每天在12:15UTC运行某个项目,您应指定:cron(15 12 * * ? *)
. -
Actions
– 一系列 Action 对象。通过此触发器发起的操作。
-
Predicate
– 一个 谓词 对象。此触发器的谓词,用于定义触发器将在何时触发。
Predicate 结构
定义触发器的谓词,确定触发器何时触发。
Fields
-
Logical
– UTF-8字符串(有效值:AND
|内测ANY
)。如果只列出了一个条件,则为可选字段。如果列出了多个条件,则此字段为必需字段。
-
Conditions
– 一系列 Condition 对象。确定触发器将何时触发的条件列表。
Condition 结构
定义触发器将触发的条件。
Fields
-
LogicalOperator
– UTF-8字符串(有效值:EQUALS
)。一个逻辑运算符。
-
JobName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.此条件应用于其
JobRuns
并且此触发器在其上等待的作业的名称。 -
State
– UTF-8字符串(有效值:STARTING
|内测RUNNING
|内测STOPPING
|内测STOPPED
|内测SUCCEEDED
|内测FAILED
|内测TIMEOUT
)。条件状态。目前,触发器可以侦听的唯一作业状态是
SUCCEEDED
,STOPPED
,FAILED
,和TIMEOUT
。触发器可以侦听的唯一爬网状态是SUCCEEDED
,FAILED
,和CANCELLED
. -
CrawlerName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.此条件应用于的爬网程序的名称。
-
CrawlState
– UTF-8字符串(有效值:RUNNING
|内测CANCELLING
|内测CANCELLED
|内测SUCCEEDED
|内测FAILED
)。此条件应用于的爬网程序的状态。
操作结构
定义触发器发起的操作。
Fields
-
JobName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要执行的作业的名称。
-
每个键是一个 UTF-8 字符串。
每个值是一个 UTF-8 字符串。
此触发器触发时使用的作业参数。对于此作业运行,它们会替换作业定义本身中的默认参数集。
您可以在此处指定您自己的作业执行脚本使用的参数以及 AWS Glue 本身使用的参数。
有关如何指定和使用自己的作业参数的信息,请参阅 呼叫AWS胶水 APIs 蟒蛇皮 开发者指南中的主题。
有关 AWS Glue 用于设置作业的键-值对的信息,请参阅开发人员指南中的由 AWS Glue 使用的特殊参数主题。
-
JobRun
超时(分钟) 这是作业运行在终止并进入TIMEOUT
状态前可以使用资源的最长时间。默认值为 2880 分钟 (48 小时)。此值会覆盖父作业中设置的超时值。 -
SecurityConfiguration
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.该操作将使用的
SecurityConfiguration
结构的名称。 -
NotificationProperty
– 一个 NotificationProperty 对象。指定作业运行通知的配置属性。
-
CrawlerName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要用于此操作的爬网程序的名称。
Operations
CreateTrigger 操作(Python:create_trigger)
创建新的触发器。
Request
-
Name
– 必填: UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.触发器的名称。
-
WorkflowName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.与触发器关联的工作流程的名称。
-
Type
– 必填: UTF-8字符串(有效值:SCHEDULED
|内测CONDITIONAL
|内测ON_DEMAND
)。新触发器的类型。
-
用于指定计划的
cron
表达式 (请参阅用于作业和爬网程序的基于时间的计划)。例如,要每天在12:15UTC运行某个项目,您应指定:cron(15 12 * * ? *)
.当触发类型为 SCHEDULED 时,此字段为必需字段。
-
Predicate
– 一个 谓词 对象。指定新的触发器应何时触发的谓词。
当触发类型为
CONDITIONAL
时,此字段为必需字段。 -
Actions
– 必填: Action 对象数组。触发器触发时所发起的操作。
-
Description
– 描述字符串,长度不超过2048字节,匹配 URI address multi-line string pattern.新触发器的描述。
-
设置
true
为,可在创建时开启SCHEDULED
和CONDITIONAL
触发器。ON_DEMAND
触发器不支持 True。 -
每个键都是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。
每个值是一个 UTF-8 字符串,不超过 256 个字节。
要用于此触发器的标签。您可以使用标签来限制对触发器的访问。有关 AWS Glue 中的标签的更多信息,请参阅开发人员指南中的 AWS Glue 中的 AWS 标签。
Response
-
Name
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.触发器的名称。
Errors
-
AlreadyExistsException
-
EntityNotFoundException
-
InvalidInputException
-
IdempotentParameterMismatchException
-
InternalServiceException
-
OperationTimeoutException
-
ResourceNumberLimitExceededException
-
ConcurrentModificationException
StartTrigger 操作(Python:start_trigger)
启动现有触发器。请参阅触发作业了解有关如何启动不同类型的触发器的信息。
Request
-
Name
– 必填: UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要启动的触发器名称。
Response
-
Name
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.已启动的触发器名称。
Errors
-
InvalidInputException
-
InternalServiceException
-
EntityNotFoundException
-
OperationTimeoutException
-
ResourceNumberLimitExceededException
-
ConcurrentRunsExceededException
GetTrigger 操作(Python:get_trigger)
检索触发器的定义。
Request
-
Name
– 必填: UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要检索的触发器名称。
Response
-
Trigger
– 一个 触发器 对象。请求的触发器定义。
Errors
-
EntityNotFoundException
-
InvalidInputException
-
InternalServiceException
-
OperationTimeoutException
GetTriggers 操作(Python:get_triggers)
获取与一个作业关联的所有触发器。
Request
-
延续标记 (如果这是延续调用)。
-
DependentJobName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要为其检索触发器的作业的名称。返回可以启动此作业的触发器,如果没有这样的触发器,则返回所有触发器。
-
MaxResults
– 数字(整数),不低于1或大于1000。响应的最大大小。
Response
-
Triggers
– 一系列 触发器 对象。指定作业的触发器列表。
-
延续令牌 (如果尚未返回所有请求的触发器)。
Errors
-
EntityNotFoundException
-
InvalidInputException
-
InternalServiceException
-
OperationTimeoutException
UpdateTrigger 操作(Python:update_trigger)
更新触发器定义。
Request
-
Name
– 必填: UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要更新的触发器的名称。
-
TriggerUpdate
– 必填: 一个 TriggerUpdate 对象。用来更新触发器的新值。
Response
-
Trigger
– 一个 触发器 对象。生成的触发器定义。
Errors
-
InvalidInputException
-
InternalServiceException
-
EntityNotFoundException
-
OperationTimeoutException
-
ConcurrentModificationException
StopTrigger 操作(Python:stop_trigger)
停止指定的触发器。
Request
-
Name
– 必填: UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要停止的触发器名称。
Response
-
Name
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.已停止的触发器名称。
Errors
-
InvalidInputException
-
InternalServiceException
-
EntityNotFoundException
-
OperationTimeoutException
-
ConcurrentModificationException
DeleteTrigger 操作(Python:delete_trigger)
删除指定的触发器。未找到该触发器不会引发异常。
Request
-
Name
– 必填: UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要删除的触发器的名称。
Response
-
Name
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.已删除的触发器的名称。
Errors
-
InvalidInputException
-
InternalServiceException
-
OperationTimeoutException
-
ConcurrentModificationException
ListTriggers 操作(Python:list_triggers)
检索此 AWS 账户中所有触发器资源的名称或带指定标签的资源。此操作可让您查看您账户中可用的资源及其名称。
此操作采用可选的 Tags
字段,您可以将其用作响应的筛选器,以便将标记的资源作为一个组进行检索。如果您选择使用标签筛选,则仅检索带标签的资源。
Request
-
延续令牌 (如果这是延续请求)。
-
DependentJobName
– UTF-8字符串,长度不少于1或255字节,匹配 Single-line string pattern.要为其检索触发器的作业的名称。返回可启动此作业的触发器。如果没有这样的触发器,则返回所有触发器。
-
MaxResults
– 数字(整数),不低于1或大于1000。要返回的列表的最大大小。
-
每个键都是一个 UTF-8 字符串,长度不少于 1 个字节或超过 128 个字节。
每个值是一个 UTF-8 字符串,不超过 256 个字节。
指定仅返回这些标记的资源。
Response
Errors
-
EntityNotFoundException
-
InvalidInputException
-
InternalServiceException
-
OperationTimeoutException
BatchGetTriggers 操作(Python:batch_get_triggers)
返回给定触发器名称列表的资源元数据的列表。在调用 ListTriggers
操作后,您可以调用此操作来访问您有权访问的数据。此操作支持所有 IAM 权限,包括使用标签的权限条件。
Response
-
Triggers
– 一系列 触发器 对象。触发器定义的列表。
-
TriggersNotFound
– 一串UTF-8字符串。未找到触发器名称的列表。
Errors
-
InternalServiceException
-
OperationTimeoutException
-
InvalidInputException