Skip to content

ContactFlowModule

Source code in docs_src/capo_connect/types/contact_flow_module.py
class ContactFlowModule(TypedDict, closed=True):
    arn: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN).</p>"""
    id: NotRequired["capo_connect.types.contact_flow_module_id.ContactFlowModuleId"]
    """<p>The identifier of the flow module.</p>"""
    name: NotRequired[
        "capo_connect.types.contact_flow_module_name.ContactFlowModuleName"
    ]
    """<p>The name of the flow module.</p>"""
    content: NotRequired[
        "capo_connect.types.contact_flow_module_content.ContactFlowModuleContent"
    ]
    """<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>"""
    description: NotRequired[
        "capo_connect.types.contact_flow_module_description.ContactFlowModuleDescription"
    ]
    """<p>The description of the flow module.</p>"""
    state: NotRequired[
        "capo_connect.types.contact_flow_module_state.ContactFlowModuleState"
    ]
    """<p>The type of flow module.</p>"""
    status: NotRequired[
        "capo_connect.types.contact_flow_module_status.ContactFlowModuleStatus"
    ]
    """<p>The status of the flow module.</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_module_content_sha256: NotRequired[
        "capo_connect.types.flow_module_content_sha256.FlowModuleContentSha256"
    ]
    """<p>Hash of the module content for integrity verification.</p>"""
    version: NotRequired["capo_connect.types.resource_version.ResourceVersion"]
    """<p>The version of the flow module.</p>"""
    version_description: NotRequired[
        "capo_connect.types.contact_flow_module_description.ContactFlowModuleDescription"
    ]
    """<p>Description of the version.</p>"""
    settings: NotRequired["capo_connect.types.flow_module_settings.FlowModuleSettings"]
    """<p>The configuration settings for the flow module.</p>"""
    external_invocation_configuration: NotRequired[
        "capo_connect.types.external_invocation_configuration.ExternalInvocationConfiguration"
    ]
    """<p>The external invocation configuration for the flow module</p>"""

arn instance-attribute

arn: NotRequired[ARN]

The Amazon Resource Name (ARN).

content instance-attribute

content: NotRequired[ContactFlowModuleContent]

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

description instance-attribute

description: NotRequired[ContactFlowModuleDescription]

The description of the flow module.

external_invocation_configuration instance-attribute

external_invocation_configuration: NotRequired[ExternalInvocationConfiguration]

The external invocation configuration for the flow module

flow_module_content_sha256 instance-attribute

flow_module_content_sha256: NotRequired[FlowModuleContentSha256]

Hash of the module content for integrity verification.

id instance-attribute

id: NotRequired[ContactFlowModuleId]

The identifier of the flow module.

name instance-attribute

name: NotRequired[ContactFlowModuleName]

The name of the flow module.

settings instance-attribute

settings: NotRequired[FlowModuleSettings]

The configuration settings for the flow module.

state instance-attribute

state: NotRequired[ContactFlowModuleState]

The type of flow module.

status instance-attribute

status: NotRequired[ContactFlowModuleStatus]

The status of the flow module.

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"} }.

version instance-attribute

version: NotRequired[ResourceVersion]

The version of the flow module.

version_description instance-attribute

version_description: NotRequired[ContactFlowModuleDescription]

Description of the version.