BatchGetTriggersCommand

Suggest an Edit

Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers 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, BatchGetTriggersCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, BatchGetTriggersCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // BatchGetTriggersRequest
  TriggerNames: [ // TriggerNameList // required
    "STRING_VALUE",
  ],
};
const command = new BatchGetTriggersCommand(input);
const response = await client.send(command);
// { // BatchGetTriggersResponse
//   Triggers: [ // TriggerList
//     { // 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"),
//       },
//     },
//   ],
//   TriggersNotFound: [ // TriggerNameList
//     "STRING_VALUE",
//   ],
// };

BatchGetTriggersCommand Input

See BatchGetTriggersCommandInput for more details

Parameter
Type
Description
TriggerNames
Required
string[] | undefined

A list of trigger names, which may be the names returned from the ListTriggers operation.

BatchGetTriggersCommand Output

See BatchGetTriggersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Triggers
Trigger[] | undefined

A list of trigger definitions.

TriggersNotFound
string[] | undefined

A list of names of triggers not found.

Throws

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.