Skip to content

ContactFlow

Source code in docs_src/capo_connect/types/contact_flow.py
class ContactFlow(TypedDict, closed=True):
    arn: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the flow.</p>"""
    id: NotRequired["capo_connect.types.contact_flow_id.ContactFlowId"]
    """<p>The identifier of the flow.</p>"""
    name: NotRequired["capo_connect.types.contact_flow_name.ContactFlowName"]
    """<p>The name of the flow.</p>"""
    type: NotRequired["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>"""
    state: NotRequired["capo_connect.types.contact_flow_state.ContactFlowState"]
    """<p>The type of flow.</p>"""
    status: NotRequired["capo_connect.types.contact_flow_status.ContactFlowStatus"]
    """<p>The status of the flow.</p>"""
    description: NotRequired[
        "capo_connect.types.contact_flow_description.ContactFlowDescription"
    ]
    """<p>The description of the flow.</p>"""
    content: NotRequired["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>"""
    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>"""
    flow_content_sha256: NotRequired[
        "capo_connect.types.flow_content_sha256.FlowContentSha256"
    ]
    """<p>Indicates the checksum value of the flow content.</p>"""
    version: NotRequired["capo_connect.types.resource_version.ResourceVersion"]
    """<p>The identifier of the flow version.</p>"""
    version_description: NotRequired[
        "capo_connect.types.contact_flow_description.ContactFlowDescription"
    ]
    """<p>The description of the flow version.</p>"""
    last_modified_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The time at which the flow was last modified.</p>"""
    last_modified_region: NotRequired["capo_connect.types.region_name.RegionName"]
    """<p>The region in which the flow was last modified</p>"""

arn instance-attribute

arn: NotRequired[ARN]

The Amazon Resource Name (ARN) of the flow.

content instance-attribute

content: NotRequired[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.

flow_content_sha256 instance-attribute

flow_content_sha256: NotRequired[FlowContentSha256]

Indicates the checksum value of the flow content.

id instance-attribute

id: NotRequired[ContactFlowId]

The identifier of the flow.

last_modified_region instance-attribute

last_modified_region: NotRequired[RegionName]

The region in which the flow was last modified

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The time at which the flow was last modified.

name instance-attribute

name: NotRequired[ContactFlowName]

The name of the flow.

state instance-attribute

state: NotRequired[ContactFlowState]

The type of flow.

status instance-attribute

status: NotRequired[ContactFlowStatus]

The status of the flow.

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: NotRequired[ContactFlowType]

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

version instance-attribute

version: NotRequired[ResourceVersion]

The identifier of the flow version.

version_description instance-attribute

version_description: NotRequired[ContactFlowDescription]

The description of the flow version.