AWS SDK for PHP 3.x

Client: Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient

Service ID: discovery

Version: 2015-11-01

This page describes the parameters and results for the operations of the AWS Application Discovery Service (2015-11-01), and shows how to use the Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient object to call the described operations. This documentation is specific to the 2015-11-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateConfigurationItemsToApplication ( array $params = [] )
Associates one or more configuration items with an application.
BatchDeleteImportData ( array $params = [] )
Deletes one or more import tasks, each identified by their import ID.
CreateApplication ( array $params = [] )
Creates an application with the given name and description.
CreateTags ( array $params = [] )
Creates one or more tags for configuration items.
DeleteApplications ( array $params = [] )
Deletes a list of applications and their associations with configuration items.
DeleteTags ( array $params = [] )
Deletes the association between configuration items and one or more tags.
DescribeAgents ( array $params = [] )
Lists agents or connectors as specified by ID or other filters.
DescribeConfigurations ( array $params = [] )
Retrieves attributes for a list of configuration item IDs.
DescribeContinuousExports ( array $params = [] )
Lists exports as specified by ID.
DescribeExportConfigurations ( array $params = [] )
DescribeExportConfigurations is deprecated.
DescribeExportTasks ( array $params = [] )
Retrieve status of one or more export tasks.
DescribeImportTasks ( array $params = [] )
Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
DescribeTags ( array $params = [] )
Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.
DisassociateConfigurationItemsFromApplication ( array $params = [] )
Disassociates one or more configuration items from an application.
ExportConfigurations ( array $params = [] )
Deprecated.
GetDiscoverySummary ( array $params = [] )
Retrieves a short summary of discovered assets.
ListConfigurations ( array $params = [] )
Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType.
ListServerNeighbors ( array $params = [] )
Retrieves a list of servers that are one network hop away from a specified server.
StartContinuousExport ( array $params = [] )
Start the continuous flow of agent's discovered data into Amazon Athena.
StartDataCollectionByAgentIds ( array $params = [] )
Instructs the specified agents or connectors to start collecting data.
StartExportTask ( array $params = [] )
Begins the export of discovered data to an S3 bucket.
StartImportTask ( array $params = [] )
Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent.
StopContinuousExport ( array $params = [] )
Stop the continuous flow of agent's discovered data into Amazon Athena.
StopDataCollectionByAgentIds ( array $params = [] )
Instructs the specified agents or connectors to stop collecting data.
UpdateApplication ( array $params = [] )
Updates metadata about an application.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeContinuousExports
DescribeImportTasks

Operations

AssociateConfigurationItemsToApplication

$result = $client->associateConfigurationItemsToApplication([/* ... */]);
$promise = $client->associateConfigurationItemsToApplicationAsync([/* ... */]);

Associates one or more configuration items with an application.

Parameter Syntax

