Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAutomationRules

Lists the automation rules that match specified filters.

Request Syntax


{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "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.

filters

The filters to apply to the list of automation rules.

Type: Array of Filter objects

Required: No

maxResults

The maximum number of automation rules to return in a single response. Valid range is 1-1000.

Type: Integer

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

Required: No

nextToken

A token used for pagination to retrieve the next set of results when the response is truncated.

Type: String

Pattern: [A-Za-z0-9+/=]+

Required: No

Response Syntax


{
   "automationRules": [ 
      { 
         "accountId": "string",
         "createdTimestamp": number,
         "description": "string",
         "lastUpdatedTimestamp": number,
         "name": "string",
         "organizationConfiguration": { 
            "accountIds": [ "string" ],
            "ruleApplyOrder": "string"
         },
         "priority": "string",
         "recommendedActionTypes": [ "string" ],
         "ruleArn": "string",
         "ruleId": "string",
         "ruleRevision": number,
         "ruleType": "string",
         "schedule": { 
            "executionWindowInMinutes": number,
            "scheduleExpression": "string",
            "scheduleExpressionTimezone": "string"
         },
         "status": "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.

automationRules

The list of automation rules that match the specified criteria.

Type: Array of AutomationRule objects

nextToken

A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.

Type: String

Pattern: [A-Za-z0-9+/=]+

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error occurred while processing the request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

OptInRequiredException

The account must be opted in to Compute Optimizer Automation before performing this action.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400