2017/07/14 - AWS Application Discovery Service - 3 updated api methods
Changes Adding feature to the Export API for Discovery Service to allow filters for the export task to allow export based on per agent id.
{'exportsInfo': {'isTruncated': 'boolean',
'requestedEndTime': 'timestamp',
'requestedStartTime': 'timestamp'}}
Deprecated. Use DescribeExportTasks instead.
Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
!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
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 specify 100 IDs for DescribeExportConfigurationsRequest$exportIds but set DescribeExportConfigurationsRequest$maxResults to 10, you 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),
'isTruncated': True|False,
'requestedStartTime': datetime(2015, 1, 1),
'requestedEndTime': 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 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 get the next set of results. For example, if you specify 100 IDs for DescribeExportConfigurationsRequest$exportIds but set DescribeExportConfigurationsRequest$maxResults to 10, you get results in a set of 10. Use the token in the query to get the next set of 10.
{'filters': [{'condition': 'string', 'name': 'string', 'values': ['string']}]}
Response {'exportsInfo': {'isTruncated': 'boolean',
'requestedEndTime': 'timestamp',
'requestedStartTime': 'timestamp'}}
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
client.describe_export_tasks(
exportIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
maxResults=123,
nextToken='string'
)
list
One or more unique identifiers used to query the status of an export request.
(string) --
list
One or more filters.
AgentId - ID of the agent whose collected data will be exported
(dict) --
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
name (string) -- [REQUIRED]
A single ExportFilter name. Supported filters: agentId .
values (list) -- [REQUIRED]
A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0 .
(string) --
condition (string) -- [REQUIRED]
Supported condition: EQUALS
integer
The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.
string
The 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.
{'endTime': 'timestamp',
'filters': [{'condition': 'string', 'name': 'string', 'values': ['string']}],
'startTime': 'timestamp'}
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
client.start_export_task(
exportDataFormat=[
'CSV'|'GRAPHML',
],
filters=[
{
'name': 'string',
'values': [
'string',
],
'condition': 'string'
},
],
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
list
The file format for the returned export data. Default value is CSV .
(string) --
list
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.
(dict) --
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
name (string) -- [REQUIRED]
A single ExportFilter name. Supported filters: agentId .
values (list) -- [REQUIRED]
A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0 .
(string) --
condition (string) -- [REQUIRED]
Supported condition: EQUALS
datetime
The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.
datetime
The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.
dict
Response Syntax
{
'exportId': 'string'
}
Response Structure
(dict) --
exportId (string) --
A unique identifier used to query the status of an export request.