Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListExports

Lists all data export definitions.

Request Syntax


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

MaxResults

The maximum number of objects that are returned for the request.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

The token to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: ^[\S\s]*$

Required: No

Response Syntax


{
   "Exports": [ 
      { 
         "ExportArn": "string",
         "ExportName": "string",
         "ExportStatus": { 
            "CreatedAt": "string",
            "LastRefreshedAt": "string",
            "LastUpdatedAt": "string",
            "StatusCode": "string",
            "StatusReason": "string"
         }
      }
   ],
   "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.

Exports

The details of the exports, including name and export status.

Type: Array of ExportReference objects

NextToken

The token to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: ^[\S\s]*$

Errors

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

InternalServerException

An error on the server occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400

Examples

The following is a sample request of the ListExports operation.

This example illustrates one usage of ListExports.

Sample Request


{
    "MaxResults": 100,
    "NextToken": ""
}

The following is a sample response of the ListExports operation.

This example illustrates one usage of ListExports.

Sample Response


{
    "Exports": [
        {
            "ExportArn": "arn:aws:bcm-data-exports:::export:Example/837fcfce-f85b-4600-b333-b38a12c3a927",
            "ExportName": "ExampleExportName1",
            "ExportStatus": {
                "CreatedAt": "2023-11-14T18:02:02.371Z",
                "LastRefreshedAt": "2023-11-14T18:18:12.592Z",
                "LastUpdatedAt": "2023-11-14T18:02:02.371Z",
                "StatusCode": "HEALTHY"
            }
        },
        {
            "ExportArn": "arn:aws:bcm-data-exports:::export:Example/837fcfce-f85b-4600-b333-b38a12c3a927",
            "ExportName": "ExampleExportName2",
            "ExportStatus": {
                "CreatedAt": "2023-11-14T18:03:02.038Z",
                "LastRefreshedAt": "2023-11-14T18:18:12.629Z",
                "LastUpdatedAt": "2023-11-14T18:03:02.038Z",
                "StatusCode": "UNHEALTHY"
            }
        }
    ]
}