2016/05/12 - AWS Application Discovery Service - 11 new api methods
Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.
Request Syntax
client.describe_agents(
agentIds=[
'string',
],
maxResults=123,
nextToken='string'
)
list
The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
(string) --
integer
The total number of items to return. 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
{
'agentsInfo': [
{
'agentId': 'string',
'hostName': 'string',
'agentNetworkInfoList': [
{
'ipAddress': 'string',
'macAddress': 'string'
},
],
'connectorId': 'string',
'version': 'string',
'health': 'HEALTHY'|'UNHEALTHY'|'RUNNING'|'UNKNOWN'|'BLACKLISTED'|'SHUTDOWN'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
agentsInfo (list) --
Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, MAC addresses, agent health, host name where the agent resides, and the version number of each agent.
(dict) --
Information about agents associated with the user’s AWS account. Information includes agent IDs, IP addresses, MAC addresses, agent health, hostname where the agent resides, and agent version for each agent.
agentId (string) --
The agent ID.
hostName (string) --
The name of the host where the agent resides. The host can be a server, virtual machine, or an AWS EC2 instance.
agentNetworkInfoList (list) --
Network details about the host where the agent resides.
(dict) --
Network details about the host where the agent resides.
ipAddress (string) --
The IP address for the host where the agent resides.
macAddress (string) --
The MAC address for the host where the agent resides.
connectorId (string) --
version (string) --
The agent version
health (string) --
The health of the agent.
nextToken (string) --
The call returns a token. Use this token to get the next set of results.
Request Syntax
client.remove_configuration(
configurationId='string'
)
string
[REQUIRED]
dict
Response Syntax
{}
Response Structure
(dict) --
Instructs the specified agents to stop collecting data.
Request Syntax
client.stop_data_collection_by_agent_ids(
agentIds=[
'string',
]
)
list
[REQUIRED]
The IDs of the agents that you want to stop collecting data.
(string) --
dict
Response Syntax
{
'agentsConfigStatus': [
{
'agentId': 'string',
'configUpdated': True|False,
'description': 'string'
},
]
}
Response Structure
(dict) --
agentsConfigStatus (list) --
Information about agents that were instructed to stop collecting data. Information includes the agent ID, a description of the operation performed, and whether or not the agent configuration was updated.
(dict) --
Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation, and whether or not the agent configuration was updated.
agentId (string) --
The agent ID.
configUpdated (boolean) --
Information about whether or not the agent configuration was updated.
description (string) --
A description of the operation performed.
Creates one or more tags for a configuration item. Tags are metadata that help you categorize IT assets.
Request Syntax
client.create_tags(
configurationIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
list
[REQUIRED]
A list of configuration items that you want to tag.
(string) --
list
[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"}
(dict) --
Metadata that help you categorize IT assets.
key (string) -- [REQUIRED]
A type of tag to filter on.
value (string) -- [REQUIRED]
A value for a tag key to filter on.
dict
Response Syntax
{}
Response Structure
(dict) --
Exports the selected configurations to an Amazon S3 bucket.
Request Syntax
client.export_configurations()
dict
Response Syntax
{
'exportId': 'string'
}
Response Structure
(dict) --
exportId (string) --
A unique identifier which you can use to query the export status.
Retrieve a list of configurations items according to the criteria you specify in a filter. The filter criteria identify relationship requirements.
Request Syntax
client.list_configurations(
configurationType='SERVER'|'PROCESS'|'CONNECTION',
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
A valid configuration identified by the Discovery Service.
list
You can filter the list using a key, value format. For example:
{"key": "serverType", "value": "webServer"}
(dict) --
A means of limiting responses.
name (string) -- [REQUIRED]
The name of the filter you want to use.
values (list) -- [REQUIRED]
The value you want to filter on.
(string) --
condition (string) -- [REQUIRED]
A conditional operator for the filter.
integer
The total number of items to return. 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
{
'configurations': [
{
'string': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
configurations (list) --
Returns a list of configuration item IDs.
(dict) --
(string) --
(string) --
nextToken (string) --
The call returns a token. Use this token to get the next set of results.
Retrieve a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
Request Syntax
client.get_configuration_attributes(
configurationIds=[
'string',
]
)
list
[REQUIRED]
One or more configuration IDs.
(string) --
dict
Response Syntax
{
'configurations': {
'string': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
configurations (dict) --
Returns configuration details, including the configuration ID, attribute names, and attribute values.
(string) --
(list) --
(dict) --
A specific detail about a configuration item. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
Name (string) --
The name of the attribute.
Value (string) --
A specific attribute type. For example key = serverType and value = web server.
Retrieves the status of a given export process.
Request Syntax
client.get_export_status(
exportId='string'
)
string
[REQUIRED]
A unique identifier which you can use to query the export status.
dict
Response Syntax
{
'exportId': 'string',
'exportStatusMap': {
'string': 'string'
}
}
Response Structure
(dict) --
exportId (string) --
Returns configuration details, including the configuration ID, attribute names, and attribute values.
exportStatusMap (dict) --
Returns export details. When the status is complete, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.
(string) --
(string) --
Instructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center or on AWS EC2 instances.
Request Syntax
client.start_data_collection_by_agent_ids(
agentIds=[
'string',
]
)
list
[REQUIRED]
The IDs of the agents that you want to start collecting data.
(string) --
dict
Response Syntax
{
'agentsConfigStatus': [
{
'agentId': 'string',
'configUpdated': True|False,
'description': 'string'
},
]
}
Response Structure
(dict) --
agentsConfigStatus (list) --
Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation performed, and whether or not the agent configuration was updated.
(dict) --
Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation, and whether or not the agent configuration was updated.
agentId (string) --
The agent ID.
configUpdated (boolean) --
Information about whether or not the agent configuration was updated.
description (string) --
A description of the operation performed.
Retrieve a list of configuration items that are tagged with a specific tag. Or retrieve a list all tags assigned to a specific configuration item.
Request Syntax
client.describe_tags(
filter=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
You can filter the list using a key, value format. For example:
{"key": "serverType", "value": "webServer"}
You can separate these items by using logical operators. Allowed filters include tagkey, tagValue, and configid.
(dict) --
A means of limiting responses when searching for tags.
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. 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',
'configurationId': 'string',
'key': 'string',
'value': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
Depending on the input, 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 descriptor. For example, serverType .
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 .
nextToken (string) --
The call returns a token. Use this token to get the next set of results.
Deletes one or more tags associated with a configuration item.
Request Syntax
client.delete_tags(
configurationIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
list
[REQUIRED]
A list of configuration items with tags that you want to delete.
(string) --
list
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"}
(dict) --
Metadata that help you categorize IT assets.
key (string) -- [REQUIRED]
A type of tag to filter on.
value (string) -- [REQUIRED]
A value for a tag key to filter on.
dict
Response Syntax
{}
Response Structure
(dict) --