ListEventSubscriptions
Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.
Request Syntax
{
"maxResults": number,
"nextToken": "string",
"resourceArn": "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.
- maxResults
-
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
Type: Integer
Required: No
- nextToken
-
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- resourceArn
-
The ARN of the assessment template for which you want to list the existing event subscriptions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
Response Syntax
{
"nextToken": "string",
"subscriptions": [
{
"eventSubscriptions": [
{
"event": "string",
"subscribedAt": number
}
],
"resourceArn": "string",
"topicArn": "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
-
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
- subscriptions
-
Details of the returned event subscriptions.
Type: Array of Subscription objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidInputException
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
- NoSuchEntityException
-
The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ListEventSubscriptions.
Sample Request
POST / HTTP/1.1
Host: inspector.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 97
X-Amz-Target: InspectorService.ListEventSubscriptions
X-Amz-Date: 20160331T202943Z
User-Agent: aws-cli/1.10.12 Python/2.7.9 Windows/7 botocore/1.4.3
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{
"resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 4e21c005-f77f-11e5-823c-bd257ba1495d
Content-Type: application/x-amz-json-1.1
Content-Length: 272
Date: Thu, 31 Mar 2016 20:29:44 GMT
{
"subscriptions": [
{
"eventSubscriptions": [
{
"event": "ASSESSMENT_RUN_COMPLETED",
"subscribedAt": 1459455440.867
}
],
"resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0",
"topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
