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

ListExecutions

Lists the historical executions for the export.

Request Syntax


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

ExportArn

The Amazon Resource Name (ARN) for this export.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$

Required: Yes

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


{
   "Executions": [ 
      { 
         "ExecutionId": "string",
         "ExecutionStatus": { 
            "CompletedAt": "string",
            "CreatedAt": "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.

Executions

The list of executions.

Type: Array of ExecutionReference 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

ResourceNotFoundException

The specified Amazon Resource Name (ARN) in the request doesn't exist.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400

Examples

The following is a sample request of the ListExecutions operation.

This example illustrates one usage of ListExecutions.

Sample Request


{
  "ExportArn": "arn:aws:bcm-data-exports:::export:Example/837fcfce-f85b-4600-b333-b38a12c3a927",
  "MaxResults": 100,
  "NextToken": ""
}

The following is a sample response of the ListExecutions operation.

This example illustrates one usage of ListExecutions.

Sample Response


{
    "Executions": [
        {
            "ExecutionId": "f0cfeaf0-c552-47e7-82bc-0107fbfc7a8b",
            "ExecutionStatus": {
                "CreatedAt": "2023-11-14T18:14:12.813Z",
                "LastUpdatedAt": "2023-11-14T18:18:14.252556820Z",
                "StatusCode": "DELIVERY_SUCCESS"
            }
        },
        {
            "ExecutionId": "2c173333-4b14-4740-98a1-d52304eced2d",
            "ExecutionStatus": {
                "CreatedAt": "2023-11-14T09:20:47.137Z",
                "LastUpdatedAt": "2023-11-14T09:53:48.285265457Z",
                "StatusCode": "DELIVERY_SUCCESS"
            }
        }
    ]
}