DescribeFlowExecutionRecordsCommand

Suggest an Edit

Fetches the execution history of the flow.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppflowClient, DescribeFlowExecutionRecordsCommand } from "@aws-sdk/client-appflow"; // ES Modules import
// const { AppflowClient, DescribeFlowExecutionRecordsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
const client = new AppflowClient(config);
const input = { // DescribeFlowExecutionRecordsRequest
  flowName: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new DescribeFlowExecutionRecordsCommand(input);
const response = await client.send(command);
// { // DescribeFlowExecutionRecordsResponse
//   flowExecutions: [ // FlowExecutionList
//     { // ExecutionRecord
//       executionId: "STRING_VALUE",
//       executionStatus: "InProgress" || "Successful" || "Error" || "CancelStarted" || "Canceled",
//       executionResult: { // ExecutionResult
//         errorInfo: { // ErrorInfo
//           putFailuresCount: Number("long"),
//           executionMessage: "STRING_VALUE",
//         },
//         bytesProcessed: Number("long"),
//         bytesWritten: Number("long"),
//         recordsProcessed: Number("long"),
//         numParallelProcesses: Number("long"),
//         maxPageSize: Number("long"),
//       },
//       startedAt: new Date("TIMESTAMP"),
//       lastUpdatedAt: new Date("TIMESTAMP"),
//       dataPullStartTime: new Date("TIMESTAMP"),
//       dataPullEndTime: new Date("TIMESTAMP"),
//       metadataCatalogDetails: [ // MetadataCatalogDetails
//         { // MetadataCatalogDetail
//           catalogType: "GLUE",
//           tableName: "STRING_VALUE",
//           tableRegistrationOutput: { // RegistrationOutput
//             message: "STRING_VALUE",
//             result: "STRING_VALUE",
//             status: "InProgress" || "Successful" || "Error" || "CancelStarted" || "Canceled",
//           },
//           partitionRegistrationOutput: {
//             message: "STRING_VALUE",
//             result: "STRING_VALUE",
//             status: "InProgress" || "Successful" || "Error" || "CancelStarted" || "Canceled",
//           },
//         },
//       ],
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

DescribeFlowExecutionRecordsCommand Input

See DescribeFlowExecutionRecordsCommandInput for more details

Parameter
Type
Description
flowName
Required
string | undefined

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

maxResults
number | undefined

Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).

nextToken
string | undefined

The pagination token for the next page of data.

DescribeFlowExecutionRecordsCommand Output

See DescribeFlowExecutionRecordsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
flowExecutions
ExecutionRecord[] | undefined

Returns a list of all instances when this flow was run.

nextToken
string | undefined

The pagination token for the next page of data.

Throws

Name
Fault
Details
InternalServerException
server

An internal service error occurred during the processing of your request. Try again later.

ResourceNotFoundException
client

The resource specified in the request (such as the source or destination connector profile) is not found.

ValidationException
client

The request has invalid or missing parameters.

AppflowServiceException
Base exception class for all service exceptions from Appflow service.