All URIs are relative to https://api.evident.io
| 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, external_account_ids, external_id, name, topic, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses)
Create an Amazon SNS Integration
from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = esp_sdk.IntegrationsAmazonSNSApi()
arn = 'arn_example' # str | The role arn for accessing the SNS topic
external_account_ids = [56] # list[int] | External accounts for integration
external_id = 'external_id_example' # str | The external ID for the IAM role
name = 'name_example' # str | Name of the integration
topic = 'topic_example' # str | The SNS topic arn
include = 'include_example' # str | Related objects that can be included in the response: integration See Including Objects for more information. (optional)
all_high_risk = true # bool | Send all high risk alerts (optional)
all_low_risk = true # bool | Send all low risk alerts (optional)
all_medium_risk = true # bool | Send all medium risk alerts (optional)
custom_signature_ids = [56] # list[int] | Custom signatures for integration (optional)
send_updates = true # bool | 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)
send_when_suppressed = true # bool | Send notifications for suppressed alerts (optional)
signature_ids = [56] # list[int] | Signatures for integration (optional)
statuses = ['statuses_example'] # list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info (optional)
try:
# Create an Amazon SNS Integration
api_response = api_instance.create(arn, external_account_ids, external_id, name, topic, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsAmazonSNSApi->create: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| arn | str | The role arn for accessing the SNS topic | |
| external_account_ids | list[int] | External accounts for integration | |
| external_id | str | The external ID for the IAM role | |
| name | str | Name of the integration | |
| topic | str | The SNS topic arn | |
| include | str | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| all_high_risk | bool | Send all high risk alerts | [optional] |
| all_low_risk | bool | Send all low risk alerts | [optional] |
| all_medium_risk | bool | Send all medium risk alerts | [optional] |
| custom_signature_ids | list[int] | Custom signatures for integration | [optional] |
| send_updates | bool | 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] |
| send_when_suppressed | bool | Send notifications for suppressed alerts | [optional] |
| signature_ids | list[int] | Signatures for integration | [optional] |
| statuses | list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IntegrationAmazonSns show(integration_id, include=include)
Show a single Amazon SNS Integration
from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = esp_sdk.IntegrationsAmazonSNSApi()
integration_id = 56 # int | The ID of the integration
include = 'include_example' # str | Related objects that can be included in the response: integration See Including Objects for more information. (optional)
try:
# Show a single Amazon SNS Integration
api_response = api_instance.show(integration_id, include=include)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsAmazonSNSApi->show: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| integration_id | int | The ID of the integration | |
| include | str | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IntegrationAmazonSns update(integration_id, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, arn=arn, custom_signature_ids=custom_signature_ids, external_account_ids=external_account_ids, external_id=external_id, name=name, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, topic=topic)
Update an Amazon SNS Integration
from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = esp_sdk.IntegrationsAmazonSNSApi()
integration_id = 56 # int | The ID of the integration
include = 'include_example' # str | Related objects that can be included in the response: integration See Including Objects for more information. (optional)
all_high_risk = true # bool | Send all high risk alerts (optional)
all_low_risk = true # bool | Send all low risk alerts (optional)
all_medium_risk = true # bool | Send all medium risk alerts (optional)
arn = 'arn_example' # str | The role arn for accessing the SNS topic (optional)
custom_signature_ids = [56] # list[int] | Custom signatures for integration (optional)
external_account_ids = [56] # list[int] | External accounts for integration (optional)
external_id = 'external_id_example' # str | The external ID for the IAM role (optional)
name = 'name_example' # str | Name of the integration (optional)
send_updates = true # bool | 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)
send_when_suppressed = true # bool | Send notifications for suppressed alerts (optional)
signature_ids = [56] # list[int] | Signatures for integration (optional)
statuses = ['statuses_example'] # list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info (optional)
topic = 'topic_example' # str | The SNS topic arn (optional)
try:
# Update an Amazon SNS Integration
api_response = api_instance.update(integration_id, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, arn=arn, custom_signature_ids=custom_signature_ids, external_account_ids=external_account_ids, external_id=external_id, name=name, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, topic=topic)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsAmazonSNSApi->update: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| integration_id | int | The ID of the integration | |
| include | str | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| all_high_risk | bool | Send all high risk alerts | [optional] |
| all_low_risk | bool | Send all low risk alerts | [optional] |
| all_medium_risk | bool | Send all medium risk alerts | [optional] |
| arn | str | The role arn for accessing the SNS topic | [optional] |
| custom_signature_ids | list[int] | Custom signatures for integration | [optional] |
| external_account_ids | list[int] | External accounts for integration | [optional] |
| external_id | str | The external ID for the IAM role | [optional] |
| name | str | Name of the integration | [optional] |
| send_updates | bool | 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] |
| send_when_suppressed | bool | Send notifications for suppressed alerts | [optional] |
| signature_ids | list[int] | Signatures for integration | [optional] |
| statuses | list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
| topic | str | The SNS topic arn | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]