Table of Contents
ApplicationDiscoveryService.Client¶A low-level client representing AWS Application Discovery Service
Amazon Web Services Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ. Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:
Recommendations
We recommend that you use agent-based discovery for non-VMware environments, and whenever you want to collect information about network dependencies. You can run agent-based and agentless discovery simultaneously. Use agentless discovery to complete the initial infrastructure assessment quickly, and then install agents on select hosts to collect additional information.
Working With This Guide
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
Note
HomeRegionNotSetException error is returned.InvalidInputException is returned.GetHomeRegion to obtain the latest Migration Hub home region.This guide is intended for use with the Amazon Web Services Application Discovery Service User Guide.
Warning
All data is handled according to the Amazon Web Services Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.
import boto3
client = boto3.client('discovery')
These are the available methods:
associate_configuration_items_to_application()batch_delete_import_data()can_paginate()close()create_application()create_tags()delete_applications()delete_tags()describe_agents()describe_configurations()describe_continuous_exports()describe_export_configurations()describe_export_tasks()describe_import_tasks()describe_tags()disassociate_configuration_items_from_application()export_configurations()get_discovery_summary()get_paginator()get_waiter()list_configurations()list_server_neighbors()start_continuous_export()start_data_collection_by_agent_ids()start_export_task()start_import_task()stop_continuous_export()stop_data_collection_by_agent_ids()update_application()associate_configuration_items_to_application(**kwargs)¶Associates one or more configuration items with an application.
See also: AWS API Documentation
Request Syntax
response = client.associate_configuration_items_to_application(
applicationConfigurationId='string',
configurationIds=[
'string',
]
)
[REQUIRED]
The configuration ID of an application with which items are to be associated.
[REQUIRED]
The ID of each configuration item to be associated with an application.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionbatch_delete_import_data(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_import_data(
importTaskIds=[
'string',
]
)
[REQUIRED]
The IDs for the import tasks that you want to delete.
{
'errors': [
{
'importTaskId': 'string',
'errorCode': 'NOT_FOUND'|'INTERNAL_SERVER_ERROR'|'OVER_LIMIT',
'errorDescription': 'string'
},
]
}
Response Structure
Error messages returned for each import task that you deleted as a response for this command.
Error messages returned for each import task that you deleted as a response for this command.
The unique import ID associated with the error that occurred.
The type of error that occurred for a specific import task.
The description of the error that occurred for a specific import task.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_application(**kwargs)¶Creates an application with the given name and description.
See also: AWS API Documentation
Request Syntax
response = client.create_application(
name='string',
description='string'
)
[REQUIRED]
Name of the application to be created.
dict
Response Syntax
{
'configurationId': 'string'
}
Response Structure
(dict) --
configurationId (string) --
Configuration ID of an application to be created.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionCreates 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.
Warning
Do not store sensitive information (like personal data) in tags.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
configurationIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
A list of configuration items that you want to tag.
[REQUIRED]
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"}
Metadata that help you categorize IT assets.
Warning
Do not store sensitive information (like personal data) in tags.
The type of tag on which to filter.
A value for a tag key on which to filter.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondelete_applications(**kwargs)¶Deletes a list of applications and their associations with configuration items.
See also: AWS API Documentation
Request Syntax
response = client.delete_applications(
configurationIds=[
'string',
]
)
[REQUIRED]
Configuration ID of an application to be deleted.
{}
Response Structure
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionDeletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
configurationIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
A list of configuration items with tags that you want to delete.
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"}
Metadata that help you categorize IT assets.
Warning
Do not store sensitive information (like personal data) in tags.
The type of tag on which to filter.
A value for a tag key on which to filter.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondescribe_agents(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_agents(
agentIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string'
)
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.
You can filter the request using various logical operators and a key -value format. For example:
{"key": "collectionStatus", "value": "STARTED"}
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 .
The name of the filter.
A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
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.
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.dict
Response Syntax
{
'agentsInfo': [
{
'agentId': 'string',
'hostName': 'string',
'agentNetworkInfoList': [
{
'ipAddress': 'string',
'macAddress': 'string'
},
],
'connectorId': 'string',
'version': 'string',
'health': 'HEALTHY'|'UNHEALTHY'|'RUNNING'|'UNKNOWN'|'BLACKLISTED'|'SHUTDOWN',
'lastHealthPingTime': 'string',
'collectionStatus': 'string',
'agentType': 'string',
'registeredTime': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
agentsInfo (list) --
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.
(dict) --
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.
agentId (string) --
The agent or connector ID.
hostName (string) --
The name of the host where the agent or connector resides. The host can be a server or virtual machine.
agentNetworkInfoList (list) --
Network details about the host where the agent or connector resides.
(dict) --
Network details about the host where the agent/connector resides.
ipAddress (string) --
The IP address for the host where the agent/connector resides.
macAddress (string) --
The MAC address for the host where the agent/connector resides.
connectorId (string) --
The ID of the connector.
version (string) --
The agent or connector version.
health (string) --
The health of the agent or connector.
lastHealthPingTime (string) --
Time since agent or connector health was reported.
collectionStatus (string) --
Status of the collection process for an agent or connector.
agentType (string) --
Type of agent.
registeredTime (string) --
Agent's first registration timestamp in UTC.
nextToken (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.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondescribe_configurations(**kwargs)¶Retrieves attributes for a list of configuration item IDs.
Note
All of the supplied IDs must be for the same asset type from one of the following:
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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_configurations(
configurationIds=[
'string',
]
)
[REQUIRED]
One or more configuration IDs.
{
'configurations': [
{
'string': 'string'
},
]
}
Response Structure
A key in the response map. The value is an array of data.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondescribe_continuous_exports(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_continuous_exports(
exportIds=[
'string',
],
maxResults=123,
nextToken='string'
)
The unique IDs assigned to the exports.
DescribeExportTasks .dict
Response Syntax
{
'descriptions': [
{
'exportId': 'string',
'status': 'START_IN_PROGRESS'|'START_FAILED'|'ACTIVE'|'ERROR'|'STOP_IN_PROGRESS'|'STOP_FAILED'|'INACTIVE',
'statusDetail': 'string',
's3Bucket': 'string',
'startTime': datetime(2015, 1, 1),
'stopTime': datetime(2015, 1, 1),
'dataSource': 'AGENT',
'schemaStorageConfig': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
descriptions (list) --
A list of continuous export descriptions.
(dict) --
A list of continuous export descriptions.
exportId (string) --
The unique ID assigned to this export.
status (string) --
Describes the status of the export. Can be one of the following values:
statusDetail (string) --
Contains information about any errors that have occurred. This data type can have the following values:
s3Bucket (string) --
The name of the s3 bucket where the export data parquet files are stored.
startTime (datetime) --
The timestamp representing when the continuous export was started.
stopTime (datetime) --
The timestamp that represents when this continuous export was stopped.
dataSource (string) --
The type of data collector used to gather this data (currently only offered for AGENT).
schemaStorageConfig (dict) --
An object which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.nextToken (string) --
The token from the previous call to DescribeExportTasks .
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.OperationNotPermittedExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondescribe_export_configurations(**kwargs)¶DescribeExportConfigurationsis deprecated. Use DescribeExportTasks, instead.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_configurations(
exportIds=[
'string',
],
maxResults=123,
nextToken='string'
)
A list of continuous export IDs to search for.
dict
Response Syntax
{
'exportsInfo': [
{
'exportId': 'string',
'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
'statusMessage': 'string',
'configurationsDownloadUrl': 'string',
'exportRequestTime': datetime(2015, 1, 1),
'isTruncated': True|False,
'requestedStartTime': datetime(2015, 1, 1),
'requestedEndTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
exportsInfo (list) --
(dict) --
Information regarding the export status of discovered data. The value is an array of objects.
exportId (string) --
A unique identifier used to query an export.
exportStatus (string) --
The status of the data export job.
statusMessage (string) --
A status message provided for API callers.
configurationsDownloadUrl (string) --
A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
exportRequestTime (datetime) --
The time that the data export was initiated.
isTruncated (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 .
requestedStartTime (datetime) --
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo .
requestedEndTime (datetime) --
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo .
nextToken (string) --
The token from the previous call to describe-export-tasks.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondescribe_export_tasks(**kwargs)¶Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_tasks(
exportIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string'
)
One or more unique identifiers used to query the status of an export request.
One or more filters.
AgentId - ID of the agent whose collected data will be exportedUsed to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
A single ExportFilter name. Supported filters: agentIds .
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 .
Supported condition: EQUALS
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 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.dict
Response Syntax
{
'exportsInfo': [
{
'exportId': 'string',
'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
'statusMessage': 'string',
'configurationsDownloadUrl': 'string',
'exportRequestTime': datetime(2015, 1, 1),
'isTruncated': True|False,
'requestedStartTime': datetime(2015, 1, 1),
'requestedEndTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
exportsInfo (list) --
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.
(dict) --
Information regarding the export status of discovered data. The value is an array of objects.
exportId (string) --
A unique identifier used to query an export.
exportStatus (string) --
The status of the data export job.
statusMessage (string) --
A status message provided for API callers.
configurationsDownloadUrl (string) --
A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
exportRequestTime (datetime) --
The time that the data export was initiated.
isTruncated (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 .
requestedStartTime (datetime) --
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo .
requestedEndTime (datetime) --
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo .
nextToken (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.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondescribe_import_tasks(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_import_tasks(
filters=[
{
'name': 'IMPORT_TASK_ID'|'STATUS'|'NAME',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
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.
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.
Note
When filtering by import status, all other filter values are ignored.
The name, status, or import task ID for a specific import task.
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.
dict
Response Syntax
{
'nextToken': 'string',
'tasks': [
{
'importTaskId': 'string',
'clientRequestToken': 'string',
'name': 'string',
'importUrl': 'string',
'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',
'importRequestTime': datetime(2015, 1, 1),
'importCompletionTime': datetime(2015, 1, 1),
'importDeletedTime': datetime(2015, 1, 1),
'serverImportSuccess': 123,
'serverImportFailure': 123,
'applicationImportSuccess': 123,
'applicationImportFailure': 123,
'errorsAndFailedEntriesZip': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to request the next page of results.
tasks (list) --
A returned array of import tasks that match any applied filters, up to the specified number of maximum results.
(dict) --
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.
importTaskId (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.
clientRequestToken (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.
name (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.
importUrl (string) --
The URL for your import file that you've uploaded to Amazon S3.
status (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.
importRequestTime (datetime) --
The time that the import task request was made, presented in the Unix time stamp format.
importCompletionTime (datetime) --
The time that the import task request finished, presented in the Unix time stamp format.
importDeletedTime (datetime) --
The time that the import task request was deleted, presented in the Unix time stamp format.
serverImportSuccess (integer) --
The total number of server records in the import file that were successfully imported.
serverImportFailure (integer) --
The total number of server records in the import file that failed to be imported.
applicationImportSuccess (integer) --
The total number of application records in the import file that were successfully imported.
applicationImportFailure (integer) --
The total number of application records in the import file that failed to be imported.
errorsAndFailedEntriesZip (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.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionRetrieves 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:
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
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 .
The tag filter. Valid names are: tagKey , tagValue , configurationId .
A name of the tag filter.
Values for the tag filter.
dict
Response Syntax
{
'tags': [
{
'configurationType': 'SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
'configurationId': 'string',
'key': 'string',
'value': 'string',
'timeOfCreation': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
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.
(dict) --
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
configurationType (string) --
A type of IT asset to tag.
configurationId (string) --
The configuration ID for the item to tag. You can specify a list of keys and values.
key (string) --
A type of tag on which to filter. For example, serverType .
value (string) --
A value on which to filter. For example key = serverType and value = web server .
timeOfCreation (datetime) --
The time the configuration tag was created in Coordinated Universal Time (UTC).
nextToken (string) --
The call returns a token. Use this token to get the next set of results.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptiondisassociate_configuration_items_from_application(**kwargs)¶Disassociates one or more configuration items from an application.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_configuration_items_from_application(
applicationConfigurationId='string',
configurationIds=[
'string',
]
)
[REQUIRED]
Configuration ID of an application from which each item is disassociated.
[REQUIRED]
Configuration ID of each item to be disassociated from an application.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionexport_configurations()¶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.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.export_configurations()
{
'exportId': 'string'
}
Response Structure
A unique identifier that you can use to query the export status.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.OperationNotPermittedExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionget_discovery_summary()¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_discovery_summary()
{
'servers': 123,
'applications': 123,
'serversMappedToApplications': 123,
'serversMappedtoTags': 123,
'agentSummary': {
'activeAgents': 123,
'healthyAgents': 123,
'blackListedAgents': 123,
'shutdownAgents': 123,
'unhealthyAgents': 123,
'totalAgents': 123,
'unknownAgents': 123
},
'connectorSummary': {
'activeConnectors': 123,
'healthyConnectors': 123,
'blackListedConnectors': 123,
'shutdownConnectors': 123,
'unhealthyConnectors': 123,
'totalConnectors': 123,
'unknownConnectors': 123
},
'meCollectorSummary': {
'activeMeCollectors': 123,
'healthyMeCollectors': 123,
'denyListedMeCollectors': 123,
'shutdownMeCollectors': 123,
'unhealthyMeCollectors': 123,
'totalMeCollectors': 123,
'unknownMeCollectors': 123
},
'agentlessCollectorSummary': {
'activeAgentlessCollectors': 123,
'healthyAgentlessCollectors': 123,
'denyListedAgentlessCollectors': 123,
'shutdownAgentlessCollectors': 123,
'unhealthyAgentlessCollectors': 123,
'totalAgentlessCollectors': 123,
'unknownAgentlessCollectors': 123
}
}
Response Structure
The number of servers discovered.
The number of applications discovered.
The number of servers mapped to applications.
The number of servers mapped to tags.
Details about discovered agents, including agent status and health.
Number of active discovery agents.
Number of healthy discovery agents
Number of blacklisted discovery agents.
Number of discovery agents with status SHUTDOWN.
Number of unhealthy discovery agents.
Total number of discovery agents.
Number of unknown discovery agents.
Details about discovered connectors, including connector status and health.
Number of active discovery connectors.
Number of healthy discovery connectors.
Number of blacklisted discovery connectors.
Number of discovery connectors with status SHUTDOWN,
Number of unhealthy discovery connectors.
Total number of discovery connectors.
Number of unknown discovery connectors.
Details about Migration Evaluator collectors, including collector status and health.
The number of active Migration Evaluator collectors.
The number of healthy Migration Evaluator collectors.
The number of deny-listed Migration Evaluator collectors.
The number of Migration Evaluator collectors with SHUTDOWN status.
The number of unhealthy Migration Evaluator collectors.
The total number of Migration Evaluator collectors.
The number of unknown Migration Evaluator collectors.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_configurations(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_configurations(
configurationType='SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string',
orderBy=[
{
'fieldName': 'string',
'sortOrder': 'ASC'|'DESC'
},
]
)
[REQUIRED]
A valid configuration identified by Application Discovery Service.
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 .
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 .
The name of the filter.
A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
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.
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.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 .
A field and direction for ordered output.
The field on which to order.
Ordering direction.
dict
Response Syntax
{
'configurations': [
{
'string': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
configurations (list) --
Returns configuration details, including the configuration ID, attribute names, and attribute values.
nextToken (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.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionlist_server_neighbors(**kwargs)¶Retrieves a list of servers that are one network hop away from a specified server.
See also: AWS API Documentation
Request Syntax
response = client.list_server_neighbors(
configurationId='string',
portInformationNeeded=True|False,
neighborConfigurationIds=[
'string',
],
maxResults=123,
nextToken='string'
)
[REQUIRED]
Configuration ID of the server for which neighbors are being listed.
List of configuration IDs to test for one-hop-away.
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.dict
Response Syntax
{
'neighbors': [
{
'sourceServerId': 'string',
'destinationServerId': 'string',
'destinationPort': 123,
'transportProtocol': 'string',
'connectionsCount': 123
},
],
'nextToken': 'string',
'knownDependencyCount': 123
}
Response Structure
(dict) --
neighbors (list) --
List of distinct servers that are one hop away from the given server.
(dict) --
Details about neighboring servers.
sourceServerId (string) --
The ID of the server that opened the network connection.
destinationServerId (string) --
The ID of the server that accepted the network connection.
destinationPort (integer) --
The destination network port for the connection.
transportProtocol (string) --
The network protocol used for the connection.
connectionsCount (integer) --
The number of open network connections with the neighboring server.
nextToken (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.
knownDependencyCount (integer) --
Count of distinct servers that are one hop away from the given server.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionstart_continuous_export()¶Start the continuous flow of agent's discovered data into Amazon Athena.
See also: AWS API Documentation
Request Syntax
response = client.start_continuous_export()
{
'exportId': 'string',
's3Bucket': 'string',
'startTime': datetime(2015, 1, 1),
'dataSource': 'AGENT',
'schemaStorageConfig': {
'string': 'string'
}
}
Response Structure
The unique ID assigned to this export.
The name of the s3 bucket where the export data parquet files are stored.
The timestamp representing when the continuous export was started.
The type of data collector used to gather this data (currently only offered for AGENT).
A dictionary which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.Exceptions
ApplicationDiscoveryService.Client.exceptions.ConflictErrorExceptionApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.OperationNotPermittedExceptionApplicationDiscoveryService.Client.exceptions.ResourceInUseExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionstart_data_collection_by_agent_ids(**kwargs)¶Instructs the specified agents or connectors to start collecting data.
See also: AWS API Documentation
Request Syntax
response = client.start_data_collection_by_agent_ids(
agentIds=[
'string',
]
)
[REQUIRED]
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.
{
'agentsConfigurationStatus': [
{
'agentId': 'string',
'operationSucceeded': True|False,
'description': 'string'
},
]
}
Response Structure
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.
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.
The agent/connector ID.
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.
A description of the operation performed.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionstart_export_task(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.start_export_task(
exportDataFormat=[
'CSV'|'GRAPHML',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
The file format for the returned export data. Default value is CSV . Note: The GRAPHML option has been deprecated.
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.
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
A single ExportFilter name. Supported filters: agentIds .
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 .
Supported condition: EQUALS
dict
Response Syntax
{
'exportId': 'string'
}
Response Structure
(dict) --
exportId (string) --
A unique identifier used to query the status of an export request.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.OperationNotPermittedExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionstart_import_task(**kwargs)¶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:
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 .
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.start_import_task(
clientRequestToken='string',
name='string',
importUrl='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.
This field is autopopulated if not provided.
[REQUIRED]
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.
[REQUIRED]
The URL for your import file that you've uploaded to Amazon S3.
Note
If you're using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV
dict
Response Syntax
{
'task': {
'importTaskId': 'string',
'clientRequestToken': 'string',
'name': 'string',
'importUrl': 'string',
'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',
'importRequestTime': datetime(2015, 1, 1),
'importCompletionTime': datetime(2015, 1, 1),
'importDeletedTime': datetime(2015, 1, 1),
'serverImportSuccess': 123,
'serverImportFailure': 123,
'applicationImportSuccess': 123,
'applicationImportFailure': 123,
'errorsAndFailedEntriesZip': 'string'
}
}
Response Structure
(dict) --
task (dict) --
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.
importTaskId (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.
clientRequestToken (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.
name (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.
importUrl (string) --
The URL for your import file that you've uploaded to Amazon S3.
status (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.
importRequestTime (datetime) --
The time that the import task request was made, presented in the Unix time stamp format.
importCompletionTime (datetime) --
The time that the import task request finished, presented in the Unix time stamp format.
importDeletedTime (datetime) --
The time that the import task request was deleted, presented in the Unix time stamp format.
serverImportSuccess (integer) --
The total number of server records in the import file that were successfully imported.
serverImportFailure (integer) --
The total number of server records in the import file that failed to be imported.
applicationImportSuccess (integer) --
The total number of application records in the import file that were successfully imported.
applicationImportFailure (integer) --
The total number of application records in the import file that failed to be imported.
errorsAndFailedEntriesZip (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.
Exceptions
ApplicationDiscoveryService.Client.exceptions.ResourceInUseExceptionApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionstop_continuous_export(**kwargs)¶Stop the continuous flow of agent's discovered data into Amazon Athena.
See also: AWS API Documentation
Request Syntax
response = client.stop_continuous_export(
exportId='string'
)
[REQUIRED]
The unique ID assigned to this export.
{
'startTime': datetime(2015, 1, 1),
'stopTime': datetime(2015, 1, 1)
}
Response Structure
Timestamp that represents when this continuous export started collecting data.
Timestamp that represents when this continuous export was stopped.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.OperationNotPermittedExceptionApplicationDiscoveryService.Client.exceptions.ResourceNotFoundExceptionApplicationDiscoveryService.Client.exceptions.ResourceInUseExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionstop_data_collection_by_agent_ids(**kwargs)¶Instructs the specified agents or connectors to stop collecting data.
See also: AWS API Documentation
Request Syntax
response = client.stop_data_collection_by_agent_ids(
agentIds=[
'string',
]
)
[REQUIRED]
The IDs of the agents or connectors from which to stop collecting data.
{
'agentsConfigurationStatus': [
{
'agentId': 'string',
'operationSucceeded': True|False,
'description': 'string'
},
]
}
Response Structure
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.
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.
The agent/connector ID.
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.
A description of the operation performed.
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionupdate_application(**kwargs)¶Updates metadata about an application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
configurationId='string',
name='string',
description='string'
)
[REQUIRED]
Configuration ID of the application to be updated.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterExceptionApplicationDiscoveryService.Client.exceptions.InvalidParameterValueExceptionApplicationDiscoveryService.Client.exceptions.ServerInternalErrorExceptionApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetExceptionThe available paginators are:
ApplicationDiscoveryService.Paginator.DescribeAgentsApplicationDiscoveryService.Paginator.DescribeContinuousExportsApplicationDiscoveryService.Paginator.DescribeExportConfigurationsApplicationDiscoveryService.Paginator.DescribeExportTasksApplicationDiscoveryService.Paginator.DescribeTagsApplicationDiscoveryService.Paginator.ListConfigurationsApplicationDiscoveryService.Paginator.DescribeAgents¶paginator = client.get_paginator('describe_agents')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_agents().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
agentIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
You can filter the request using various logical operators and a key -value format. For example:
{"key": "collectionStatus", "value": "STARTED"}
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 .
The name of the filter.
A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'agentsInfo': [
{
'agentId': 'string',
'hostName': 'string',
'agentNetworkInfoList': [
{
'ipAddress': 'string',
'macAddress': 'string'
},
],
'connectorId': 'string',
'version': 'string',
'health': 'HEALTHY'|'UNHEALTHY'|'RUNNING'|'UNKNOWN'|'BLACKLISTED'|'SHUTDOWN',
'lastHealthPingTime': 'string',
'collectionStatus': 'string',
'agentType': 'string',
'registeredTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
agentsInfo (list) --
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.
(dict) --
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.
agentId (string) --
The agent or connector ID.
hostName (string) --
The name of the host where the agent or connector resides. The host can be a server or virtual machine.
agentNetworkInfoList (list) --
Network details about the host where the agent or connector resides.
(dict) --
Network details about the host where the agent/connector resides.
ipAddress (string) --
The IP address for the host where the agent/connector resides.
macAddress (string) --
The MAC address for the host where the agent/connector resides.
connectorId (string) --
The ID of the connector.
version (string) --
The agent or connector version.
health (string) --
The health of the agent or connector.
lastHealthPingTime (string) --
Time since agent or connector health was reported.
collectionStatus (string) --
Status of the collection process for an agent or connector.
agentType (string) --
Type of agent.
registeredTime (string) --
Agent's first registration timestamp in UTC.
NextToken (string) --
A token to resume pagination.
ApplicationDiscoveryService.Paginator.DescribeContinuousExports¶paginator = client.get_paginator('describe_continuous_exports')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_continuous_exports().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
exportIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The unique IDs assigned to the exports.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'descriptions': [
{
'exportId': 'string',
'status': 'START_IN_PROGRESS'|'START_FAILED'|'ACTIVE'|'ERROR'|'STOP_IN_PROGRESS'|'STOP_FAILED'|'INACTIVE',
'statusDetail': 'string',
's3Bucket': 'string',
'startTime': datetime(2015, 1, 1),
'stopTime': datetime(2015, 1, 1),
'dataSource': 'AGENT',
'schemaStorageConfig': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
descriptions (list) --
A list of continuous export descriptions.
(dict) --
A list of continuous export descriptions.
exportId (string) --
The unique ID assigned to this export.
status (string) --
Describes the status of the export. Can be one of the following values:
statusDetail (string) --
Contains information about any errors that have occurred. This data type can have the following values:
s3Bucket (string) --
The name of the s3 bucket where the export data parquet files are stored.
startTime (datetime) --
The timestamp representing when the continuous export was started.
stopTime (datetime) --
The timestamp that represents when this continuous export was stopped.
dataSource (string) --
The type of data collector used to gather this data (currently only offered for AGENT).
schemaStorageConfig (dict) --
An object which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.NextToken (string) --
A token to resume pagination.
ApplicationDiscoveryService.Paginator.DescribeExportConfigurations¶paginator = client.get_paginator('describe_export_configurations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_export_configurations().
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
exportIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A list of continuous export IDs to search for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'exportsInfo': [
{
'exportId': 'string',
'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
'statusMessage': 'string',
'configurationsDownloadUrl': 'string',
'exportRequestTime': datetime(2015, 1, 1),
'isTruncated': True|False,
'requestedStartTime': datetime(2015, 1, 1),
'requestedEndTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
exportsInfo (list) --
(dict) --
Information regarding the export status of discovered data. The value is an array of objects.
exportId (string) --
A unique identifier used to query an export.
exportStatus (string) --
The status of the data export job.
statusMessage (string) --
A status message provided for API callers.
configurationsDownloadUrl (string) --
A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
exportRequestTime (datetime) --
The time that the data export was initiated.
isTruncated (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 .
requestedStartTime (datetime) --
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo .
requestedEndTime (datetime) --
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo .
NextToken (string) --
A token to resume pagination.
ApplicationDiscoveryService.Paginator.DescribeExportTasks¶paginator = client.get_paginator('describe_export_tasks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_export_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
exportIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more unique identifiers used to query the status of an export request.
One or more filters.
AgentId - ID of the agent whose collected data will be exportedUsed to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
A single ExportFilter name. Supported filters: agentIds .
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 .
Supported condition: EQUALS
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'exportsInfo': [
{
'exportId': 'string',
'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
'statusMessage': 'string',
'configurationsDownloadUrl': 'string',
'exportRequestTime': datetime(2015, 1, 1),
'isTruncated': True|False,
'requestedStartTime': datetime(2015, 1, 1),
'requestedEndTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
exportsInfo (list) --
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.
(dict) --
Information regarding the export status of discovered data. The value is an array of objects.
exportId (string) --
A unique identifier used to query an export.
exportStatus (string) --
The status of the data export job.
statusMessage (string) --
A status message provided for API callers.
configurationsDownloadUrl (string) --
A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
exportRequestTime (datetime) --
The time that the data export was initiated.
isTruncated (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 .
requestedStartTime (datetime) --
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo .
requestedEndTime (datetime) --
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo .
NextToken (string) --
A token to resume pagination.
ApplicationDiscoveryService.Paginator.DescribeTags¶paginator = client.get_paginator('describe_tags')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_tags().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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 .
The tag filter. Valid names are: tagKey , tagValue , configurationId .
A name of the tag filter.
Values for the tag filter.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'tags': [
{
'configurationType': 'SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
'configurationId': 'string',
'key': 'string',
'value': 'string',
'timeOfCreation': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
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.
(dict) --
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
configurationType (string) --
A type of IT asset to tag.
configurationId (string) --
The configuration ID for the item to tag. You can specify a list of keys and values.
key (string) --
A type of tag on which to filter. For example, serverType .
value (string) --
A value on which to filter. For example key = serverType and value = web server .
timeOfCreation (datetime) --
The time the configuration tag was created in Coordinated Universal Time (UTC).
NextToken (string) --
A token to resume pagination.
ApplicationDiscoveryService.Paginator.ListConfigurations¶paginator = client.get_paginator('list_configurations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.list_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
configurationType='SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
orderBy=[
{
'fieldName': 'string',
'sortOrder': 'ASC'|'DESC'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
A valid configuration identified by Application Discovery Service.
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 .
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 .
The name of the filter.
A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
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.
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 .
A field and direction for ordered output.
The field on which to order.
Ordering direction.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'configurations': [
{
'string': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
configurations (list) --
Returns configuration details, including the configuration ID, attribute names, and attribute values.
NextToken (string) --
A token to resume pagination.