BatchGetWorkflows
Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Request Syntax
{
"IncludeGraph": boolean,
"Names": [ "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.
- IncludeGraph
-
Specifies whether to include a graph when returning the workflow resource metadata.
Type: Boolean
Required: No
- Names
-
A list of workflow names, which may be the names returned from the
ListWorkflowsoperation.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
Response Syntax
{
"MissingWorkflows": [ "string" ],
"Workflows": [
{
"BlueprintDetails": {
"BlueprintName": "string",
"RunId": "string"
},
"CreatedOn": number,
"DefaultRunProperties": {
"string" : "string"
},
"Description": "string",
"Graph": {
"Edges": [
{
"DestinationId": "string",
"SourceId": "string"
}
],
"Nodes": [
{
"CrawlerDetails": {
"Crawls": [
{
"CompletedOn": number,
"ErrorMessage": "string",
"LogGroup": "string",
"LogStream": "string",
"StartedOn": number,
"State": "string"
}
]
},
"JobDetails": {
"JobRuns": [
{
"AllocatedCapacity": number,
"Arguments": {
"string" : "string"
},
"Attempt": number,
"CompletedOn": number,
"DPUSeconds": number,
"ErrorMessage": "string",
"ExecutionClass": "string",
"ExecutionTime": number,
"GlueVersion": "string",
"Id": "string",
"JobMode": "string",
"JobName": "string",
"JobRunQueuingEnabled": boolean,
"JobRunState": "string",
"LastModifiedOn": number,
"LogGroupName": "string",
"MaintenanceWindow": "string",
"MaxCapacity": number,
"NotificationProperty": {
"NotifyDelayAfter": number
},
"NumberOfWorkers": number,
"PredecessorRuns": [
{
"JobName": "string",
"RunId": "string"
}
],
"PreviousRunId": "string",
"ProfileName": "string",
"SecurityConfiguration": "string",
"StartedOn": number,
"StateDetail": "string",
"Timeout": number,
"TriggerName": "string",
"WorkerType": "string"
}
]
},
"Name": "string",
"TriggerDetails": {
"Trigger": {
"Actions": [
{
"Arguments": {
"string" : "string"
},
"CrawlerName": "string",
"JobName": "string",
"NotificationProperty": {
"NotifyDelayAfter": number
},
"SecurityConfiguration": "string",
"Timeout": number
}
],
"Description": "string",
"EventBatchingCondition": {
"BatchSize": number,
"BatchWindow": number
},
"Id": "string",
"Name": "string",
"Predicate": {
"Conditions": [
{
"CrawlerName": "string",
"CrawlState": "string",
"JobName": "string",
"LogicalOperator": "string",
"State": "string"
}
],
"Logical": "string"
},
"Schedule": "string",
"State": "string",
"Type": "string",
"WorkflowName": "string"
}
},
"Type": "string",
"UniqueId": "string"
}
]
},
"LastModifiedOn": number,
"LastRun": {
"CompletedOn": number,
"ErrorMessage": "string",
"Graph": {
"Edges": [
{
"DestinationId": "string",
"SourceId": "string"
}
],
"Nodes": [
{
"CrawlerDetails": {
"Crawls": [
{
"CompletedOn": number,
"ErrorMessage": "string",
"LogGroup": "string",
"LogStream": "string",
"StartedOn": number,
"State": "string"
}
]
},
"JobDetails": {
"JobRuns": [
{
"AllocatedCapacity": number,
"Arguments": {
"string" : "string"
},
"Attempt": number,
"CompletedOn": number,
"DPUSeconds": number,
"ErrorMessage": "string",
"ExecutionClass": "string",
"ExecutionTime": number,
"GlueVersion": "string",
"Id": "string",
"JobMode": "string",
"JobName": "string",
"JobRunQueuingEnabled": boolean,
"JobRunState": "string",
"LastModifiedOn": number,
"LogGroupName": "string",
"MaintenanceWindow": "string",
"MaxCapacity": number,
"NotificationProperty": {
"NotifyDelayAfter": number
},
"NumberOfWorkers": number,
"PredecessorRuns": [
{
"JobName": "string",
"RunId": "string"
}
],
"PreviousRunId": "string",
"ProfileName": "string",
"SecurityConfiguration": "string",
"StartedOn": number,
"StateDetail": "string",
"Timeout": number,
"TriggerName": "string",
"WorkerType": "string"
}
]
},
"Name": "string",
"TriggerDetails": {
"Trigger": {
"Actions": [
{
"Arguments": {
"string" : "string"
},
"CrawlerName": "string",
"JobName": "string",
"NotificationProperty": {
"NotifyDelayAfter": number
},
"SecurityConfiguration": "string",
"Timeout": number
}
],
"Description": "string",
"EventBatchingCondition": {
"BatchSize": number,
"BatchWindow": number
},
"Id": "string",
"Name": "string",
"Predicate": {
"Conditions": [
{
"CrawlerName": "string",
"CrawlState": "string",
"JobName": "string",
"LogicalOperator": "string",
"State": "string"
}
],
"Logical": "string"
},
"Schedule": "string",
"State": "string",
"Type": "string",
"WorkflowName": "string"
}
},
"Type": "string",
"UniqueId": "string"
}
]
},
"Name": "string",
"PreviousRunId": "string",
"StartedOn": number,
"StartingEventBatchCondition": {
"BatchSize": number,
"BatchWindow": number
},
"Statistics": {
"ErroredActions": number,
"FailedActions": number,
"RunningActions": number,
"StoppedActions": number,
"SucceededActions": number,
"TimeoutActions": number,
"TotalActions": number,
"WaitingActions": number
},
"Status": "string",
"WorkflowRunId": "string",
"WorkflowRunProperties": {
"string" : "string"
}
},
"MaxConcurrentRuns": number,
"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.
- MissingWorkflows
-
A list of names of workflows not found.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]* - Workflows
-
A list of workflow resource metadata.
Type: Array of Workflow objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
