ListTargetsByRule
Lists the targets assigned to the specified rule.
The maximum number of results per page for requests is 100.
Request Syntax
{
"EventBusName": "string",
"Limit": number,
"NextToken": "string",
"Rule": "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 associated with the rule. 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
- 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
- Rule
-
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: Yes
Response Syntax
{
"NextToken": "string",
"Targets": [
{
"Arn": "string",
"BatchParameters": {
"ArrayProperties": {
"Size": number
},
"JobDefinition": "string",
"JobName": "string",
"RetryStrategy": {
"Attempts": number
}
},
"DeadLetterConfig": {
"Arn": "string"
},
"EcsParameters": {
"CapacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"EnableECSManagedTags": boolean,
"EnableExecuteCommand": boolean,
"Group": "string",
"LaunchType": "string",
"NetworkConfiguration": {
"awsvpcConfiguration": {
"AssignPublicIp": "string",
"SecurityGroups": [ "string" ],
"Subnets": [ "string" ]
}
},
"PlacementConstraints": [
{
"expression": "string",
"type": "string"
}
],
"PlacementStrategy": [
{
"field": "string",
"type": "string"
}
],
"PlatformVersion": "string",
"PropagateTags": "string",
"ReferenceId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TaskCount": number,
"TaskDefinitionArn": "string"
},
"HttpParameters": {
"HeaderParameters": {
"string" : "string"
},
"PathParameterValues": [ "string" ],
"QueryStringParameters": {
"string" : "string"
}
},
"Id": "string",
"Input": "string",
"InputPath": "string",
"InputTransformer": {
"InputPathsMap": {
"string" : "string"
},
"InputTemplate": "string"
},
"KinesisParameters": {
"PartitionKeyPath": "string"
},
"RedshiftDataParameters": {
"Database": "string",
"DbUser": "string",
"SecretManagerArn": "string",
"Sql": "string",
"Sqls": [ "string" ],
"StatementName": "string",
"WithEvent": boolean
},
"RetryPolicy": {
"MaximumEventAgeInSeconds": number,
"MaximumRetryAttempts": number
},
"RoleArn": "string",
"RunCommandParameters": {
"RunCommandTargets": [
{
"Key": "string",
"Values": [ "string" ]
}
]
},
"SageMakerPipelineParameters": {
"PipelineParameterList": [
{
"Name": "string",
"Value": "string"
}
]
},
"SqsParameters": {
"MessageGroupId": "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.
- Targets
-
The targets assigned to the rule.
Type: Array of Target objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
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 the targets associated with a rule named "test"
The following is an example of a ListTargetsByRule 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.ListTargetsByRule
{
"Rule": "test"
}Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"Targets": [
{
"Id": "MyTargetId",
"Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
