ListTopicRules
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
Request Syntax
GET /rules?maxResults=maxResults&nextToken=nextToken&ruleDisabled=ruleDisabled&topic=topic 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 10000.
- nextToken
-
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwise null to receive the first set of results. - ruleDisabled
-
Specifies whether the rule is disabled.
- topic
-
The topic.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"rules": [
{
"createdAt": number,
"ruleArn": "string",
"ruleDisabled": boolean,
"ruleName": "string",
"topicPattern": "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 token to use to get the next set of results, or null if there are no additional results.
Type: String
- rules
-
The rules.
Type: Array of TopicRuleListItem objects
Errors
- InternalException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
