2016/12/19 - AWS Application Discovery Service - 7 new 3 updated api methods
Changes Adds new APIs to group discovered servers into Applications with get summary and neighbors. Includes additional filters for ListConfigurations and DescribeAgents API.
Associates one or more configuration items with an application.
See also: AWS API Documentation
Request Syntax
client.associate_configuration_items_to_application(
applicationConfigurationId='string',
configurationIds=[
'string',
]
)
string
[REQUIRED]
The configuration ID of an application with which items are to be associated.
list
[REQUIRED]
The ID of each configuration item to be associated with an application.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates one or more configuration items from an application.
See also: AWS API Documentation
Request Syntax
client.disassociate_configuration_items_from_application(
applicationConfigurationId='string',
configurationIds=[
'string',
]
)
string
[REQUIRED]
Configuration ID of an application from which each item will be disassociated.
list
[REQUIRED]
Configuration ID of each item be be disassociated from an application.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an application with the given name and description.
See also: AWS API Documentation
Request Syntax
client.create_application(
name='string',
description='string'
)
string
[REQUIRED]
Name of the application to be created.
string
Description of the application to be created.
dict
Response Syntax
{
'configurationId': 'string'
}
Response Structure
(dict) --
configurationId (string) --
Configuration ID of an application to be created.
Updates metadata about an application.
See also: AWS API Documentation
Request Syntax
client.update_application(
configurationId='string',
name='string',
description='string'
)
string
[REQUIRED]
Configuration ID of the application to be updated.
string
New name of the application to be updated.
string
New description of the application to be updated.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a list of applications and their associations with configuration items.
See also: AWS API Documentation
Request Syntax
client.delete_applications(
configurationIds=[
'string',
]
)
list
[REQUIRED]
Configuration ID of an application to be deleted.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a short summary of discovered assets.
See also: AWS API Documentation
Request Syntax
client.get_discovery_summary()
dict
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
(dict) --
servers (integer) --
Number of servers discovered.
applications (integer) --
Number of applications discovered.
serversMappedToApplications (integer) --
Number of servers mapped to applications.
serversMappedtoTags (integer) --
Number of servers mapped to tags.
agentSummary (dict) --
Details about discovered agents, including agent status and health.
activeAgents (integer) --
Number of active discovery agents.
healthyAgents (integer) --
Number of healthy discovery agents
blackListedAgents (integer) --
Number of blacklisted discovery agents.
shutdownAgents (integer) --
Number of discovery agents with status SHUTDOWN.
unhealthyAgents (integer) --
Number of unhealthy discovery agents.
totalAgents (integer) --
Total number of discovery agents.
unknownAgents (integer) --
Number of unknown discovery agents.
connectorSummary (dict) --
Details about discovered connectors, including connector status and health.
activeConnectors (integer) --
Number of active discovery connectors.
healthyConnectors (integer) --
Number of healthy discovery connectors.
blackListedConnectors (integer) --
Number of blacklisted discovery connectors.
shutdownConnectors (integer) --
Number of discovery connectors with status SHUTDOWN,
unhealthyConnectors (integer) --
Number of unhealthy discovery connectors.
totalConnectors (integer) --
Total number of discovery connectors.
unknownConnectors (integer) --
Number of unknown discovery connectors.
Retrieves a list of servers which are one network hop away from a specified server.
See also: AWS API Documentation
Request Syntax
client.list_server_neighbors(
configurationId='string',
portInformationNeeded=True|False,
neighborConfigurationIds=[
'string',
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
Configuration ID of the server for which neighbors are being listed.
boolean
Flag to indicate if port and protocol information is needed as part of the response.
list
List of configuration IDs to test for one-hop-away.
(string) --
integer
Maximum number of results to return in a single page of output.
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.
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) --
ID of server that opened the network connection.
destinationServerId (string) --
ID of the server that accepted the networker connection.
destinationPort (integer) --
Destination network port for the connection.
transportProtocol (string) --
Network protocol used for the connection.
connectionsCount (integer) --
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.
{'filters': [{'condition': 'string', 'name': 'string', 'values': ['string']}]}
Response {'agentsInfo': {'agentType': 'string',
'collectionStatus': 'string',
'lastHealthPingTime': 'string',
'registeredTime': 'string'}}
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
client.describe_agents(
agentIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string'
)
list
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 AWS user account.
(string) --
list
You can filter the request using various logical operators and a key -value format. For example:
{"key": "collectionStatus", "value": "STARTED"}
For a complete list of filter options and guidance about using them with this action, see Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector.
(dict) --
A filter that can use conditional operators.
for a complete list of filters and guidance for using them with the Application Discovery Service, see Querying Discovered Configuration Items.
name (string) -- [REQUIRED]
The name of the filter.
values (list) -- [REQUIRED]
A string value that you want to filter on. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
(string) --
condition (string) -- [REQUIRED]
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.
integer
The total number of agents/Connectors to return in a single page of output. The maximum value is 100.
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.
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 AWS 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 time stamp 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.
{'tags': {'configurationType': {'APPLICATION'}}}
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
client.describe_tags(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
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 .
For a complete list of filter options and guidance about using them with this action, see Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector.
(dict) --
The name of a tag filter. Valid names are: tagKey , tagValue , configurationId .
name (string) -- [REQUIRED]
A name of a tag filter.
values (list) -- [REQUIRED]
Values of a tag filter.
(string) --
integer
The total number of items to return in a single page of output. The maximum value is 100.
string
A token to start the list. Use this token to get the next set of results.
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 that you want to tag.
configurationId (string) --
The configuration ID for the item you want to tag. You can specify a list of keys and values.
key (string) --
A type of tag to filter on. For example, serverType .
value (string) --
A value to filter on. 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.
{'configurationType': {'APPLICATION'},
'orderBy': [{'fieldName': 'string', 'sortOrder': 'ASC | DESC'}]}
Retrieves a list of configuration items according to criteria you specify in a filter. The filter criteria identify relationship requirements.
See also: AWS API Documentation
Request Syntax
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'
},
]
)
string
[REQUIRED]
A valid configuration identified by the Discovery Service.
list
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 Querying Discovered Configuration Items.
(dict) --
A filter that can use conditional operators.
for a complete list of filters and guidance for using them with the Application Discovery Service, see Querying Discovered Configuration Items.
name (string) -- [REQUIRED]
The name of the filter.
values (list) -- [REQUIRED]
A string value that you want to filter on. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
(string) --
condition (string) -- [REQUIRED]
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.
integer
The total number of items to return. The maximum value is 100.
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.
list
Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Querying Discovered Configuration Items.
(dict) --
Field and direction for ordered output.
fieldName (string) -- [REQUIRED]
Field to order on.
sortOrder (string) --
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.
(dict) --
(string) --
(string) --
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.