AWS Connector Migration Tasks

Create Connector Migration Tasks

post/batchconnectormigrationtasks/aws

Create new AWS Connector Migration Tasks.

Related SDK Methods:
Java

AwsConnectorMigrationTasksApi.createConnectorMigrationTasks([param1, param2, ...])

Python

AWSConnectorMigrationTasksApi.create_connector_migration_tasks([param1, param2, ...])

JavaScript

AWSConnectorMigrationTasksApi.createConnectorMigrationTasks([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The task to migrate the connector.

connectorIDs
required
Array of integers <int32>

IDs of the Connector.

Responses
200

successful operation

400

Invalid parameters to create connector migration tasks

403

Not authorized to migrate AWS connector.

Request samples
application/json
{
  • "connectorIDs": [
    ]
}
Response samples
application/json
{
  • "connectorMigrationTasks": [
    ],
  • "connectorsUnableToMigrate": [
    ]
}

List Connector Migration Tasks

get/connectormigrationtasks/aws

Describe AWS connector migration tasks.

Related SDK Methods:
Java

AwsConnectorMigrationTasksApi.listConnectorMigrationTasks([param1, param2, ...])

Python

AWSConnectorMigrationTasksApi.list_connector_migration_tasks([param1, param2, ...])

JavaScript

AWSConnectorMigrationTasksApi.listConnectorMigrationTasks([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to migrate AWS connector.

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.AwsConnectorMigrationTasksApi;
import com.trendmicro.deepsecurity.model.ConnectorMigrationTasks;


public class ListConnectorMigrationTasksExample {
	
	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
		AwsConnectorMigrationTasksApi instance = new AwsConnectorMigrationTasksApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ConnectorMigrationTasks result = instance.listConnectorMigrationTasks(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AwsConnectorMigrationTasksApi.listConnectorMigrationTasks");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "connectorMigrationTasks": [
    ]
}

Create a Connector Migration Task

post/connectormigrationtasks/aws

Create a new AWS Connector Migration Task.

Related SDK Methods:
Java

AwsConnectorMigrationTasksApi.createConnectorMigrationTask([param1, param2, ...])

Python

AWSConnectorMigrationTasksApi.create_connector_migration_task([param1, param2, ...])

JavaScript

AWSConnectorMigrationTasksApi.createConnectorMigrationTask([param1, param2, ...])

Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The task to migrate the connector.

connectorID
integer <int32>

ID of the Connector.

Responses
200

successful operation

400

Invalid parameters to create a connector migration task

403

Not authorized to migrate AWS connector.

409

A connector migration task already exists

Request samples
application/json
{
  • "connectorID": 0
}
Response samples
application/json
{
  • "ID": 0,
  • "connectorID": 0,
  • "status": "requested",
  • "errorCode": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Search Connector Migration Tasks

post/connectormigrationtasks/aws/search

Search for AWS connector migration task using optional filters.

Related SDK Methods:
Java

AwsConnectorMigrationTasksApi.searchConnectorMigrationTasks([param1, param2, ...])

Python

AWSConnectorMigrationTasksApi.search_connector_migration_tasks([param1, param2, ...])

JavaScript

AWSConnectorMigrationTasksApi.searchConnectorMigrationTasks([param1, param2, ...])

Request
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 migrate AWS connector.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "connectorMigrationTasks": [
    ]
}

Describe a Connector Migration Task

get/connectormigrationtasks/aws/{connectorMigrationTaskID}

Describe an AWS connector migration task.

Related SDK Methods:
Java

AwsConnectorMigrationTasksApi.describeConnectorMigrationTask([param1, param2, ...])

Python

AWSConnectorMigrationTasksApi.describe_connector_migration_task([param1, param2, ...])

JavaScript

AWSConnectorMigrationTasksApi.describeConnectorMigrationTask([param1, param2, ...])

Request
path Parameters
connectorMigrationTaskID
required
integer <int64> \d+

The ID number of the connector migration task 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 migrate AWS connector.

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.AwsConnectorMigrationTasksApi;
import com.trendmicro.deepsecurity.model.ConnectorMigrationTask;


public class DescribeConnectorMigrationTaskExample {
	
	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
		AwsConnectorMigrationTasksApi instance = new AwsConnectorMigrationTasksApi();
		Long connectorMigrationTaskID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ConnectorMigrationTask result = instance.describeConnectorMigrationTask(connectorMigrationTaskID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AwsConnectorMigrationTasksApi.describeConnectorMigrationTask");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "ID": 0,
  • "connectorID": 0,
  • "status": "requested",
  • "errorCode": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z"
}