thousandeyes-sdk-python/thousandeyes-sdk-cloud-insights-integrations

thousandeyes-sdk-cloud-insights-integrations

Note: All Cloud Insights APIs are not available for ThousandEyes for Government instance.

The Cloud Insights Integrations API lets you programmatically manage AWS and Azure monitoring integrations in ThousandEyes.

What You Can Do

• List all integrations.

• Get details for a specific integration.

• Delete an existing integration.

• Create integrations for:

  • AWS: inventory monitoring and flow logs monitoring.

  • Azure: inventory monitoring and flow logs monitoring.

• Update integrations for:

  • Azure: inventory monitoring and flow logs monitoring.

• Fetch AWS IAM policy documents required to configure AWS inventory and flow-logs integrations.

• Retrieve the current AWS and Azure integration policy settings to understand which AWS and Azure resource groups, AWS regions, Azure subscription rules are enabled and whether CloudTrail is enabled for Cloud Insights for inventory monitoring.

• Update policy settings to change the approved AWS resource groups, AWS regions, and Azure subscription rules that ThousandEyes should inventory.

Scope and Tenancy

All operations are scoped to the authenticated account group. Responses include only resources associated with that group.

Payloads and formats

• Requests: application/json

• Responses: primarily application/hal+json for resource representations and application/json for policy documents.

• HAL responses include _links with a self relation for direct navigation.

Integration Types

• Inventory monitoring

  • AWS: reads inventory and network topology via read-only IAM permissions.

  • Azure: authenticates with a Service Principal to read inventory and network topology.

• Flow logs monitoring

  • AWS: reads flow logs from S3 buckets and uses SNS for notifications.

  • Azure: reads flow logs via Service Bus Queue (serviceBusQueueUrl).

Policy Helpers (AWS)

Dedicated endpoints return Trusted Policy, Permissions Policy, and SNS Topic Access Policy documents to simplify role setup for inventory and flow logs integrations.

Notes

• All example values in this specification are fictitious.

For more information about Cloud Insights, see Cloud Insights.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.104
• Generator version: 7.6.0
• Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.9+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-cloud-insights-integrations

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-cloud-insights-integrations)

Then import the package:

import thousandeyes_sdk.cloud_insights_integrations

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import thousandeyes_sdk.cloud_insights_integrations

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.cloud_insights_integrations
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com/v7"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.cloud_insights_integrations.CloudInsightsIntegrationPolicySettingsApi(api_client)
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # Get AWS integration policy settings
        api_response = api_instance.get_aws_integration_policy_settings(aid=aid)
        print("The response of CloudInsightsIntegrationPolicySettingsApi->get_aws_integration_policy_settings:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CloudInsightsIntegrationPolicySettingsApi->get_aws_integration_policy_settings: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class	Method	HTTP request	Description
CloudInsightsIntegrationPolicySettingsApi	get_aws_integration_policy_settings	GET /cloud-insights/integration/aws/policy/settings	Get AWS integration policy settings
CloudInsightsIntegrationPolicySettingsApi	get_azure_integration_policy_settings	GET /cloud-insights/integration/azure/policy/settings	Get Azure integration policy settings
CloudInsightsIntegrationPolicySettingsApi	update_aws_integration_policy_settings	PUT /cloud-insights/integration/aws/policy/settings	Update AWS integration policy settings
CloudInsightsIntegrationPolicySettingsApi	update_azure_integration_policy_settings	PUT /cloud-insights/integration/azure/policy/settings	Update Azure integration policy settings
CloudInsightsIntegrationsApi	create_aws_flow_logs_monitoring_integration	POST /cloud-insights/integration/aws/flow-logs	Create AWS flow logs monitoring integration
CloudInsightsIntegrationsApi	create_aws_inventory_monitoring_integration	POST /cloud-insights/integration/aws/inventory	Create AWS inventory monitoring integration
CloudInsightsIntegrationsApi	create_azure_flow_logs_monitoring_integration	POST /cloud-insights/integration/azure/flow-logs	Create Azure flow logs monitoring integration
CloudInsightsIntegrationsApi	create_azure_inventory_monitoring_integration	POST /cloud-insights/integration/azure/inventory	Create Azure inventory monitoring integration
CloudInsightsIntegrationsApi	delete_aws_monitoring_integration	DELETE /cloud-insights/integration/aws/{integrationId}	Delete AWS integration
CloudInsightsIntegrationsApi	delete_azure_monitoring_integration	DELETE /cloud-insights/integration/azure/{integrationId}	Delete Azure integration
CloudInsightsIntegrationsApi	get_all_aws_monitoring_integrations	GET /cloud-insights/integration/aws	List AWS integrations
CloudInsightsIntegrationsApi	get_all_azure_monitoring_integrations	GET /cloud-insights/integration/azure	List Azure integrations
CloudInsightsIntegrationsApi	get_aws_flowlogs_monitoring_integration_policies	GET /cloud-insights/integration/aws/flow-logs/policies	Get AWS flow logs monitoring IAM policies
CloudInsightsIntegrationsApi	get_aws_inventory_monitoring_integration_policies	GET /cloud-insights/integration/aws/inventory/policies	Get AWS inventory monitoring IAM policies
CloudInsightsIntegrationsApi	get_aws_monitoring_integration	GET /cloud-insights/integration/aws/{integrationId}	Get AWS integration
CloudInsightsIntegrationsApi	get_azure_monitoring_integration	GET /cloud-insights/integration/azure/{integrationId}	Get Azure integration
CloudInsightsIntegrationsApi	update_azure_flow_logs_monitoring_integration	PUT /cloud-insights/integration/azure/flow-logs/{integrationId}	Update Azure flow logs monitoring integration
CloudInsightsIntegrationsApi	update_azure_inventory_monitoring_integration	PUT /cloud-insights/integration/azure/inventory/{integrationId}	Update Azure inventory monitoring integration

Documentation For Models

• AwsFlowLogsIntegrationRequest
• AwsIntegrationPolicySetting
• AwsInventoryIntegrationRequest
• AwsMonitoringIntegration
• AwsMonitoringIntegrations
• AwsRegion
• AwsResourceGroupType
• AzureFlowLogsIntegrationRequest
• AzureIntegrationPolicySetting
• AzureInventoryIntegrationRequest
• AzureMonitoringIntegration
• AzureMonitoringIntegrations
• AzureResourceGroupType
• Error
• Link
• SelfLinks
• SubscriptionsPolicy
• SubscriptionsPolicyRule
• SubscriptionsPolicyRuleAction
• SubscriptionsPolicyRuleField
• UnauthorizedError
• ValidationError
• ValidationErrorItem

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team