Skip to content

CreateExtractionDefinitionRequest

Source code in docs_src/capo_connect/types/create_extraction_definition_request.py
class CreateExtractionDefinitionRequest(TypedDict, closed=True):
    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.</p>"""
    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.extraction_definition_name.ExtractionDefinitionName"
    """<p>A unique name of the extraction definition.</p>"""
    extraction_configuration: (
        "capo_connect.types.extraction_configuration.ExtractionConfiguration"
    )
    """<p>The configuration that defines how data is extracted, including the prompt hint and not-found behavior.</p>"""
    display: NotRequired[
        "capo_connect.types.extraction_definition_display.ExtractionDefinitionDisplay"
    ]
    """<p>The display settings for the extraction definition, including the label shown in the agent workspace.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</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.

display instance-attribute

display: NotRequired[ExtractionDefinitionDisplay]

The display settings for the extraction definition, including the label shown in the agent workspace.

extraction_configuration instance-attribute

extraction_configuration: ExtractionConfiguration

The configuration that defines how data is extracted, including the prompt hint and not-found behavior.

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

A unique name of the extraction definition.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource.