import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient"; import type { BatchGetWorkflowsRequest, BatchGetWorkflowsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link BatchGetWorkflowsCommand}. */ export interface BatchGetWorkflowsCommandInput extends BatchGetWorkflowsRequest { } /** * @public * * The output of {@link BatchGetWorkflowsCommand}. */ export interface BatchGetWorkflowsCommandOutput extends BatchGetWorkflowsResponse, __MetadataBearer { } declare const BatchGetWorkflowsCommand_base: { new (input: BatchGetWorkflowsCommandInput): import("@smithy/core/client").CommandImpl; new (input: BatchGetWorkflowsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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 * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { GlueClient, BatchGetWorkflowsCommand } from "@aws-sdk/client-glue"; // ES Modules import * // const { GlueClient, BatchGetWorkflowsCommand } = require("@aws-sdk/client-glue"); // CommonJS import * // import type { GlueClientConfig } from "@aws-sdk/client-glue"; * const config = {}; // type is GlueClientConfig * 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 * // "": "STRING_VALUE", * // }, * // CreatedOn: new Date("TIMESTAMP"), * // LastModifiedOn: new Date("TIMESTAMP"), * // LastRun: { // WorkflowRun * // Name: "STRING_VALUE", * // WorkflowRunId: "STRING_VALUE", * // PreviousRunId: "STRING_VALUE", * // WorkflowRunProperties: { * // "": "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 * // "": "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: { * // "": "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", * // ExecutionRoleSessionPolicy: "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: { * // "": "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: "", * // 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: "", * // GlueVersion: "STRING_VALUE", * // DPUSeconds: Number("double"), * // ExecutionClass: "FLEX" || "STANDARD", * // MaintenanceWindow: "STRING_VALUE", * // ProfileName: "STRING_VALUE", * // StateDetail: "STRING_VALUE", * // ExecutionRoleSessionPolicy: "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", * // ], * // }; * * ``` * * @param BatchGetWorkflowsCommandInput - {@link BatchGetWorkflowsCommandInput} * @returns {@link BatchGetWorkflowsCommandOutput} * @see {@link BatchGetWorkflowsCommandInput} for command's `input` shape. * @see {@link BatchGetWorkflowsCommandOutput} for command's `response` shape. * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. * * @throws {@link InternalServiceException} (server fault) *

An internal service error occurred.

* * @throws {@link InvalidInputException} (client fault) *

The input provided was not valid.

* * @throws {@link OperationTimeoutException} (client fault) *

The operation timed out.

* * @throws {@link GlueServiceException} *

Base exception class for all service exceptions from Glue service.

* * * @public */ export declare class BatchGetWorkflowsCommand extends BatchGetWorkflowsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: BatchGetWorkflowsRequest; output: BatchGetWorkflowsResponse; }; sdk: { input: BatchGetWorkflowsCommandInput; output: BatchGetWorkflowsCommandOutput; }; }; }