GetTriggerCommand

Suggest an Edit

Retrieves the definition of a trigger.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlueClient, GetTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetTriggerRequest
  Name: "STRING_VALUE", // required
};
const command = new GetTriggerCommand(input);
const response = await client.send(command);
// { // GetTriggerResponse
//   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"),
//     },
//   },
// };

GetTriggerCommand Input

See GetTriggerCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the trigger to retrieve.

GetTriggerCommand Output

See GetTriggerCommandOutput for details

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

The requested trigger definition.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

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.