2016/05/17 - AWS Application Discovery Service - 2 new 3 updated api methods
Retrieves 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.describe_configurations(
configurationIds=[
'string',
]
)
list
[REQUIRED]
One or more configuration IDs.
(string) --
dict
Response Syntax
{
'configurations': [
{
'string': 'string'
},
]
}
Response Structure
(dict) --
configurations (list) --
A key in the response map. The value is an array of data.
(dict) --
(string) --
(string) --
Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
Request Syntax
client.describe_export_configurations(
exportIds=[
'string',
],
maxResults=123,
nextToken='string'
)
list
A unique identifier that you can use to query the export status.
(string) --
integer
The maximum number of results that you want to display as a part of the query.
string
A token to get the next set of results. For example, if you specified 100 IDs for DescribeConfigurationsRequest$configurationIds but set DescribeExportConfigurationsRequest$maxResults to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.
dict
Response Syntax
{
'exportsInfo': [
{
'exportId': 'string',
'exportStatus': 'FAILED'|'SUCCEEDED'|'IN_PROGRESS',
'statusMessage': 'string',
'configurationsDownloadUrl': 'string',
'exportRequestTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
exportsInfo (list) --
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.
(dict) --
Information regarding the export status of the discovered data. The value is an array of objects.
exportId (string) --
A unique identifier that you can use to query the export.
exportStatus (string) --
The status of the configuration data export. The status can succeed, fail, or be in-progress.
statusMessage (string) --
Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.
configurationsDownloadUrl (string) --
A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.
exportRequestTime (datetime) --
The time the configuration data export was initiated.
nextToken (string) --
A token to get the next set of results. For example, if you specified 100 IDs for DescribeConfigurationsRequest$configurationIds but set DescribeExportConfigurationsRequest$maxResults to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.
{'filters': [{'name': 'string', 'values': ['string']}]}
Response {'tags': {'timeOfCreation': 'timestamp'}}
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.
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 .
(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. 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',
'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.
{'agentsConfigurationStatus': [{'agentId': 'string',
'description': 'string',
'operationSucceeded': 'boolean'}]}
Instructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center.
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. If you send a request to an AWS agent 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 and you do not have permission to contact some of those agents, the system does not throw an exception. Instead, the system shows Failed in the Description field.
(string) --
dict
Response Syntax
{
'agentsConfigurationStatus': [
{
'agentId': 'string',
'operationSucceeded': True|False,
'description': 'string'
},
]
}
Response Structure
(dict) --
agentsConfigurationStatus (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.
operationSucceeded (boolean) --
Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent receives this command the next time it polls for a new command.
description (string) --
A description of the operation performed.
{'agentsConfigurationStatus': [{'agentId': 'string',
'description': 'string',
'operationSucceeded': 'boolean'}]}
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
{
'agentsConfigurationStatus': [
{
'agentId': 'string',
'operationSucceeded': True|False,
'description': 'string'
},
]
}
Response Structure
(dict) --
agentsConfigurationStatus (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.
operationSucceeded (boolean) --
Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent receives this command the next time it polls for a new command.
description (string) --
A description of the operation performed.