StartExportTask
Begins the export of discovered data to an S3 bucket.
If you specify agentIds
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 agentIds
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.
Request Syntax
{
"endTime": number
,
"exportDataFormat": [ "string
" ],
"filters": [
{
"condition": "string
",
"name": "string
",
"values": [ "string
" ]
}
],
"startTime": number
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- endTime
-
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.
Type: Timestamp
Required: No
- exportDataFormat
-
The file format for the returned export data. Default value is
CSV
. Note: TheGRAPHML
option has been deprecated.Type: Array of strings
Valid Values:
CSV | GRAPHML
Required: No
- filters
-
If a filter is present, it selects the single
agentId
of the Application Discovery Agent for which data is exported. TheagentId
can be found in the results of theDescribeAgents
API or CLI. If no filter is present,startTime
andendTime
are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.Type: Array of ExportFilter objects
Required: No
- startTime
-
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.
Type: Timestamp
Required: No
Response Syntax
{
"exportId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- exportId
-
A unique identifier used to query the status of an export request.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationErrorException
-
The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400
- HomeRegionNotSetException
-
The home region is not set. Set the home region to continue.
HTTP Status Code: 400
- InvalidParameterException
-
One or more parameters are not valid. Verify the parameters and try again.
HTTP Status Code: 400
- InvalidParameterValueException
-
The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
HTTP Status Code: 400
- OperationNotPermittedException
-
This operation is not permitted.
HTTP Status Code: 400
- ServerInternalErrorException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For
more information about creating these signatures, see Signature Version 4
Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create
them. When you use the AWS Command Line Interface (AWS
CLI)
Start an export task of summary data filtering for an agentId and a time range
This example illustrates one usage of StartExportTask.
Sample Request
POST / HTTP/1.1
Host: discovery.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 141
X-Amz-Target: AWSPoseidonService_V2015_11_01.StartExportTask
X-Amz-Date: 20170711T004454Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{
"endTime":1499601600,
"startTime":1499428800,
"filters":[
{
"values":[
"i-06ea7f227a9ad1b86"
],
"name":"agentIds",
"condition":"EQUALS"
}
]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
Content-Type: application/x-amz-json-1.1
Content-Length: 58
Date: Tue, 11 Jul 2017 00:44:54 GMT
{
"exportId":"export-123a4b56-7c89-01d2-3ef4-example5678f"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: