

# SubscribeToEvent
<a name="API_SubscribeToEvent"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for (Amazon Inspector Classic). After May 20, 2026, you will no longer be able to access the Amazon Inspector Classic console or Amazon Inspector Classic resources. For more information, see [Amazon Inspector Classic end of support](https://docs.aws.amazon.com/inspector/v1/userguide/inspector-migration.html). 

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

## Request Syntax
<a name="API_SubscribeToEvent_RequestSyntax"></a>

```
{
   "event": "string",
   "resourceArn": "string",
   "topicArn": "string"
}
```

## Request Parameters
<a name="API_SubscribeToEvent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [event](#API_SubscribeToEvent_RequestSyntax) **   <a name="Inspector-SubscribeToEvent-request-event"></a>
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](#API_SubscribeToEvent_RequestSyntax) **   <a name="Inspector-SubscribeToEvent-request-resourceArn"></a>
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](#API_SubscribeToEvent_RequestSyntax) **   <a name="Inspector-SubscribeToEvent-request-topicArn"></a>
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
<a name="API_SubscribeToEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SubscribeToEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
Internal server error.    
 ** canRetry **   
You can immediately retry your request.  
 ** message **   
Details of the exception error.
HTTP Status Code: 500

 ** InvalidInputException **   
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.    
 ** canRetry **   
You can immediately retry your request.  
 ** errorCode **   
Code that indicates the type of error that is generated.  
 ** message **   
Details of the exception error.
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.    
 ** canRetry **   
You can immediately retry your request.  
 ** errorCode **   
Code that indicates the type of error that is generated.  
 ** message **   
Details of the exception error.
HTTP Status Code: 400

 ** NoSuchEntityException **   
The request was rejected because it referenced an entity that does not exist. The error code describes the entity.    
 ** canRetry **   
You can immediately retry your request.  
 ** errorCode **   
Code that indicates the type of error that is generated.  
 ** message **   
Details of the exception error.
HTTP Status Code: 400

 ** ServiceTemporarilyUnavailableException **   
The serice is temporary unavailable.    
 ** canRetry **   
You can wait and then retry your request.  
 ** message **   
Details of the exception error.
HTTP Status Code: 400

## Examples
<a name="API_SubscribeToEvent_Examples"></a>

### Example
<a name="API_SubscribeToEvent_Example_1"></a>

This example illustrates one usage of SubscribeToEvent.

#### Sample Request
<a name="API_SubscribeToEvent_Example_1_Request"></a>

```
               
                  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
<a name="API_SubscribeToEvent_Example_1_Response"></a>

```
               
                  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
```

## See Also
<a name="API_SubscribeToEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/inspector-2016-02-16/SubscribeToEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/inspector-2016-02-16/SubscribeToEvent) 