ListRuleNamesByTarget
Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account.
Request Syntax
{ "Limit":number, "NextToken": "string", "TargetArn": "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.
- Limit
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- TargetArn
-
The Amazon Resource Name (ARN) of the target resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: Yes
Response Syntax
{ "NextToken": "string", "RuleNames": [ "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
-
Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- RuleNames
-
The names of the rules that can invoke the given target.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+
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
Example
Lists rule names by target with the specified ARN
The following is an example of a ListRuleNamesByTarget 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.ListRuleNamesByTarget { "TargetArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "NextToken": "", "Limit": 0 }
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "RuleNames": [ "test1", "test2", "test3", "test4", "test5" ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
