CreateExtractionDefinition
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.
Request Syntax
POST /extraction-definitions/InstanceId HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"Display": {
"Label": "string"
},
"ExtractionConfiguration": {
"NotFoundBehavior": {
"Behavior": "string",
"DefaultValue": "string"
},
"PromptHint": "string"
},
"Name": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- 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.
Type: String
Length Constraints: Maximum length of 500.
Required: No
- Display
-
The display settings for the extraction definition, including the label shown in the agent workspace.
Type: ExtractionDefinitionDisplay object
Required: No
- ExtractionConfiguration
-
The configuration that defines how data is extracted, including the prompt hint and not-found behavior.
Type: ExtractionConfiguration object
Required: Yes
- Name
-
A unique name of the extraction definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
- Tags
-
The tags used to organize, track, or control access for this resource.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ExtractionDefinitionArn": "string",
"ExtractionDefinitionId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ExtractionDefinitionArn
-
The Amazon Resource Name (ARN) of the extraction definition.
Type: String
- ExtractionDefinitionId
-
The identifier of the extraction definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
- Message
-
The message.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- Message
-
The message about the request.
- Reason
-
Reason why the request was invalid.
HTTP Status Code: 400
- ResourceConflictException
-
A resource already has that name.
HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The message about the resource.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The service quota has been exceeded.
- Reason
-
The reason for the exception.
HTTP Status Code: 402
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
