Menu
AWS Application Discovery Service
API Reference (API Version 2015-11-01)

StartExportTask

Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.

Request Syntax

Copy
{ "exportDataFormat": [ "string" ] }

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.

exportDataFormat

The file format for the returned export data. Default value is CSV.

Type: Array of strings

Valid Values: CSV | GRAPHML

Required: No

Response Syntax

Copy
{ "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

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

Example

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) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Start an export task and specify output in GraphML format

Sample Request

Copy
POST / HTTP/1.1 Host: discovery.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: AWSPoseidonService_V2015_11_01.StartExportTask X-Amz-Date: 20170309T171932Z Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "exportDataFormat":[ "GRAPHML" ] }

Sample Response

Copy
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: Thu, 09 Mar 2017 17:43:26 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: