extraction_definitions

Creates, updates, deletes, gets or lists an extraction_definitions resource.

Overview

Name	extraction_definitions
Type	Resource
Id	aws.connect.extraction_definitions

Fields

The following fields are returned by SELECT queries:

describe_extraction_definition

Name	Datatype	Description
created_time	string (date-time)	The timestamp when the extraction definition was created.
display	object	The display configuration for an extraction definition.
extraction_configuration	object	The extraction configuration that defines how data is extracted from customer interactions.
extraction_definition_arn	string	The Amazon Resource Name (ARN) of the extraction definition.
extraction_definition_id	string	The identifier of the extraction definition.
last_updated_by	string	The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
last_updated_time	string (date-time)	The timestamp when the extraction definition was last updated.
name	string	The name of the extraction definition.
tags	object	The tags used to organize, track, or control access for this resource.

list_extraction_definitions

Name	Datatype	Description
created_time	string (date-time)	The timestamp when the extraction definition was created.
extraction_definition_arn	string	The Amazon Resource Name (ARN) of the extraction definition.
extraction_definition_id	string	The identifier of the extraction definition.
last_updated_by	string	The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
last_updated_time	string (date-time)	The timestamp when the extraction definition was last updated.
name	string	The name of the extraction definition.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_extraction_definition	select	instance_id, extraction_definition_id, region		Describes an extraction definition in the specified Connect Customer instance.
list_extraction_definitions	select	instance_id, region	maxResults, nextToken	Lists extraction definitions in the specified Connect Customer instance.
create_extraction_definition	insert	instance_id, region, ExtractionConfiguration		Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found.
update_extraction_definition	update	extraction_definition_id, instance_id, region, ExtractionConfiguration		Updates an extraction definition in the specified Connect Customer instance.
delete_extraction_definition	delete	instance_id, extraction_definition_id, region		Deletes an extraction definition from the specified Connect Customer instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
extraction_definition_id	string	The identifier of the extraction definition to delete.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

describe_extraction_definition

Describes an extraction definition in the specified Connect Customer instance.

SELECT
created_time,
display,
extraction_configuration,
extraction_definition_arn,
extraction_definition_id,
last_updated_by,
last_updated_time,
name,
tags
FROM aws.connect.extraction_definitions
WHERE instance_id = '{{ instance_id }}' -- required
AND extraction_definition_id = '{{ extraction_definition_id }}' -- required
AND region = '{{ region }}' -- required
;

list_extraction_definitions

Lists extraction definitions in the specified Connect Customer instance.

SELECT
created_time,
extraction_definition_arn,
extraction_definition_id,
last_updated_by,
last_updated_time,
name
FROM aws.connect.extraction_definitions
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_extraction_definition

Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found.

INSERT INTO aws.connect.extraction_definitions (
ClientToken,
Name,
ExtractionConfiguration,
Display,
Tags,
instance_id,
region
)
SELECT 
'{{ ClientToken }}',
'{{ Name }}',
'{{ ExtractionConfiguration }}' /* required */,
'{{ Display }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
extraction_definition_arn,
extraction_definition_id
;

Manifest

# Description fields are for documentation purposes
- name: extraction_definitions
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the extraction_definitions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the extraction_definitions resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Name
    value: "{{ Name }}"
  - name: ExtractionConfiguration
    description: |
      The extraction configuration that defines how data is extracted from customer interactions.
    value:
      PromptHint: "{{ PromptHint }}"
      NotFoundBehavior:
        Behavior: "{{ Behavior }}"
        DefaultValue: "{{ DefaultValue }}"
  - name: Display
    description: |
      The display configuration for an extraction definition.
    value:
      Label: "{{ Label }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_extraction_definition

Updates an extraction definition in the specified Connect Customer instance.

UPDATE aws.connect.extraction_definitions
SET 
ClientToken = '{{ ClientToken }}',
Name = '{{ Name }}',
ExtractionConfiguration = '{{ ExtractionConfiguration }}',
Display = '{{ Display }}'
WHERE 
extraction_definition_id = '{{ extraction_definition_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND ExtractionConfiguration = '{{ ExtractionConfiguration }}' --required;

DELETE examples

delete_extraction_definition

Deletes an extraction definition from the specified Connect Customer instance.

DELETE FROM aws.connect.extraction_definitions
WHERE instance_id = '{{ instance_id }}' --required
AND extraction_definition_id = '{{ extraction_definition_id }}' --required
AND region = '{{ region }}' --required
;