Amazon Connect Connect Extraction Definitions API

openapi: 3.1.0
info:
  title: Amazon Connect Service Extraction Definitions API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /extraction-definitions/{InstanceId}:
    post:
      operationId: CreateExtractionDefinition
      summary: Create Extraction Definition
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateExtractionDefinitionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExtractionDefinitionRequest'
      tags:
      - Extraction Definitions
    get:
      operationId: ListExtractionDefinitions
      summary: List Extraction Definitions
      description: Lists extraction definitions in the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListExtractionDefinitionsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListExtractionDefinitionsRequest'
      tags:
      - Extraction Definitions
  /extraction-definitions/{InstanceId}/{ExtractionDefinitionId}:
    delete:
      operationId: DeleteExtractionDefinition
      summary: Delete Extraction Definition
      description: Deletes an extraction definition from the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteExtractionDefinitionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteExtractionDefinitionRequest'
      tags:
      - Extraction Definitions
    get:
      operationId: DescribeExtractionDefinition
      summary: Describe Extraction Definition
      description: Describes an extraction definition in the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeExtractionDefinitionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeExtractionDefinitionRequest'
      tags:
      - Extraction Definitions
    put:
      operationId: UpdateExtractionDefinition
      summary: Update Extraction Definition
      description: Updates an extraction definition in the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateExtractionDefinitionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExtractionDefinitionRequest'
      tags:
      - Extraction Definitions
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: connect
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CreateExtractionDefinitionRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: 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.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        Name:
          type: string
          description: A unique name of the extraction definition.
        ExtractionConfiguration:
          $ref: '#/components/schemas/ExtractionConfiguration'
        Display:
          $ref: '#/components/schemas/ExtractionDefinitionDisplay'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - InstanceId
      - Name
      - ExtractionConfiguration
    CreateExtractionDefinitionResponse:
      type: object
      properties:
        ExtractionDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the extraction definition.
        ExtractionDefinitionId:
          type: string
          description: The identifier of the extraction definition.
      required:
      - ExtractionDefinitionArn
      - ExtractionDefinitionId
    DeleteExtractionDefinitionRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ExtractionDefinitionId:
          type: string
          description: The identifier of the extraction definition to delete.
      required:
      - InstanceId
      - ExtractionDefinitionId
    DeleteExtractionDefinitionResponse:
      type: object
      properties: {}
    DescribeExtractionDefinitionRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        ExtractionDefinitionId:
          type: string
          description: The identifier of the extraction definition to describe.
      required:
      - InstanceId
      - ExtractionDefinitionId
    DescribeExtractionDefinitionResponse:
      type: object
      properties:
        ExtractionDefinition:
          $ref: '#/components/schemas/ExtractionDefinition'
      required:
      - ExtractionDefinition
    ExtractionConfiguration:
      type: object
      properties:
        PromptHint:
          type: string
          description: The prompt hint that guides the extraction. This text tells the generative AI model what data to look
            for in the customer interaction.
        NotFoundBehavior:
          $ref: '#/components/schemas/ExtractionDefinitionNotFoundBehavior'
      required:
      - PromptHint
    ExtractionDefinition:
      type: object
      properties:
        Name:
          type: string
          description: The name of the extraction definition.
        ExtractionDefinitionId:
          type: string
          description: The identifier of the extraction definition.
        ExtractionDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the extraction definition.
        ExtractionConfiguration:
          $ref: '#/components/schemas/ExtractionConfiguration'
        Display:
          $ref: '#/components/schemas/ExtractionDefinitionDisplay'
        CreatedTime:
          type: string
          format: date-time
          description: The timestamp when the extraction definition was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The timestamp when the extraction definition was last updated.
        LastUpdatedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - Name
      - ExtractionDefinitionId
      - ExtractionDefinitionArn
      - ExtractionConfiguration
      - CreatedTime
      - LastUpdatedTime
      - LastUpdatedBy
    ExtractionDefinitionDisplay:
      type: object
      properties:
        Label:
          type: string
          description: The label displayed in the agent workspace for this extraction definition.
    ExtractionDefinitionNotFoundBehavior:
      type: object
      properties:
        Behavior:
          type: string
          enum:
          - USE_DEFAULT_VALUE
          - OMIT
          description: The behavior type. USE_DEFAULT_VALUE returns the specified default value. OMIT excludes the field from
            the output.
        DefaultValue:
          type: string
          description: The default value to use when the behavior is USE_DEFAULT_VALUE.
      required:
      - Behavior
    ExtractionDefinitionSummary:
      type: object
      properties:
        Name:
          type: string
          description: The name of the extraction definition.
        ExtractionDefinitionId:
          type: string
          description: The identifier of the extraction definition.
        ExtractionDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the extraction definition.
        CreatedTime:
          type: string
          format: date-time
          description: The timestamp when the extraction definition was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The timestamp when the extraction definition was last updated.
        LastUpdatedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
      required:
      - Name
      - ExtractionDefinitionId
      - ExtractionDefinitionArn
      - CreatedTime
      - LastUpdatedTime
      - LastUpdatedBy
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the request.
        Reason:
          $ref: '#/components/schemas/InvalidRequestExceptionReason'
    InvalidRequestExceptionReason:
      type: object
      properties:
        AttachedFileInvalidRequestExceptionReason:
          type: string
          enum:
          - INVALID_FILE_SIZE
          - INVALID_FILE_TYPE
          - INVALID_FILE_NAME
          description: Reason why the StartAttachedFiledUpload request was invalid.
      description: Exactly one member is set.
    ListExtractionDefinitionsRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page. The default MaxResult size is 100.
        NextToken:
          type: string
          description: 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.
      required:
      - InstanceId
    ListExtractionDefinitionsResponse:
      type: object
      properties:
        ExtractionDefinitionSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ExtractionDefinitionSummary'
          description: Information about the extraction definitions.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - ExtractionDefinitionSummaryList
    ResourceConflictException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          $ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
    ServiceQuotaExceededExceptionReason:
      type: object
      properties:
        AttachedFileServiceQuotaExceededExceptionReason:
          type: string
          enum:
          - TOTAL_FILE_SIZE_EXCEEDED
          - TOTAL_FILE_COUNT_EXCEEDED
          description: Total file size of all files or total number of files exceeds the service quota
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateExtractionDefinitionRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: 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.
        ExtractionDefinitionId:
          type: string
          description: The identifier of the extraction definition to update.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        Name:
          type: string
          description: The name of the extraction definition.
        ExtractionConfiguration:
          $ref: '#/components/schemas/ExtractionConfiguration'
        Display:
          $ref: '#/components/schemas/ExtractionDefinitionDisplay'
      required:
      - ExtractionDefinitionId
      - InstanceId
      - Name
      - ExtractionConfiguration
    UpdateExtractionDefinitionResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)