All URIs are relative to http://localhost/
| Method | HTTP request | Description |
|---|---|---|
| create | POST api/v2/integrations/amazon_sns.json_api | Create an Amazon SNS Integration |
| show | GET api/v2/integrations/{integration_id}/amazon_sns.json_api | Show a single Amazon SNS Integration |
| update | PATCH api/v2/integrations/{integration_id}/amazon_sns.json_api | Update an Amazon SNS Integration |
IntegrationAmazonSns create(arn, externalAccountIds, externalId, name, topic, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses)
Create an Amazon SNS Integration
// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.IntegrationsAmazonSNSApi;
IntegrationsAmazonSNSApi apiInstance = new IntegrationsAmazonSNSApi();
String arn = "arn_example"; // String | The role arn for accessing the SNS topic
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String externalId = "externalId_example"; // String | The external ID for the IAM role
String name = "name_example"; // String | Name of the integration
String topic = "topic_example"; // String | The SNS topic arn
String include = "include_example"; // String | Related objects that can be included in the response: integration See Including Objects for more information.
Boolean allHighRisk = true; // Boolean | Send all high risk alerts
Boolean allLowRisk = true; // Boolean | Send all low risk alerts
Boolean allMediumRisk = true; // Boolean | Send all medium risk alerts
List<Integer> customSignatureIds = Arrays.asList(56); // List<Integer> | Custom signatures for integration
Boolean sendUpdates = true; // Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
Boolean sendWhenSuppressed = true; // Boolean | Send notifications for suppressed alerts
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | Signatures for integration
List<String> statuses = Arrays.asList("statuses_example"); // List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
try {
IntegrationAmazonSns result = apiInstance.create(arn, externalAccountIds, externalId, name, topic, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsAmazonSNSApi#create");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| arn | String | The role arn for accessing the SNS topic | |
| externalAccountIds | List<Integer> | External accounts for integration | |
| externalId | String | The external ID for the IAM role | |
| name | String | Name of the integration | |
| topic | String | The SNS topic arn | |
| include | String | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| allHighRisk | Boolean | Send all high risk alerts | [optional] |
| allLowRisk | Boolean | Send all low risk alerts | [optional] |
| allMediumRisk | Boolean | Send all medium risk alerts | [optional] |
| customSignatureIds | List<Integer> | Custom signatures for integration | [optional] |
| sendUpdates | Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. | [optional] |
| sendWhenSuppressed | Boolean | Send notifications for suppressed alerts | [optional] |
| signatureIds | List<Integer> | Signatures for integration | [optional] |
| statuses | List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
No authorization required
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
IntegrationAmazonSns show(integrationId, include)
Show a single Amazon SNS Integration
// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.IntegrationsAmazonSNSApi;
IntegrationsAmazonSNSApi apiInstance = new IntegrationsAmazonSNSApi();
Integer integrationId = 56; // Integer | The ID of the integration
String include = "include_example"; // String | Related objects that can be included in the response: integration See Including Objects for more information.
try {
IntegrationAmazonSns result = apiInstance.show(integrationId, include);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsAmazonSNSApi#show");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| integrationId | Integer | The ID of the integration | |
| include | String | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
No authorization required
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
IntegrationAmazonSns update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, arn, customSignatureIds, externalAccountIds, externalId, name, sendUpdates, sendWhenSuppressed, signatureIds, statuses, topic)
Update an Amazon SNS Integration
// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.IntegrationsAmazonSNSApi;
IntegrationsAmazonSNSApi apiInstance = new IntegrationsAmazonSNSApi();
Integer integrationId = 56; // Integer | The ID of the integration
String include = "include_example"; // String | Related objects that can be included in the response: integration See Including Objects for more information.
Boolean allHighRisk = true; // Boolean | Send all high risk alerts
Boolean allLowRisk = true; // Boolean | Send all low risk alerts
Boolean allMediumRisk = true; // Boolean | Send all medium risk alerts
String arn = "arn_example"; // String | The role arn for accessing the SNS topic
List<Integer> customSignatureIds = Arrays.asList(56); // List<Integer> | Custom signatures for integration
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String externalId = "externalId_example"; // String | The external ID for the IAM role
String name = "name_example"; // String | Name of the integration
Boolean sendUpdates = true; // Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
Boolean sendWhenSuppressed = true; // Boolean | Send notifications for suppressed alerts
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | Signatures for integration
List<String> statuses = Arrays.asList("statuses_example"); // List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
String topic = "topic_example"; // String | The SNS topic arn
try {
IntegrationAmazonSns result = apiInstance.update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, arn, customSignatureIds, externalAccountIds, externalId, name, sendUpdates, sendWhenSuppressed, signatureIds, statuses, topic);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsAmazonSNSApi#update");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| integrationId | Integer | The ID of the integration | |
| include | String | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| allHighRisk | Boolean | Send all high risk alerts | [optional] |
| allLowRisk | Boolean | Send all low risk alerts | [optional] |
| allMediumRisk | Boolean | Send all medium risk alerts | [optional] |
| arn | String | The role arn for accessing the SNS topic | [optional] |
| customSignatureIds | List<Integer> | Custom signatures for integration | [optional] |
| externalAccountIds | List<Integer> | External accounts for integration | [optional] |
| externalId | String | The external ID for the IAM role | [optional] |
| name | String | Name of the integration | [optional] |
| sendUpdates | Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. | [optional] |
| sendWhenSuppressed | Boolean | Send notifications for suppressed alerts | [optional] |
| signatureIds | List<Integer> | Signatures for integration | [optional] |
| statuses | List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
| topic | String | The SNS topic arn | [optional] |
No authorization required
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json