CreateTrigger
Creates a new trigger.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a AWS Glue Connection, AWS Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
Request Syntax
{
"Actions": [
{
"Arguments": {
"string
" : "string
"
},
"CrawlerName": "string
",
"JobName": "string
",
"NotificationProperty": {
"NotifyDelayAfter": number
},
"SecurityConfiguration": "string
",
"Timeout": number
}
],
"Description": "string
",
"EventBatchingCondition": {
"BatchSize": number
,
"BatchWindow": number
},
"Name": "string
",
"Predicate": {
"Conditions": [
{
"CrawlerName": "string
",
"CrawlState": "string
",
"JobName": "string
",
"LogicalOperator": "string
",
"State": "string
"
}
],
"Logical": "string
"
},
"Schedule": "string
",
"StartOnCreation": boolean
,
"Tags": {
"string
" : "string
"
},
"Type": "string
",
"WorkflowName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Actions
-
The actions initiated by this trigger when it fires.
Type: Array of Action objects
Required: Yes
- Description
-
A description of the new trigger.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- EventBatchingCondition
-
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
Type: EventBatchingCondition object
Required: No
- Name
-
The name of the trigger.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: Yes
- Predicate
-
A predicate to specify when the new trigger should fire.
This field is required when the trigger type is
CONDITIONAL
.Type: Predicate object
Required: No
- Schedule
-
A
cron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *)
.This field is required when the trigger type is SCHEDULED.
Type: String
Required: No
- StartOnCreation
-
Set to
true
to startSCHEDULED
andCONDITIONAL
triggers when created. True is not supported forON_DEMAND
triggers.Type: Boolean
Required: No
- Tags
-
The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- Type
-
The type of the new trigger.
Type: String
Valid Values:
SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT
Required: Yes
- WorkflowName
-
The name of the workflow associated with the trigger.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
Response Syntax
{
"Name": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Name
-
The name of the trigger.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
A resource to be created or added already exists.
HTTP Status Code: 400
- ConcurrentModificationException
-
Two processes are trying to modify a resource simultaneously.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- IdempotentParameterMismatchException
-
The same unique identifier was associated with two different records.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
- ResourceNumberLimitExceededException
-
A resource numerical limit was exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: