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

ListAutomationRulesV2

Returns a list of automation rules and metadata for the calling account. This API is in private preview and subject to change.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return.

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

NextToken

The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Rules": [ 
      { 
         "Actions": [ 
            { 
               "Type": "string"
            }
         ],
         "CreatedAt": "string",
         "Description": "string",
         "RuleArn": "string",
         "RuleId": "string",
         "RuleName": "string",
         "RuleOrder": number,
         "RuleStatus": "string",
         "UpdatedAt": "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.

NextToken

The pagination token to use to request the next page of results. Otherwise, this parameter is null.

Type: String

Rules

An array of automation rules.

Type: Array of AutomationRulesMetadataV2 objects

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

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400