DescribeContinuousExports - AWS Application Discovery Service

DescribeContinuousExports

Lists exports as specified by ID. All continuous exports associated with your user can be listed if you call DescribeContinuousExports as is without passing any parameters.

Request Syntax

{ "exportIds": [ "string" ], "maxResults": number, "nextToken": "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.

exportIds

The unique IDs assigned to the exports.

Type: Array of strings

Length Constraints: Maximum length of 200.

Pattern: \S*

Required: No

maxResults

A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The token from the previous call to DescribeExportTasks.

Type: String

Required: No

Response Syntax

{ "descriptions": [ { "dataSource": "string", "exportId": "string", "s3Bucket": "string", "schemaStorageConfig": { "string" : "string" }, "startTime": number, "status": "string", "statusDetail": "string", "stopTime": number } ], "nextToken": "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.

descriptions

A list of continuous export descriptions.

Type: Array of ContinuousExportDescription objects

nextToken

The token from the previous call to DescribeExportTasks.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationErrorException

The user does not have permission to perform the action. Check the IAM policy associated with this user.

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

ResourceNotFoundException

The specified configuration ID was not located. Verify the configuration ID and try again.

HTTP Status Code: 400

ServerInternalErrorException

The server experienced an internal error. Try again.

HTTP Status Code: 500

Examples

Describe a continuous export

The following example shows the request and response of describing a particular continuous export specified by passing in a value to exportId as well as other filtering parameters.

Sample Request

{ "maxResults": 10, "nextToken": "rLH9RloHsWvY1sljKfLwlmHioorNIJJ1TC9MDO6HolpInQgsQKfk30Zu5n9YP59JZ5k5NzAqs6YerZWY", "exportIds": [ "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59" ] }

Sample Response

{ "descriptions": [ { "exportId": "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59", "status": "ACTIVE" }, { "schemaStorageConfig": { "databaseName": "application_discovery_service_database" }, "startTime": 1531248144.117, "exportId": "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59", "s3Bucket": "aws-application-discovery-service-92costafer5c9vn0qjane94mi", "status": "STOP_IN_PROGRESS", "stopTime": 1531248232.085, "statusDetail": "", "dataSource": "AGENT" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: