ListRules
Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
The maximum number of results per page for requests is 100.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
Request Syntax
{
"EventBusName": "string",
"Limit": number,
"NamePrefix": "string",
"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.
- EventBusName
-
The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
(arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+Required: No
- Limit
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NamePrefix
-
The prefix matching the rule name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: No
- NextToken
-
The token returned by a previous call, which you can use to retrieve the next set of results.
The value of
nextTokenis a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.Using an expired pagination token results in an
HTTP 400 InvalidTokenerror.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax
{
"NextToken": "string",
"Rules": [
{
"Arn": "string",
"Description": "string",
"EventBusName": "string",
"EventPattern": "string",
"ManagedBy": "string",
"Name": "string",
"RoleArn": "string",
"ScheduleExpression": "string",
"State": "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
-
A token indicating there are more results available. If there are no more results, no token is included in the response.
The value of
nextTokenis a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.Using an expired pagination token results in an
HTTP 400 InvalidTokenerror.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- Rules
-
The rules that match the specified criteria.
Type: Array of Rule objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Lists all the rules that start with the letter "t" with a page size of 1
The following is an example of a ListRules request and response.
Sample Request
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.ListRules
{
"NamePrefix": "t",
"Limit": 1
}Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"Rules": [
{
"EventPattern": "{\"source\":[\"aws.autoscaling\"],\"detail-type\":[\"EC2 Instance Launch Successful\",\"EC2 Instance Terminate Successful\",\"EC2 Instance Launch Unsuccessful\",\"EC2 Instance Terminate Unsuccessful\"]}",
"State": "DISABLED",
"Name": "test",
"Arn": "arn:aws:events:us-east-1:123456789012:rule/test",
"Description": "Test rule for Auto Scaling events"
}
],
"NextToken": "ABCDEgAAAAAAAAAAQAAABCXtD8i7XlyFv5XFKH8GrudAAAAQIoQ0+7qXp63vQf1pvVklfHFd+p2QgY36pjlAqsSsrkNbOtTePaCeJqN8O+jbu66UhpJh7huA9r0iY9zjdtZ3vsAAAAgAAAAAAAAAAF5MZWktllmMuLd9gUjryM4sL9EG5IkcPUm60Vq1tzyYw=="
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