$result = $client->associateConfigurationItemsToApplication([
    'applicationConfigurationId' => '<string>', // REQUIRED
    'configurationIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

applicationConfigurationId

Required: Yes
Type: string

The configuration ID of an application with which items are to be associated.

configurationIds

Required: Yes
Type: Array of strings

The ID of each configuration item to be associated with an application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

BatchDeleteImportData

$result = $client->batchDeleteImportData([/* ... */]);
$promise = $client->batchDeleteImportDataAsync([/* ... */]);

Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.

Amazon Web Services Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.

Parameter Syntax

$result = $client->batchDeleteImportData([
    'importTaskIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

importTaskIds

Required: Yes
Type: Array of strings

The IDs for the import tasks that you want to delete.

Result Syntax

[
    'errors' => [
        [
            'errorCode' => 'NOT_FOUND|INTERNAL_SERVER_ERROR|OVER_LIMIT',
            'errorDescription' => '<string>',
            'importTaskId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

errors

Type: Array of BatchDeleteImportDataError structures

Error messages returned for each import task that you deleted as a response for this command.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an application with the given name and description.

Parameter Syntax

$result = $client->createApplication([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

Type: string

Description of the application to be created.

name

Required: Yes
Type: string

Name of the application to be created.

Result Syntax

[
    'configurationId' => '<string>',
]

Result Details

Members

configurationId

Type: string

Configuration ID of an application to be created.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

CreateTags

$result = $client->createTags([/* ... */]);
$promise = $client->createTagsAsync([/* ... */]);

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

Do not store sensitive information (like personal data) in tags.

Parameter Syntax

$result = $client->createTags([
    'configurationIds' => ['<string>', ...], // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

configurationIds

Required: Yes
Type: Array of strings

A list of configuration items that you want to tag.

tags

Required: Yes
Type: Array of Tag structures

Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

{"key": "serverType", "value": "webServer"}

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DeleteApplications

$result = $client->deleteApplications([/* ... */]);
$promise = $client->deleteApplicationsAsync([/* ... */]);

Deletes a list of applications and their associations with configuration items.

Parameter Syntax

$result = $client->deleteApplications([
    'configurationIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

configurationIds

Required: Yes
Type: Array of strings

Configuration ID of an application to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DeleteTags

$result = $client->deleteTags([/* ... */]);
$promise = $client->deleteTagsAsync([/* ... */]);

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

Parameter Syntax

$result = $client->deleteTags([
    'configurationIds' => ['<string>', ...], // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

configurationIds

Required: Yes
Type: Array of strings

A list of configuration items with tags that you want to delete.

tags

Type: Array of Tag structures

Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example:

{"key": "serverType", "value": "webServer"}

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeAgents

$result = $client->describeAgents([/* ... */]);
$promise = $client->describeAgentsAsync([/* ... */]);

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.

Parameter Syntax

$result = $client->describeAgents([
    'agentIds' => ['<string>', ...],
    'filters' => [
        [
            'condition' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

agentIds

Type: Array of strings

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your Amazon Web Services user account.

filters

Type: Array of Filter structures

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

maxResults

Type: int

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

nextToken

Type: string

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Result Syntax

[
    'agentsInfo' => [
        [
            'agentId' => '<string>',
            'agentNetworkInfoList' => [
                [
                    'ipAddress' => '<string>',
                    'macAddress' => '<string>',
                ],
                // ...
            ],
            'agentType' => '<string>',
            'collectionStatus' => '<string>',
            'connectorId' => '<string>',
            'health' => 'HEALTHY|UNHEALTHY|RUNNING|UNKNOWN|BLACKLISTED|SHUTDOWN',
            'hostName' => '<string>',
            'lastHealthPingTime' => '<string>',
            'registeredTime' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

agentsInfo

Type: Array of AgentInfo structures

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.

nextToken

Type: string

Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeConfigurations

$result = $client->describeConfigurations([/* ... */]);
$promise = $client->describeConfigurationsAsync([/* ... */]);

Retrieves attributes for a list of configuration item IDs.

All of the supplied IDs must be for the same asset type from one of the following:

server
application
process
connection

Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

Parameter Syntax

$result = $client->describeConfigurations([
    'configurationIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

configurationIds

Required: Yes
Type: Array of strings

One or more configuration IDs.

Result Syntax

[
    'configurations' => [
        ['<string>', ...],
        // ...
    ],
]

Result Details

Members

configurations

Type: Array of stringss

A key in the response map. The value is an array of data.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeContinuousExports

$result = $client->describeContinuousExports([/* ... */]);
$promise = $client->describeContinuousExportsAsync([/* ... */]);

Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.

Parameter Syntax

$result = $client->describeContinuousExports([
    'exportIds' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

exportIds

Type: Array of strings

The unique IDs assigned to the exports.

maxResults

Type: int

A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

nextToken

Type: string

The token from the previous call to DescribeExportTasks.

Result Syntax

[
    'descriptions' => [
        [
            'dataSource' => 'AGENT',
            'exportId' => '<string>',
            's3Bucket' => '<string>',
            'schemaStorageConfig' => ['<string>', ...],
            'startTime' => <DateTime>,
            'status' => 'START_IN_PROGRESS|START_FAILED|ACTIVE|ERROR|STOP_IN_PROGRESS|STOP_FAILED|INACTIVE',
            'statusDetail' => '<string>',
            'stopTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

descriptions

Type: Array of ContinuousExportDescription structures

A list of continuous export descriptions.

nextToken

Type: string

The token from the previous call to DescribeExportTasks.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
OperationNotPermittedException:
This operation is not permitted.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeExportConfigurations

$result = $client->describeExportConfigurations([/* ... */]);
$promise = $client->describeExportConfigurationsAsync([/* ... */]);

DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

Parameter Syntax

$result = $client->describeExportConfigurations([
    'exportIds' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

exportIds

Type: Array of strings

A list of continuous export IDs to search for.

maxResults

Type: int

A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

nextToken

Type: string

The token from the previous call to describe-export-tasks.

Result Syntax

[
    'exportsInfo' => [
        [
            'configurationsDownloadUrl' => '<string>',
            'exportId' => '<string>',
            'exportRequestTime' => <DateTime>,
            'exportStatus' => 'FAILED|SUCCEEDED|IN_PROGRESS',
            'isTruncated' => true || false,
            'requestedEndTime' => <DateTime>,
            'requestedStartTime' => <DateTime>,
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

exportsInfo

Type: Array of ExportInfo structures

nextToken

Type: string

The token from the previous call to describe-export-tasks.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeExportTasks

$result = $client->describeExportTasks([/* ... */]);
$promise = $client->describeExportTasksAsync([/* ... */]);

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

Parameter Syntax

$result = $client->describeExportTasks([
    'exportIds' => ['<string>', ...],
    'filters' => [
        [
            'condition' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

exportIds

Type: Array of strings

One or more unique identifiers used to query the status of an export request.

filters

Type: Array of ExportFilter structures

One or more filters.

AgentId - ID of the agent whose collected data will be exported

maxResults

Type: int

The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.

nextToken

Type: string

The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Result Syntax

[
    'exportsInfo' => [
        [
            'configurationsDownloadUrl' => '<string>',
            'exportId' => '<string>',
            'exportRequestTime' => <DateTime>,
            'exportStatus' => 'FAILED|SUCCEEDED|IN_PROGRESS',
            'isTruncated' => true || false,
            'requestedEndTime' => <DateTime>,
            'requestedStartTime' => <DateTime>,
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

exportsInfo

Type: Array of ExportInfo structures

Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

nextToken

Type: string

The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeImportTasks

$result = $client->describeImportTasks([/* ... */]);
$promise = $client->describeImportTasksAsync([/* ... */]);

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Parameter Syntax

$result = $client->describeImportTasks([
    'filters' => [
        [
            'name' => 'IMPORT_TASK_ID|STATUS|NAME',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of ImportTaskFilter structures

An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren't supported for filters.

maxResults

Type: int

The maximum number of results that you want this request to return, up to 100.

nextToken

Type: string

The token to request a specific page of results.

Result Syntax

[
    'nextToken' => '<string>',
    'tasks' => [
        [
            'applicationImportFailure' => <integer>,
            'applicationImportSuccess' => <integer>,
            'clientRequestToken' => '<string>',
            'errorsAndFailedEntriesZip' => '<string>',
            'importCompletionTime' => <DateTime>,
            'importDeletedTime' => <DateTime>,
            'importRequestTime' => <DateTime>,
            'importTaskId' => '<string>',
            'importUrl' => '<string>',
            'name' => '<string>',
            'serverImportFailure' => <integer>,
            'serverImportSuccess' => <integer>,
            'status' => 'IMPORT_IN_PROGRESS|IMPORT_COMPLETE|IMPORT_COMPLETE_WITH_ERRORS|IMPORT_FAILED|IMPORT_FAILED_SERVER_LIMIT_EXCEEDED|IMPORT_FAILED_RECORD_LIMIT_EXCEEDED|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_FAILED_LIMIT_EXCEEDED|INTERNAL_ERROR',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The token to request the next page of results.

tasks

Type: Array of ImportTask structures

A returned array of import tasks that match any applied filters, up to the specified number of maximum results.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DescribeTags

$result = $client->describeTags([/* ... */]);
$promise = $client->describeTagsAsync([/* ... */]);

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.

There are three valid tag filter names:

tagKey
tagValue
configurationId

Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.

Parameter Syntax

$result = $client->describeTags([
    'filters' => [
        [
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of TagFilter structures

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

maxResults

Type: int

The total number of items to return in a single page of output. The maximum value is 100.

nextToken

Type: string

A token to start the list. Use this token to get the next set of results.

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'configurationId' => '<string>',
            'configurationType' => 'SERVER|PROCESS|CONNECTION|APPLICATION',
            'key' => '<string>',
            'timeOfCreation' => <DateTime>,
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The call returns a token. Use this token to get the next set of results.

tags

Type: Array of ConfigurationTag structures

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

DisassociateConfigurationItemsFromApplication

$result = $client->disassociateConfigurationItemsFromApplication([/* ... */]);
$promise = $client->disassociateConfigurationItemsFromApplicationAsync([/* ... */]);

Disassociates one or more configuration items from an application.

Parameter Syntax

$result = $client->disassociateConfigurationItemsFromApplication([
    'applicationConfigurationId' => '<string>', // REQUIRED
    'configurationIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

applicationConfigurationId

Required: Yes
Type: string

Configuration ID of an application from which each item is disassociated.

configurationIds

Required: Yes
Type: Array of strings

Configuration ID of each item to be disassociated from an application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

ExportConfigurations

$result = $client->exportConfigurations([/* ... */]);
$promise = $client->exportConfigurationsAsync([/* ... */]);

Deprecated. Use StartExportTask instead.

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

Parameter Syntax

$result = $client->exportConfigurations([
]);

Parameter Details

Members

Result Syntax

[
    'exportId' => '<string>',
]

Result Details

Members

exportId

Type: string

A unique identifier that you can use to query the export status.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
OperationNotPermittedException:
This operation is not permitted.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

GetDiscoverySummary

$result = $client->getDiscoverySummary([/* ... */]);
$promise = $client->getDiscoverySummaryAsync([/* ... */]);

Retrieves a short summary of discovered assets.

This API operation takes no request parameters and is called as is at the command prompt as shown in the example.

Parameter Syntax

$result = $client->getDiscoverySummary([
]);

Parameter Details

Members

Result Syntax

[
    'agentSummary' => [
        'activeAgents' => <integer>,
        'blackListedAgents' => <integer>,
        'healthyAgents' => <integer>,
        'shutdownAgents' => <integer>,
        'totalAgents' => <integer>,
        'unhealthyAgents' => <integer>,
        'unknownAgents' => <integer>,
    ],
    'agentlessCollectorSummary' => [
        'activeAgentlessCollectors' => <integer>,
        'denyListedAgentlessCollectors' => <integer>,
        'healthyAgentlessCollectors' => <integer>,
        'shutdownAgentlessCollectors' => <integer>,
        'totalAgentlessCollectors' => <integer>,
        'unhealthyAgentlessCollectors' => <integer>,
        'unknownAgentlessCollectors' => <integer>,
    ],
    'applications' => <integer>,
    'connectorSummary' => [
        'activeConnectors' => <integer>,
        'blackListedConnectors' => <integer>,
        'healthyConnectors' => <integer>,
        'shutdownConnectors' => <integer>,
        'totalConnectors' => <integer>,
        'unhealthyConnectors' => <integer>,
        'unknownConnectors' => <integer>,
    ],
    'meCollectorSummary' => [
        'activeMeCollectors' => <integer>,
        'denyListedMeCollectors' => <integer>,
        'healthyMeCollectors' => <integer>,
        'shutdownMeCollectors' => <integer>,
        'totalMeCollectors' => <integer>,
        'unhealthyMeCollectors' => <integer>,
        'unknownMeCollectors' => <integer>,
    ],
    'servers' => <integer>,
    'serversMappedToApplications' => <integer>,
    'serversMappedtoTags' => <integer>,
]

Result Details

Members

agentSummary

Type: CustomerAgentInfo structure

Details about discovered agents, including agent status and health.

agentlessCollectorSummary

Type: CustomerAgentlessCollectorInfo structure

applications

Type: long (int|float)

The number of applications discovered.

connectorSummary

Type: CustomerConnectorInfo structure

Details about discovered connectors, including connector status and health.

meCollectorSummary

Type: CustomerMeCollectorInfo structure

Details about Migration Evaluator collectors, including collector status and health.

servers

Type: long (int|float)

The number of servers discovered.

serversMappedToApplications

Type: long (int|float)

The number of servers mapped to applications.

serversMappedtoTags

Type: long (int|float)

The number of servers mapped to tags.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

ListConfigurations

$result = $client->listConfigurations([/* ... */]);
$promise = $client->listConfigurationsAsync([/* ... */]);

Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.

Parameter Syntax

$result = $client->listConfigurations([
    'configurationType' => 'SERVER|PROCESS|CONNECTION|APPLICATION', // REQUIRED
    'filters' => [
        [
            'condition' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'orderBy' => [
        [
            'fieldName' => '<string>', // REQUIRED
            'sortOrder' => 'ASC|DESC',
        ],
        // ...
    ],
]);

Parameter Details

Members

configurationType

Required: Yes
Type: string

A valid configuration identified by Application Discovery Service.

filters

Type: Array of Filter structures

You can filter the request using various logical operators and a key-value format. For example:

{"key": "serverType", "value": "webServer"}

For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

maxResults

Type: int

The total number of items to return. The maximum value is 100.

nextToken

Type: string

Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

orderBy

Type: Array of OrderByElement structures

Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

Result Syntax

[
    'configurations' => [
        ['<string>', ...],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

configurations

Type: Array of stringss

Returns configuration details, including the configuration ID, attribute names, and attribute values.

nextToken

Type: string

Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

ListServerNeighbors

$result = $client->listServerNeighbors([/* ... */]);
$promise = $client->listServerNeighborsAsync([/* ... */]);

Retrieves a list of servers that are one network hop away from a specified server.

Parameter Syntax

$result = $client->listServerNeighbors([
    'configurationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'neighborConfigurationIds' => ['<string>', ...],
    'nextToken' => '<string>',
    'portInformationNeeded' => true || false,
]);

Parameter Details

Members

configurationId

Required: Yes
Type: string

Configuration ID of the server for which neighbors are being listed.

maxResults

Type: int

Maximum number of results to return in a single page of output.

neighborConfigurationIds

Type: Array of strings

List of configuration IDs to test for one-hop-away.

nextToken

Type: string

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

portInformationNeeded

Type: boolean

Flag to indicate if port and protocol information is needed as part of the response.

Result Syntax

[
    'knownDependencyCount' => <integer>,
    'neighbors' => [
        [
            'connectionsCount' => <integer>,
            'destinationPort' => <integer>,
            'destinationServerId' => '<string>',
            'sourceServerId' => '<string>',
            'transportProtocol' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

knownDependencyCount

Type: long (int|float)

Count of distinct servers that are one hop away from the given server.

neighbors

Required: Yes
Type: Array of NeighborConnectionDetail structures

List of distinct servers that are one hop away from the given server.

nextToken

Type: string

Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

StartContinuousExport

$result = $client->startContinuousExport([/* ... */]);
$promise = $client->startContinuousExportAsync([/* ... */]);

Start the continuous flow of agent's discovered data into Amazon Athena.

Parameter Syntax

$result = $client->startContinuousExport([
]);

Parameter Details

Members

Result Syntax

[
    'dataSource' => 'AGENT',
    'exportId' => '<string>',
    's3Bucket' => '<string>',
    'schemaStorageConfig' => ['<string>', ...],
    'startTime' => <DateTime>,
]

Result Details

Members

dataSource

Type: string

The type of data collector used to gather this data (currently only offered for AGENT).

exportId

Type: string

The unique ID assigned to this export.

s3Bucket

Type: string

The name of the s3 bucket where the export data parquet files are stored.

schemaStorageConfig

Type: Associative array of custom strings keys (DatabaseName) to strings

A dictionary which describes how the data is stored.

databaseName - the name of the Glue database used to store the schema.

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp representing when the continuous export was started.

Errors

ConflictErrorException:
AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
OperationNotPermittedException:
This operation is not permitted.
ResourceInUseException:
This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

StartDataCollectionByAgentIds

$result = $client->startDataCollectionByAgentIds([/* ... */]);
$promise = $client->startDataCollectionByAgentIdsAsync([/* ... */]);

Instructs the specified agents or connectors to start collecting data.

Parameter Syntax

$result = $client->startDataCollectionByAgentIds([
    'agentIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

agentIds

Required: Yes
Type: Array of strings

The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your Amazon Web Services account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

Result Syntax

[
    'agentsConfigurationStatus' => [
        [
            'agentId' => '<string>',
            'description' => '<string>',
            'operationSucceeded' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

agentsConfigurationStatus

Type: Array of AgentConfigurationStatus structures

Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

StartExportTask

$result = $client->startExportTask([/* ... */]);
$promise = $client->startExportTaskAsync([/* ... */]);

Begins the export of discovered data to an S3 bucket.

If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports.

If you do not include an agentIds filter, summary data is exported that includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export of summary data is limited to two exports per day.

Parameter Syntax

$result = $client->startExportTask([
    'endTime' => <integer || string || DateTime>,
    'exportDataFormat' => ['<string>', ...],
    'filters' => [
        [
            'condition' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

endTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

exportDataFormat

Type: Array of strings

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

filters

Type: Array of ExportFilter structures

If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

Result Syntax

[
    'exportId' => '<string>',
]

Result Details

Members

exportId

Type: string

A unique identifier used to query the status of an export request.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
OperationNotPermittedException:
This operation is not permitted.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

StartImportTask

$result = $client->startImportTask([/* ... */]);
$promise = $client->startImportTaskAsync([/* ... */]);

Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.

To start an import request, do this:

Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
Fill out the template with your server and application data.
Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.
Use the console or the StartImportTask command with the Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file.

For more information, including step-by-step procedures, see Migration Hub Import in the Amazon Web Services Application Discovery Service User Guide.

There are limits to the number of import tasks you can create (and delete) in an Amazon Web Services account. For more information, see Amazon Web Services Application Discovery Service Limits in the Amazon Web Services Application Discovery Service User Guide.

Parameter Syntax

$result = $client->startImportTask([
    'clientRequestToken' => '<string>',
    'importUrl' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientRequestToken

Type: string

Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.

Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token.

importUrl

Required: Yes
Type: string

The URL for your import file that you've uploaded to Amazon S3.

If you're using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

name

Required: Yes
Type: string

A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

Result Syntax

[
    'task' => [
        'applicationImportFailure' => <integer>,
        'applicationImportSuccess' => <integer>,
        'clientRequestToken' => '<string>',
        'errorsAndFailedEntriesZip' => '<string>',
        'importCompletionTime' => <DateTime>,
        'importDeletedTime' => <DateTime>,
        'importRequestTime' => <DateTime>,
        'importTaskId' => '<string>',
        'importUrl' => '<string>',
        'name' => '<string>',
        'serverImportFailure' => <integer>,
        'serverImportSuccess' => <integer>,
        'status' => 'IMPORT_IN_PROGRESS|IMPORT_COMPLETE|IMPORT_COMPLETE_WITH_ERRORS|IMPORT_FAILED|IMPORT_FAILED_SERVER_LIMIT_EXCEEDED|IMPORT_FAILED_RECORD_LIMIT_EXCEEDED|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|DELETE_FAILED_LIMIT_EXCEEDED|INTERNAL_ERROR',
    ],
]

Result Details

Members

task

Type: ImportTask structure

An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Errors

ResourceInUseException:
This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.
AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

StopContinuousExport

$result = $client->stopContinuousExport([/* ... */]);
$promise = $client->stopContinuousExportAsync([/* ... */]);

Stop the continuous flow of agent's discovered data into Amazon Athena.

Parameter Syntax

$result = $client->stopContinuousExport([
    'exportId' => '<string>', // REQUIRED
]);

Parameter Details

Members

exportId

Required: Yes
Type: string

The unique ID assigned to this export.

Result Syntax

[
    'startTime' => <DateTime>,
    'stopTime' => <DateTime>,
]

Result Details

Members

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp that represents when this continuous export started collecting data.

stopTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp that represents when this continuous export was stopped.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
OperationNotPermittedException:
This operation is not permitted.
ResourceNotFoundException:
The specified configuration ID was not located. Verify the configuration ID and try again.
ResourceInUseException:
This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

StopDataCollectionByAgentIds

$result = $client->stopDataCollectionByAgentIds([/* ... */]);
$promise = $client->stopDataCollectionByAgentIdsAsync([/* ... */]);

Instructs the specified agents or connectors to stop collecting data.

Parameter Syntax

$result = $client->stopDataCollectionByAgentIds([
    'agentIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

agentIds

Required: Yes
Type: Array of strings

The IDs of the agents or connectors from which to stop collecting data.

Result Syntax

[
    'agentsConfigurationStatus' => [
        [
            'agentId' => '<string>',
            'description' => '<string>',
            'operationSucceeded' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

agentsConfigurationStatus

Type: Array of AgentConfigurationStatus structures

Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates metadata about an application.

Parameter Syntax

$result = $client->updateApplication([
    'configurationId' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>',
]);

Parameter Details

Members

configurationId

Required: Yes
Type: string

Configuration ID of the application to be updated.

description

Type: string

New description of the application to be updated.

name

Type: string

New name of the application to be updated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AuthorizationErrorException:
The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterException:
One or more parameters are not valid. Verify the parameters and try again.
InvalidParameterValueException:
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
ServerInternalErrorException:
The server experienced an internal error. Try again.
HomeRegionNotSetException:
The home region is not set. Set the home region to continue.

Shapes

AgentConfigurationStatus

Description

Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.

Members

agentId

Type: string

The agent/connector ID.

description

Type: string

A description of the operation performed.

operationSucceeded

Type: boolean

Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.

AgentInfo

Description

Information about agents or connectors associated with the user’s Amazon Web Services account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.

Members

agentId

Type: string

The agent or connector ID.

agentNetworkInfoList

Type: Array of AgentNetworkInfo structures

Network details about the host where the agent or connector resides.

agentType

Type: string

Type of agent.

collectionStatus

Type: string

Status of the collection process for an agent or connector.

connectorId

Type: string

The ID of the connector.

health

Type: string

The health of the agent or connector.

hostName

Type: string

The name of the host where the agent or connector resides. The host can be a server or virtual machine.

lastHealthPingTime

Type: string

Time since agent or connector health was reported.

registeredTime

Type: string

Agent's first registration timestamp in UTC.

version

Type: string

The agent or connector version.

AgentNetworkInfo

Description

Network details about the host where the agent/connector resides.

Members

ipAddress

Type: string

The IP address for the host where the agent/connector resides.

macAddress

Type: string

The MAC address for the host where the agent/connector resides.

AuthorizationErrorException

Description

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.

Members

message

Type: string

BatchDeleteImportDataError

Description

Error messages returned for each import task that you deleted as a response for this command.

Members

errorCode

Type: string

The type of error that occurred for a specific import task.

errorDescription

Type: string

The description of the error that occurred for a specific import task.

importTaskId

Type: string

The unique import ID associated with the error that occurred.

ConfigurationTag

Description

Tags for a configuration item. Tags are metadata that help you categorize IT assets.

Members

configurationId

Type: string

The configuration ID for the item to tag. You can specify a list of keys and values.

configurationType

Type: string

A type of IT asset to tag.

key

Type: string

A type of tag on which to filter. For example, serverType.

timeOfCreation

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the configuration tag was created in Coordinated Universal Time (UTC).

value

Type: string

A value on which to filter. For example key = serverType and value = web server.

ConflictErrorException

Description

Members

message

Type: string

ContinuousExportDescription

Description

A list of continuous export descriptions.

Members

dataSource

Type: string

The type of data collector used to gather this data (currently only offered for AGENT).

exportId

Type: string

The unique ID assigned to this export.

s3Bucket

Type: string

The name of the s3 bucket where the export data parquet files are stored.

schemaStorageConfig

Type: Associative array of custom strings keys (DatabaseName) to strings

An object which describes how the data is stored.

databaseName - the name of the Glue database used to store the schema.

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp representing when the continuous export was started.

status

Type: string

Describes the status of the export. Can be one of the following values:

START_IN_PROGRESS - setting up resources to start continuous export.
START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.
ACTIVE - data is being exported to the customer bucket.
ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.
STOP_IN_PROGRESS - stopping the export.
STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.
INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

statusDetail

Type: string

Contains information about any errors that have occurred. This data type can have the following values:

ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery Service User Guide.
DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide.
FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams.
INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact Amazon Web Services Support.
LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions to start continuous export. For more information, see Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the Amazon Web Services Lake Formation Developer Guide.

You can use one of the following two ways to resolve this issue.
1. If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer Guide.
2. You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see Granting Database Permissions in the Lake Formation Developer Guide.
  1. AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives the role database creation ability and implicit permissions for any created tables. For more information, see Implicit Lake Formation Permissions in the Lake Formation Developer Guide.
  2. AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database.
S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.
S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.

stopTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that represents when this continuous export was stopped.

CustomerAgentInfo

Description

Inventory data for installed discovery agents.

Members

activeAgents

Required: Yes
Type: int

Number of active discovery agents.

blackListedAgents

Required: Yes
Type: int

Number of blacklisted discovery agents.

healthyAgents

Required: Yes
Type: int

Number of healthy discovery agents

shutdownAgents

Required: Yes
Type: int

Number of discovery agents with status SHUTDOWN.

totalAgents

Required: Yes
Type: int

Total number of discovery agents.

unhealthyAgents

Required: Yes
Type: int

Number of unhealthy discovery agents.

unknownAgents

Required: Yes
Type: int

Number of unknown discovery agents.

CustomerAgentlessCollectorInfo

Members

activeAgentlessCollectors

Required: Yes
Type: int

denyListedAgentlessCollectors

Required: Yes
Type: int

healthyAgentlessCollectors

Required: Yes
Type: int

shutdownAgentlessCollectors

Required: Yes
Type: int

totalAgentlessCollectors

Required: Yes
Type: int

unhealthyAgentlessCollectors

Required: Yes
Type: int

unknownAgentlessCollectors

Required: Yes
Type: int

CustomerConnectorInfo

Description

Inventory data for installed discovery connectors.

Members

activeConnectors

Required: Yes
Type: int

Number of active discovery connectors.

blackListedConnectors

Required: Yes
Type: int

Number of blacklisted discovery connectors.

healthyConnectors

Required: Yes
Type: int

Number of healthy discovery connectors.

shutdownConnectors

Required: Yes
Type: int

Number of discovery connectors with status SHUTDOWN,

totalConnectors

Required: Yes
Type: int

Total number of discovery connectors.

unhealthyConnectors

Required: Yes
Type: int

Number of unhealthy discovery connectors.

unknownConnectors

Required: Yes
Type: int

Number of unknown discovery connectors.

CustomerMeCollectorInfo

Description

The inventory data for installed Migration Evaluator collectors.

Members

activeMeCollectors

Required: Yes
Type: int

The number of active Migration Evaluator collectors.

denyListedMeCollectors

Required: Yes
Type: int

The number of deny-listed Migration Evaluator collectors.

healthyMeCollectors

Required: Yes
Type: int

The number of healthy Migration Evaluator collectors.

shutdownMeCollectors

Required: Yes
Type: int

The number of Migration Evaluator collectors with SHUTDOWN status.

totalMeCollectors

Required: Yes
Type: int

The total number of Migration Evaluator collectors.

unhealthyMeCollectors

Required: Yes
Type: int

The number of unhealthy Migration Evaluator collectors.

unknownMeCollectors

Required: Yes
Type: int

The number of unknown Migration Evaluator collectors.

ExportFilter

Description

Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.

Members

condition

Required: Yes
Type: string

Supported condition: EQUALS

name

Required: Yes
Type: string

A single ExportFilter name. Supported filters: agentIds.

values

Required: Yes
Type: Array of strings

A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action. Typically an ADS agent ID is in the form o-0123456789abcdef0.

ExportInfo

Description

Information regarding the export status of discovered data. The value is an array of objects.

Members

configurationsDownloadUrl

Type: string

A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.

exportId

Required: Yes
Type: string

A unique identifier used to query an export.

exportRequestTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the data export was initiated.

exportStatus

Required: Yes
Type: string

The status of the data export job.

isTruncated

Type: boolean

If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate.

requestedEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.

requestedStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.

statusMessage

Required: Yes
Type: string

A status message provided for API callers.

Filter

Description

A filter that can use conditional operators.

For more information about filters, see Querying Discovered Configuration Items in the Amazon Web Services Application Discovery Service User Guide.

Members

condition

Required: Yes
Type: string

A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

name

Required: Yes
Type: string

The name of the filter.

values

Required: Yes
Type: Array of strings

A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

HomeRegionNotSetException

Description

The home region is not set. Set the home region to continue.

Members

message

Type: string

ImportTask

Description

An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Members

applicationImportFailure

Type: int

The total number of application records in the import file that failed to be imported.

applicationImportSuccess

Type: int

The total number of application records in the import file that were successfully imported.

clientRequestToken

Type: string

A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.

errorsAndFailedEntriesZip

Type: string

A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.

This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.

If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.

importCompletionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the import task request finished, presented in the Unix time stamp format.

importDeletedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the import task request was deleted, presented in the Unix time stamp format.

importRequestTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the import task request was made, presented in the Unix time stamp format.

importTaskId

Type: string

The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an Amazon Web Services account.

importUrl

Type: string

The URL for your import file that you've uploaded to Amazon S3.

name

Type: string

A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

serverImportFailure

Type: int

The total number of server records in the import file that failed to be imported.

serverImportSuccess

Type: int

The total number of server records in the import file that were successfully imported.

status

Type: string

The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.

ImportTaskFilter

Description

A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.

When filtering by import status, all other filter values are ignored.

Members

name

Type: string

The name, status, or import task ID for a specific import task.

values

Type: Array of strings

An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries.

InvalidParameterException

Description

One or more parameters are not valid. Verify the parameters and try again.

Members

message

Type: string

InvalidParameterValueException

Description

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

Members

message

Type: string

NeighborConnectionDetail

Description

Details about neighboring servers.

Members

connectionsCount

Required: Yes
Type: long (int|float)

The number of open network connections with the neighboring server.

destinationPort

Type: int

The destination network port for the connection.

destinationServerId

Required: Yes
Type: string

The ID of the server that accepted the network connection.

sourceServerId

Required: Yes
Type: string

The ID of the server that opened the network connection.

transportProtocol

Type: string

The network protocol used for the connection.

OperationNotPermittedException

Description

This operation is not permitted.

Members

message

Type: string

OrderByElement

Description

A field and direction for ordered output.

Members

fieldName

Required: Yes
Type: string

The field on which to order.

sortOrder

Type: string

Ordering direction.

ResourceInUseException

Description

This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.

Members

message

Type: string

ResourceNotFoundException

Description

The specified configuration ID was not located. Verify the configuration ID and try again.

Members

message

Type: string

ServerInternalErrorException

Description

The server experienced an internal error. Try again.

Members

message

Type: string

TagFilter

Description

The tag filter. Valid names are: tagKey, tagValue, configurationId.

Members

name

Required: Yes
Type: string

A name of the tag filter.

values

Required: Yes
Type: Array of strings

Values for the tag filter.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Application Discovery Service 2015-11-01

Operation Summary

Paginators

Operations

AssociateConfigurationItemsToApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

BatchDeleteImportData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteApplications

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeAgents

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeConfigurations

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeContinuousExports

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeExportConfigurations

Parameter Syntax