Skip to content

CreateContactFlowRequest

Source code in docs_src/capo_connect/types/create_contact_flow_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class CreateContactFlowRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance.</p>"""
    name: "capo_connect.types.contact_flow_name.ContactFlowName"
    """<p>The name of the flow.</p>"""
    type: "capo_connect.types.contact_flow_type.ContactFlowType"
    """<p>The type of the flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a flow type</a> in the <i>Connect Customer Administrator Guide</i>.</p>"""
    description: NotRequired[
        "capo_connect.types.contact_flow_description.ContactFlowDescription"
    ]
    """<p>The description of the flow. </p>"""
    content: "capo_connect.types.contact_flow_content.ContactFlowContent"
    """<p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example flow in Connect Customer Flow language</a>. </p> <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>"""
    status: NotRequired["capo_connect.types.contact_flow_status.ContactFlowStatus"]
    """<p>Indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code> status does not initiate validation of the content. <code>SAVED</code> | <code>PUBLISHED</code>.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>"""

content instance-attribute 

content: ContactFlowContent

The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.

Length Constraints: Minimum length of 1. Maximum length of 256000.

description instance-attribute 

description: NotRequired[ContactFlowDescription]

The description of the flow.

instance_id instance-attribute 

instance_id: InstanceId

The identifier of the Connect Customer instance.

name instance-attribute 

name: ContactFlowName

The name of the flow.

status instance-attribute 

status: NotRequired[ContactFlowStatus]

Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

tags instance-attribute 

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

type instance-attribute 

type: ContactFlowType

The type of the flow. For descriptions of the available types, see Choose a flow type in the Connect Customer Administrator Guide.