Connect / Client / describe_extraction_definition

describe_extraction_definition

Connect.Client.describe_extraction_definition(**kwargs)

Describes an extraction definition in the specified Connect Customer instance.

See also: AWS API Documentation

Request Syntax

response = client.describe_extraction_definition(
    InstanceId='string',
    ExtractionDefinitionId='string'
)

Parameters:

• 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.

• ExtractionDefinitionId (string) –

  [REQUIRED]

  The identifier of the extraction definition to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ExtractionDefinition': {
        'Name': 'string',
        'ExtractionDefinitionId': 'string',
        'ExtractionDefinitionArn': 'string',
        'ExtractionConfiguration': {
            'PromptHint': 'string',
            'NotFoundBehavior': {
                'Behavior': 'USE_DEFAULT_VALUE'|'OMIT',
                'DefaultValue': 'string'
            }
        },
        'Display': {
            'Label': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'LastUpdatedBy': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • ExtractionDefinition (dict) –

    The extraction definition.

    • Name (string) –

      The name of the extraction definition.

    • ExtractionDefinitionId (string) –

      The identifier of the extraction definition.

    • ExtractionDefinitionArn (string) –

      The Amazon Resource Name (ARN) of the extraction definition.

    • ExtractionConfiguration (dict) –

      The configuration that defines how data is extracted.

      • PromptHint (string) –

        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) –

          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.

    • CreatedTime (datetime) –

      The timestamp when the extraction definition was created.

    • LastUpdatedTime (datetime) –

      The timestamp when the extraction definition was last updated.

    • LastUpdatedBy (string) –

      The Amazon Resource Name (ARN) of the user who last updated the extraction definition.

    • Tags (dict) –

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

      • (string) –

        • (string) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.AccessDeniedException