Request Syntax Request Parameters Response Elements Errors Examples See Also

SubscribeToEvent

Enables 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 receive SNS notifications.

Type: String

Valid Values: ASSESSMENT_RUN_STARTED | ASSESSMENT_RUN_COMPLETED | ASSESSMENT_RUN_STATE_CHANGED | FINDING_REPORTED | OTHER

Required: Yes

resourceArn

The ARN of the assessment template that is used during the event for which you want to receive 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 the 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

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

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 SubscribeToEvent.

Sample Request



               
                  POST / HTTP/1.1
                  Host: inspector.us-west-2.amazonaws.com
                  Accept-Encoding: identity
                  Content-Length: 200
                  X-Amz-Target: InspectorService.SubscribeToEvent
                  X-Amz-Date: 20160331T201719Z
                  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: 929b6c44-f77d-11e5-bcc6-cd3a7bd10be0
                  Content-Type: application/x-amz-json-1.1
                  Content-Length: 0
                  Date: Thu, 31 Mar 2016 20:17:20 GMT