Connect / Client / update_extraction_definition

update_extraction_definition

Connect.Client.update_extraction_definition(**kwargs)

Updates an extraction definition in the specified Connect Customer instance.

See also: AWS API Documentation

Request Syntax

response = client.update_extraction_definition(
    ClientToken='string',
    ExtractionDefinitionId='string',
    InstanceId='string',
    Name='string',
    ExtractionConfiguration={
        'PromptHint': 'string',
        'NotFoundBehavior': {
            'Behavior': 'USE_DEFAULT_VALUE'|'OMIT',
            'DefaultValue': 'string'
        }
    },
    Display={
        'Label': 'string'
    }
)

Parameters:

• ClientToken (string) –

  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.

  This field is autopopulated if not provided.

• ExtractionDefinitionId (string) –

  [REQUIRED]

  The identifier of the extraction definition to update.

• InstanceId (string) –

  [REQUIRED]

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

• Name (string) –

  [REQUIRED]

  The name of the extraction definition.

• ExtractionConfiguration (dict) –

  [REQUIRED]

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

  • PromptHint (string) – [REQUIRED]

    The prompt hint that guides the extraction. This text tells the generative AI model what data to look for in the customer interaction.

  • NotFoundBehavior (dict) –

    The behavior when the extraction cannot find the specified data in the interaction.

    • Behavior (string) – [REQUIRED]

      The behavior type. USE_DEFAULT_VALUE returns the specified default value. OMIT excludes the field from the output.

    • DefaultValue (string) –

      The default value to use when the behavior is USE_DEFAULT_VALUE.

• Display (dict) –

  The display settings for the extraction definition.

  • Label (string) –

    The label displayed in the agent workspace for this extraction definition.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.ResourceConflictException