- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListContactFlowVersionsCommand
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, ListContactFlowVersionsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListContactFlowVersionsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListContactFlowVersionsRequest
InstanceId: "STRING_VALUE", // required
ContactFlowId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListContactFlowVersionsCommand(input);
const response = await client.send(command);
// { // ListContactFlowVersionsResponse
// ContactFlowVersionSummaryList: [ // ContactFlowVersionSummaryList
// { // ContactFlowVersionSummary
// Arn: "STRING_VALUE",
// VersionDescription: "STRING_VALUE",
// Version: Number("long"),
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListContactFlowVersionsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ContactFlowIdRequired | string | undefined | The identifier of the flow. |
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. |
MaxResults | number | undefined | The maximum number of results to return per page. The default MaxResult size is 100. |
NextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ListContactFlowVersionsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ContactFlowVersionSummaryList | ContactFlowVersionSummary[] | undefined | A list of flow version summaries. |
NextToken | string | undefined | If there are additional results, this is the token for the next set of results. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | client | One or more of the specified parameters are not valid. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |