Table of Contents
ApplicationDiscoveryService.Client¶A low-level client representing AWS Application Discovery Service:
client = session.create_client('discovery')
These are the available methods:
associate_configuration_items_to_application()can_paginate()create_application()create_tags()delete_applications()delete_tags()describe_agents()describe_configurations()describe_export_configurations()describe_export_tasks()describe_tags()disassociate_configuration_items_from_application()export_configurations()generate_presigned_url()get_discovery_summary()get_paginator()get_waiter()list_configurations()list_server_neighbors()start_data_collection_by_agent_ids()start_export_task()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',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'configurationId': 'string'
}
Response Structure
|
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.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
configurationIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
delete_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',
]
)
| Parameters: | configurationIds (list) – [REQUIRED] Configuration ID of an application to be deleted.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
Deletes 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'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
describe_agents(**kwargs)¶Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.
See also: AWS API Documentation
Request Syntax
response = client.describe_agents(
agentIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
describe_configurations(**kwargs)¶Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.
For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action .
See also: AWS API Documentation
Request Syntax
response = client.describe_configurations(
configurationIds=[
'string',
]
)
| Parameters: | configurationIds (list) – [REQUIRED] One or more configuration IDs.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'configurations': [
{
'string': 'string'
},
]
}
Response Structure
|
describe_export_configurations(**kwargs)¶Deprecated. Use DescribeExportTasks instead.
Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_configurations(
exportIds=[
'string',
],
maxResults=123,
nextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
describe_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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'tags': [
{
'configurationType': 'SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
'configurationId': 'string',
'key': 'string',
'value': 'string',
'timeOfCreation': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
|
disassociate_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',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
export_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.
See also: AWS API Documentation
Request Syntax
response = client.export_configurations()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'exportId': 'string'
}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_discovery_summary()¶Retrieves a short summary of discovered assets.
See also: AWS API Documentation
Request Syntax
response = client.get_discovery_summary()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'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
}
}
Response Structure
|
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_waiter(waiter_name)¶list_configurations(**kwargs)¶Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.
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'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'configurations': [
{
'string': 'string'
},
],
'nextToken': 'string'
}
Response Structure
|
list_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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'neighbors': [
{
'sourceServerId': 'string',
'destinationServerId': 'string',
'destinationPort': 123,
'transportProtocol': 'string',
'connectionsCount': 123
},
],
'nextToken': 'string',
'knownDependencyCount': 123
}
Response Structure
|
start_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',
]
)
| Parameters: | agentIds (list) – [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 AWS 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
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'agentsConfigurationStatus': [
{
'agentId': 'string',
'operationSucceeded': True|False,
'description': 'string'
},
]
}
Response Structure
|
start_export_task(**kwargs)¶Begins the export of discovered data to an S3 bucket.
If you specify agentId 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 agentId filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS 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)
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'exportId': 'string'
}
Response Structure
|
stop_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',
]
)
| Parameters: | agentIds (list) – [REQUIRED] The IDs of the agents or connectors from which to stop collecting data.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'agentsConfigurationStatus': [
{
'agentId': 'string',
'operationSucceeded': True|False,
'description': 'string'
},
]
}
Response Structure
|
update_application(**kwargs)¶Updates metadata about an application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
configurationId='string',
name='string',
description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
The available paginators are: