- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
BatchGetWorkflowsCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GlueClient, BatchGetWorkflowsCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, BatchGetWorkflowsCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // BatchGetWorkflowsRequest
Names: [ // WorkflowNames // required
"STRING_VALUE",
],
IncludeGraph: true || false,
};
const command = new BatchGetWorkflowsCommand(input);
const response = await client.send(command);
// { // BatchGetWorkflowsResponse
// Workflows: [ // Workflows
// { // Workflow
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// DefaultRunProperties: { // WorkflowRunProperties
// "<keys>": "STRING_VALUE",
// },
// CreatedOn: new Date("TIMESTAMP"),
// LastModifiedOn: new Date("TIMESTAMP"),
// LastRun: { // WorkflowRun
// Name: "STRING_VALUE",
// WorkflowRunId: "STRING_VALUE",
// PreviousRunId: "STRING_VALUE",
// WorkflowRunProperties: {
// "<keys>": "STRING_VALUE",
// },
// StartedOn: new Date("TIMESTAMP"),
// CompletedOn: new Date("TIMESTAMP"),
// Status: "RUNNING" || "COMPLETED" || "STOPPING" || "STOPPED" || "ERROR",
// ErrorMessage: "STRING_VALUE",
// Statistics: { // WorkflowRunStatistics
// TotalActions: Number("int"),
// TimeoutActions: Number("int"),
// FailedActions: Number("int"),
// StoppedActions: Number("int"),
// SucceededActions: Number("int"),
// RunningActions: Number("int"),
// ErroredActions: Number("int"),
// WaitingActions: Number("int"),
// },
// Graph: { // WorkflowGraph
// Nodes: [ // NodeList
// { // Node
// Type: "CRAWLER" || "JOB" || "TRIGGER",
// Name: "STRING_VALUE",
// UniqueId: "STRING_VALUE",
// TriggerDetails: { // TriggerNodeDetails
// Trigger: { // Trigger
// Name: "STRING_VALUE",
// WorkflowName: "STRING_VALUE",
// Id: "STRING_VALUE",
// Type: "SCHEDULED" || "CONDITIONAL" || "ON_DEMAND" || "EVENT",
// State: "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVATED" || "DEACTIVATING" || "DEACTIVATED" || "DELETING" || "UPDATING",
// Description: "STRING_VALUE",
// Schedule: "STRING_VALUE",
// Actions: [ // ActionList
// { // Action
// JobName: "STRING_VALUE",
// Arguments: { // GenericMap
// "<keys>": "STRING_VALUE",
// },
// Timeout: Number("int"),
// SecurityConfiguration: "STRING_VALUE",
// NotificationProperty: { // NotificationProperty
// NotifyDelayAfter: Number("int"),
// },
// CrawlerName: "STRING_VALUE",
// },
// ],
// Predicate: { // Predicate
// Logical: "AND" || "ANY",
// Conditions: [ // ConditionList
// { // Condition
// LogicalOperator: "EQUALS",
// JobName: "STRING_VALUE",
// State: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT" || "ERROR" || "WAITING" || "EXPIRED",
// CrawlerName: "STRING_VALUE",
// CrawlState: "RUNNING" || "CANCELLING" || "CANCELLED" || "SUCCEEDED" || "FAILED" || "ERROR",
// },
// ],
// },
// EventBatchingCondition: { // EventBatchingCondition
// BatchSize: Number("int"), // required
// BatchWindow: Number("int"),
// },
// },
// },
// JobDetails: { // JobNodeDetails
// JobRuns: [ // JobRunList
// { // JobRun
// Id: "STRING_VALUE",
// Attempt: Number("int"),
// PreviousRunId: "STRING_VALUE",
// TriggerName: "STRING_VALUE",
// JobName: "STRING_VALUE",
// JobMode: "SCRIPT" || "VISUAL" || "NOTEBOOK",
// JobRunQueuingEnabled: true || false,
// StartedOn: new Date("TIMESTAMP"),
// LastModifiedOn: new Date("TIMESTAMP"),
// CompletedOn: new Date("TIMESTAMP"),
// JobRunState: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT" || "ERROR" || "WAITING" || "EXPIRED",
// Arguments: {
// "<keys>": "STRING_VALUE",
// },
// ErrorMessage: "STRING_VALUE",
// PredecessorRuns: [ // PredecessorList
// { // Predecessor
// JobName: "STRING_VALUE",
// RunId: "STRING_VALUE",
// },
// ],
// AllocatedCapacity: Number("int"),
// ExecutionTime: Number("int"),
// Timeout: Number("int"),
// MaxCapacity: Number("double"),
// WorkerType: "Standard" || "G.1X" || "G.2X" || "G.025X" || "G.4X" || "G.8X" || "Z.2X",
// NumberOfWorkers: Number("int"),
// SecurityConfiguration: "STRING_VALUE",
// LogGroupName: "STRING_VALUE",
// NotificationProperty: {
// NotifyDelayAfter: Number("int"),
// },
// GlueVersion: "STRING_VALUE",
// DPUSeconds: Number("double"),
// ExecutionClass: "FLEX" || "STANDARD",
// MaintenanceWindow: "STRING_VALUE",
// ProfileName: "STRING_VALUE",
// StateDetail: "STRING_VALUE",
// },
// ],
// },
// CrawlerDetails: { // CrawlerNodeDetails
// Crawls: [ // CrawlList
// { // Crawl
// State: "RUNNING" || "CANCELLING" || "CANCELLED" || "SUCCEEDED" || "FAILED" || "ERROR",
// StartedOn: new Date("TIMESTAMP"),
// CompletedOn: new Date("TIMESTAMP"),
// ErrorMessage: "STRING_VALUE",
// LogGroup: "STRING_VALUE",
// LogStream: "STRING_VALUE",
// },
// ],
// },
// },
// ],
// Edges: [ // EdgeList
// { // Edge
// SourceId: "STRING_VALUE",
// DestinationId: "STRING_VALUE",
// },
// ],
// },
// StartingEventBatchCondition: { // StartingEventBatchCondition
// BatchSize: Number("int"),
// BatchWindow: Number("int"),
// },
// },
// Graph: {
// Nodes: [
// {
// Type: "CRAWLER" || "JOB" || "TRIGGER",
// Name: "STRING_VALUE",
// UniqueId: "STRING_VALUE",
// TriggerDetails: {
// Trigger: {
// Name: "STRING_VALUE",
// WorkflowName: "STRING_VALUE",
// Id: "STRING_VALUE",
// Type: "SCHEDULED" || "CONDITIONAL" || "ON_DEMAND" || "EVENT",
// State: "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVATED" || "DEACTIVATING" || "DEACTIVATED" || "DELETING" || "UPDATING",
// Description: "STRING_VALUE",
// Schedule: "STRING_VALUE",
// Actions: [
// {
// JobName: "STRING_VALUE",
// Arguments: {
// "<keys>": "STRING_VALUE",
// },
// Timeout: Number("int"),
// SecurityConfiguration: "STRING_VALUE",
// NotificationProperty: {
// NotifyDelayAfter: Number("int"),
// },
// CrawlerName: "STRING_VALUE",
// },
// ],
// Predicate: {
// Logical: "AND" || "ANY",
// Conditions: [
// {
// LogicalOperator: "EQUALS",
// JobName: "STRING_VALUE",
// State: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT" || "ERROR" || "WAITING" || "EXPIRED",
// CrawlerName: "STRING_VALUE",
// CrawlState: "RUNNING" || "CANCELLING" || "CANCELLED" || "SUCCEEDED" || "FAILED" || "ERROR",
// },
// ],
// },
// EventBatchingCondition: {
// BatchSize: Number("int"), // required
// BatchWindow: Number("int"),
// },
// },
// },
// JobDetails: {
// JobRuns: [
// {
// Id: "STRING_VALUE",
// Attempt: Number("int"),
// PreviousRunId: "STRING_VALUE",
// TriggerName: "STRING_VALUE",
// JobName: "STRING_VALUE",
// JobMode: "SCRIPT" || "VISUAL" || "NOTEBOOK",
// JobRunQueuingEnabled: true || false,
// StartedOn: new Date("TIMESTAMP"),
// LastModifiedOn: new Date("TIMESTAMP"),
// CompletedOn: new Date("TIMESTAMP"),
// JobRunState: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT" || "ERROR" || "WAITING" || "EXPIRED",
// Arguments: "<GenericMap>",
// ErrorMessage: "STRING_VALUE",
// PredecessorRuns: [
// {
// JobName: "STRING_VALUE",
// RunId: "STRING_VALUE",
// },
// ],
// AllocatedCapacity: Number("int"),
// ExecutionTime: Number("int"),
// Timeout: Number("int"),
// MaxCapacity: Number("double"),
// WorkerType: "Standard" || "G.1X" || "G.2X" || "G.025X" || "G.4X" || "G.8X" || "Z.2X",
// NumberOfWorkers: Number("int"),
// SecurityConfiguration: "STRING_VALUE",
// LogGroupName: "STRING_VALUE",
// NotificationProperty: "<NotificationProperty>",
// GlueVersion: "STRING_VALUE",
// DPUSeconds: Number("double"),
// ExecutionClass: "FLEX" || "STANDARD",
// MaintenanceWindow: "STRING_VALUE",
// ProfileName: "STRING_VALUE",
// StateDetail: "STRING_VALUE",
// },
// ],
// },
// CrawlerDetails: {
// Crawls: [
// {
// State: "RUNNING" || "CANCELLING" || "CANCELLED" || "SUCCEEDED" || "FAILED" || "ERROR",
// StartedOn: new Date("TIMESTAMP"),
// CompletedOn: new Date("TIMESTAMP"),
// ErrorMessage: "STRING_VALUE",
// LogGroup: "STRING_VALUE",
// LogStream: "STRING_VALUE",
// },
// ],
// },
// },
// ],
// Edges: [
// {
// SourceId: "STRING_VALUE",
// DestinationId: "STRING_VALUE",
// },
// ],
// },
// MaxConcurrentRuns: Number("int"),
// BlueprintDetails: { // BlueprintDetails
// BlueprintName: "STRING_VALUE",
// RunId: "STRING_VALUE",
// },
// },
// ],
// MissingWorkflows: [ // WorkflowNames
// "STRING_VALUE",
// ],
// };
BatchGetWorkflowsCommand Input
See BatchGetWorkflowsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
NamesRequired | string[] | undefined | A list of workflow names, which may be the names returned from the |
IncludeGraph | boolean | undefined | Specifies whether to include a graph when returning the workflow resource metadata. |
BatchGetWorkflowsCommand Output
See BatchGetWorkflowsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
MissingWorkflows | string[] | undefined | A list of names of workflows not found. |
Workflows | Workflow[] | undefined | A list of workflow resource metadata. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | An internal service error occurred. |
| InvalidInputException | client | The input provided was not valid. |
| OperationTimeoutException | client | The operation timed out. |
| GlueServiceException | Base exception class for all service exceptions from Glue service. |