Skip to content

CreateContactFlowModuleRequest

Source code in docs_src/capo_connect/types/create_contact_flow_module_request.py
class CreateContactFlowModuleRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    name: "capo_connect.types.contact_flow_module_name.ContactFlowModuleName"
    """<p>The name of the flow module.</p>"""
    description: NotRequired[
        "capo_connect.types.contact_flow_module_description.ContactFlowModuleDescription"
    ]
    """<p>The description of the flow module. </p>"""
    content: "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>"""
    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>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</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>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

content instance-attribute

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.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name instance-attribute

The name of the flow module.

settings instance-attribute

settings: NotRequired[FlowModuleSettings]

The configuration settings for 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"} }.