keyboard_arrow_down
  • 12.0
  • 20.0

AWS Connectors

Describe an existing AWS Connector

get/awsconnectors/{awsConnectorID}

Describe an AWS Connector by ID.

Related SDK Methods:
Java

AwsConnectorsApi.describeAWSConnector([param1, param2, ...])
Python

AWSConnectorsApi.describe_aws_connector([param1, param2, ...])
JavaScript

AWSConnectorsApi.describeAWSConnector([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
awsConnectorID
required
integer <int32> \d+

The ID number of the AWS Connector to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view AWS Connectors.

404

The AWS Connector does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AwsConnectorsApi;
import com.trendmicro.deepsecurity.model.AWSConnector;


public class DescribeAWSConnectorExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AwsConnectorsApi instance = new AwsConnectorsApi();
		Integer awsConnectorID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			AWSConnector result = instance.describeAWSConnector(awsConnectorID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AwsConnectorsApi.describeAWSConnector");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "displayName": "string",
  • "accountId": "string",
  • "accountAlias": "string",
  • "accessKey": "string",
  • "secretKey": "string",
  • "seedRegion": "string",
  • "useInstanceRole": true,
  • "crossAccountRoleArn": "string",
  • "lastSyncTime": 0,
  • "syncedRegions": [
    ],
  • "workspacesEnabled": true,
  • "stsRegionalClientEnabled": true,
  • "ID": 0
}

Modify an AWS Connector

post/awsconnectors/{awsConnectorID}

Modify the specified AWS Connector by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

AwsConnectorsApi.modifyAWSConnector([param1, param2, ...])
Python

AWSConnectorsApi.modify_aws_connector([param1, param2, ...])
JavaScript

AWSConnectorsApi.modifyAWSConnector([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
awsConnectorID
required
integer <int32> \d+

The ID number of the AWS Connector to modify.

Example: 1
query Parameters
sync
boolean

Immediately trigger a synchronization for the AWS Connector.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the AWS Connector to modify.

accessKey
string

The AWS Access Key of the account. If used, Cross Account Role ARN is not required. Searchable as String.

accountAlias
string

The AWS Account Alias. Searchable as String.

accountId
string

The AWS Account ID. Searchable as String.

crossAccountRoleArn
string

The Cross Account Role ARN of the AWS account. If used, Access Key is not required. Searchable as String.

displayName
string

The AWS Connector's display name in DSM.

lastSyncTime
integer <int64>

Timestamp of the last time the AWS Connector was successfully synchronized, in milliseconds since epoch. Searchable as Date.

secretKey
string

The AWS Secret Key required to add the connector using an Access Key. Not present in returned objects.

seedRegion
string

The region to initialize the EC2 client in. This is an advanced option used if you want to access special regions. Searchable as String.

stsRegionalClientEnabled
boolean

A flag controlling whether or not the user is enabled Amazon STS client to use the region endpoint for the connector. Searchable as Boolean. Default is false.

Array of objects (AWSRegion)

The list of AWS regions that have been synchronized for the connector.

useInstanceRole
boolean

Specifies whether or not to use the DSM instance role to add the AWS Connector instead of an Access Key or a Cross Account Role ARN.

workspacesEnabled
boolean

A flag controlling whether or not Amazon Workspaces are enabled for the connector. Searchable as Boolean. Default is false.

Responses
200

successful operation

403

Not authorized to modify AWS Connectors or the requested modification is not permitted.

404

The AWS account does not exist.

Request samples
application/json
{
  • "displayName": "string",
  • "accountId": "string",
  • "accountAlias": "string",
  • "accessKey": "string",
  • "secretKey": "string",
  • "seedRegion": "string",
  • "useInstanceRole": true,
  • "crossAccountRoleArn": "string",
  • "lastSyncTime": 0,
  • "syncedRegions": [
    ],
  • "workspacesEnabled": true,
  • "stsRegionalClientEnabled": true
}
Response samples
application/json
{
  • "displayName": "string",
  • "accountId": "string",
  • "accountAlias": "string",
  • "accessKey": "string",
  • "secretKey": "string",
  • "seedRegion": "string",
  • "useInstanceRole": true,
  • "crossAccountRoleArn": "string",
  • "lastSyncTime": 0,
  • "syncedRegions": [
    ],
  • "workspacesEnabled": true,
  • "stsRegionalClientEnabled": true,
  • "ID": 0
}

Delete an AWS Connector

delete/awsconnectors/{awsConnectorID}

Delete an existing AWS Connector by ID.

Related SDK Methods:
Java

AwsConnectorsApi.deleteAWSConnector([param1, param2, ...])
Python

AWSConnectorsApi.delete_aws_connector([param1, param2, ...])
JavaScript

AWSConnectorsApi.deleteAWSConnector([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
awsConnectorID
required
integer <int32> \d+

The ID number of the AWS Connector to delete.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

Request is successful.

403

Not authorized to delete AWS Connectors.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AwsConnectorsApi;


public class DeleteAWSConnectorExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AwsConnectorsApi instance = new AwsConnectorsApi();
		Integer awsConnectorID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteAWSConnector(awsConnectorID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AwsConnectorsApi.deleteAWSConnector");
			e.printStackTrace();
		}
	}
}

List AWS Connectors

get/awsconnectors

Lists all AWS Connectors.

Related SDK Methods:
Java

AwsConnectorsApi.listAWSConnectors([param1, param2, ...])
Python

AWSConnectorsApi.list_aws_connectors([param1, param2, ...])
JavaScript

AWSConnectorsApi.listAWSConnectors([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view AWS Connectors.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AwsConnectorsApi;
import com.trendmicro.deepsecurity.model.AWSConnectors;


public class ListAWSConnectorsExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AwsConnectorsApi instance = new AwsConnectorsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			AWSConnectors result = instance.listAWSConnectors(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AwsConnectorsApi.listAWSConnectors");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "awsConnectors": [
    ]
}

Create an AWS Connector

post/awsconnectors

Create a new AWS Connector.

Related SDK Methods:
Java

AwsConnectorsApi.createAWSConnector([param1, param2, ...])
Python

AWSConnectorsApi.create_aws_connector([param1, param2, ...])
JavaScript

AWSConnectorsApi.createAWSConnector([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the new AWS Connector.

accessKey
string

The AWS Access Key of the account. If used, Cross Account Role ARN is not required. Searchable as String.

accountAlias
string

The AWS Account Alias. Searchable as String.

accountId
string

The AWS Account ID. Searchable as String.

crossAccountRoleArn
string

The Cross Account Role ARN of the AWS account. If used, Access Key is not required. Searchable as String.

displayName
string

The AWS Connector's display name in DSM.

lastSyncTime
integer <int64>

Timestamp of the last time the AWS Connector was successfully synchronized, in milliseconds since epoch. Searchable as Date.

secretKey
string

The AWS Secret Key required to add the connector using an Access Key. Not present in returned objects.

seedRegion
string

The region to initialize the EC2 client in. This is an advanced option used if you want to access special regions. Searchable as String.

stsRegionalClientEnabled
boolean

A flag controlling whether or not the user is enabled Amazon STS client to use the region endpoint for the connector. Searchable as Boolean. Default is false.

Array of objects (AWSRegion)

The list of AWS regions that have been synchronized for the connector.

useInstanceRole
boolean

Specifies whether or not to use the DSM instance role to add the AWS Connector instead of an Access Key or a Cross Account Role ARN.

workspacesEnabled
boolean

A flag controlling whether or not Amazon Workspaces are enabled for the connector. Searchable as Boolean. Default is false.

Responses
200

successful operation

403

Not authorized to create AWS Connectors.

Request samples
application/json
{
  • "displayName": "string",
  • "accountId": "string",
  • "accountAlias": "string",
  • "accessKey": "string",
  • "secretKey": "string",
  • "seedRegion": "string",
  • "useInstanceRole": true,
  • "crossAccountRoleArn": "string",
  • "lastSyncTime": 0,
  • "syncedRegions": [
    ],
  • "workspacesEnabled": true,
  • "stsRegionalClientEnabled": true
}
Response samples
application/json
{
  • "displayName": "string",
  • "accountId": "string",
  • "accountAlias": "string",
  • "accessKey": "string",
  • "secretKey": "string",
  • "seedRegion": "string",
  • "useInstanceRole": true,
  • "crossAccountRoleArn": "string",
  • "lastSyncTime": 0,
  • "syncedRegions": [
    ],
  • "workspacesEnabled": true,
  • "stsRegionalClientEnabled": true,
  • "ID": 0
}

Search AWS Connectors

post/awsconnectors/search

Search for AWS Connectors using optional filters.

Related SDK Methods:
Java

AwsConnectorsApi.searchAWSConnectors([param1, param2, ...])
Python

AWSConnectorsApi.search_aws_connectors([param1, param2, ...])
JavaScript

AWSConnectorsApi.searchAWSConnectors([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view AWS Connectors.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "awsConnectors": [
    ]
}
➔ Next to AWS Connector Settings