Describe Contact Flow

connect_describe_contact_flow

R Documentation

Describes the specified flow

Description

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

Usage

connect_describe_contact_flow(InstanceId, ContactFlowId)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

ContactFlowId

[required] The identifier of the flow.

Value

A list with the following syntax:

list(
  ContactFlow = list(
    Arn = "string",
    Id = "string",
    Name = "string",
    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",
    Content = "string",
    Tags = list(
      "string"
    ),
    FlowContentSha256 = "string",
    Version = 123,
    VersionDescription = "string",
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string"
  )
)

Request syntax

svc$describe_contact_flow(
  InstanceId = "string",
  ContactFlowId = "string"
)