DescribeContactFlowCommand

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language .

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

Example Syntax

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

import { ConnectClient, DescribeContactFlowCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeContactFlowCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeContactFlowRequest
  InstanceId: "STRING_VALUE", // required
  ContactFlowId: "STRING_VALUE", // required
};
const command = new DescribeContactFlowCommand(input);
const response = await client.send(command);
// { // DescribeContactFlowResponse
//   ContactFlow: { // ContactFlow
//     Arn: "STRING_VALUE",
//     Id: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Type: "CONTACT_FLOW" || "CUSTOMER_QUEUE" || "CUSTOMER_HOLD" || "CUSTOMER_WHISPER" || "AGENT_HOLD" || "AGENT_WHISPER" || "OUTBOUND_WHISPER" || "AGENT_TRANSFER" || "QUEUE_TRANSFER" || "CAMPAIGN",
//     State: "ACTIVE" || "ARCHIVED",
//     Status: "PUBLISHED" || "SAVED",
//     Description: "STRING_VALUE",
//     Content: "STRING_VALUE",
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     FlowContentSha256: "STRING_VALUE",
//     Version: Number("long"),
//     VersionDescription: "STRING_VALUE",
//     LastModifiedTime: new Date("TIMESTAMP"),
//     LastModifiedRegion: "STRING_VALUE",
//   },
// };

DescribeContactFlowCommand Input

See DescribeContactFlowCommandInput for more details

Parameter
Type
Description
ContactFlowId
Required
string | undefined

The identifier of the flow.

InstanceId
Required
string | undefined

The identifier of the Amazon Connect instance.

DescribeContactFlowCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ContactFlow
ContactFlow | undefined

Information about the flow.

Throws

Name
Fault
Details
ContactFlowNotPublishedException
client

The flow has not been published.

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.