Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAutomationRules

A list of automation rules and their metadata for the calling account.

Request Syntax


GET /automationrules/list?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of rules to return in the response. This currently ranges from 1 to 100.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

A token to specify where to start paginating the response. This is the NextToken from a previously truncated response. On your first call to the ListAutomationRules API, set the value of this parameter to NULL.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AutomationRulesMetadata": [ 
      { 
         "CreatedAt": "string",
         "CreatedBy": "string",
         "Description": "string",
         "IsTerminal": boolean,
         "RuleArn": "string",
         "RuleName": "string",
         "RuleOrder": number,
         "RuleStatus": "string",
         "UpdatedAt": "string"
      }
   ],
   "NextToken": "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.

AutomationRulesMetadata

Metadata for rules in the calling account. The response includes rules with a RuleStatus of ENABLED and DISABLED.

Type: Array of AutomationRulesMetadata objects

NextToken

A pagination token for the response.

Type: String

Errors

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

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

InternalException

Internal server error.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

InvalidInputException

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429