Amazon Glue · JSON Structure

Glue Create Trigger Request Structure

CreateTriggerRequest schema from Amazon Glue API

Type: object Properties: 10 Required: 3
AnalyticsData CatalogData IntegrationData PipelineETLServerless

CreateTriggerRequest is a JSON Structure definition published by Amazon Glue, describing 10 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name WorkflowName Type Schedule Predicate Actions Description StartOnCreation Tags EventBatchingCondition

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-glue/refs/heads/main/json-structure/glue-create-trigger-request-structure.json",
  "name": "CreateTriggerRequest",
  "description": "CreateTriggerRequest schema from Amazon Glue API",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NameString"
        },
        {
          "description": "The name of the trigger."
        }
      ]
    },
    "WorkflowName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NameString"
        },
        {
          "description": "The name of the workflow associated with the trigger."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TriggerType"
        },
        {
          "description": "The type of the new trigger."
        }
      ]
    },
    "Schedule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "<p>A <code>cron</code> expression used to specify the schedule (see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html\">Time-Based Schedules for Jobs and Crawlers</a>. For example, to run something every day at 12:15 UTC, you would specify: <code>cron(15 12 * * ? *)</code>.</p> <p>This field is required when the trigger type is SCHEDULED.</p>"
        }
      ]
    },
    "Predicate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Predicate"
        },
        {
          "description": "<p>A predicate to specify when the new trigger should fire.</p> <p>This field is required when the trigger type is <code>CONDITIONAL</code>.</p>"
        }
      ]
    },
    "Actions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionList"
        },
        {
          "description": "The actions initiated by this trigger when it fires."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DescriptionString"
        },
        {
          "description": "A description of the new trigger."
        }
      ]
    },
    "StartOnCreation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanValue"
        },
        {
          "description": "Set to <code>true</code> to start <code>SCHEDULED</code> and <code>CONDITIONAL</code> triggers when created. True is not supported for <code>ON_DEMAND</code> triggers."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagsMap"
        },
        {
          "description": "The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">Amazon Web Services Tags in Glue</a> in the developer guide. "
        }
      ]
    },
    "EventBatchingCondition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventBatchingCondition"
        },
        {
          "description": "Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires."
        }
      ]
    }
  },
  "required": [
    "Name",
    "Type",
    "Actions"
  ]
}