Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTrigger

Retrieves the definition of a trigger.

Request Syntax


{
   "Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the trigger to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "Trigger": { 
      "Actions": [ 
         { 
            "Arguments": { 
               "string" : "string" 
            },
            "CrawlerName": "string",
            "JobName": "string",
            "NotificationProperty": { 
               "NotifyDelayAfter": number
            },
            "SecurityConfiguration": "string",
            "Timeout": number
         }
      ],
      "Description": "string",
      "EventBatchingCondition": { 
         "BatchSize": number,
         "BatchWindow": number
      },
      "Id": "string",
      "Name": "string",
      "Predicate": { 
         "Conditions": [ 
            { 
               "CrawlerName": "string",
               "CrawlState": "string",
               "JobName": "string",
               "LogicalOperator": "string",
               "State": "string"
            }
         ],
         "Logical": "string"
      },
      "Schedule": "string",
      "State": "string",
      "Type": "string",
      "WorkflowName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Trigger

The requested trigger definition.

Type: Trigger object

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400