Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
Request Syntax
{
"event": "string",
"resourceArn": "string",
"topicArn": "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.
- event
-
The event for which you want to stop receiving SNS notifications.
Type: String
Valid Values:
ASSESSMENT_RUN_STARTED | ASSESSMENT_RUN_COMPLETED | ASSESSMENT_RUN_STATE_CHANGED | FINDING_REPORTED | OTHERRequired: Yes
- resourceArn
-
The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- topicArn
-
The ARN of the SNS topic to which SNS notifications are sent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ServiceTemporarilyUnavailableException
-
The serice is temporary unavailable.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of UnsubscribeFromEvent.
Sample Request
POST / HTTP/1.1
Host: inspector.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 200
X-Amz-Target: InspectorService.UnsubscribeFromEvent
X-Amz-Date: 20160331T203404Z
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",
"event": "ASSESSMENT_RUN_COMPLETED",
"topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: e9c2e864-f77f-11e5-82d7-bb83264505be
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Thu, 31 Mar 2016 20:34:06 GMT
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
