schemas/openapi3/aws-contact-lens-2020-08-21.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "aws-contact-lens",
    "version": "2020-08-21",
    "description": "Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities. It performs sentiment analysis, detects issues, and enables you to automatically categorize contacts. Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent conversations. For more information, see Analyze conversations using Contact Lens in the Amazon Connect Administrator Guide.",
    "termsOfService": "https://aws.amazon.com/service-terms/",
    "contact": {
      "name": "Mike Ralphson",
      "email": "mike.ralphson@gmail.com",
      "url": "https://github.com/mermade/aws2openapi"
    },
    "license": {
      "name": "Apache 2.0 License",
      "url": "http://www.apache.org/licenses/"
    }
  },
  "paths": {
    "/realtime-contact-analysis/analysis-segments": {
      "post": {
        "operationId": "ListRealtimeContactAnalysisSegments",
        "description": "Provides a list of analysis segments for a real-time analysis session.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListRealtimeContactAnalysisSegmentsResponse"
                }
              }
            }
          },
          "480": {
            "description": "InvalidRequestException",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidRequestException"
                }
              }
            }
          },
          "481": {
            "description": "AccessDeniedException",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessDeniedException"
                }
              }
            }
          },
          "482": {
            "description": "ResourceNotFoundException",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceNotFoundException"
                }
              }
            }
          },
          "483": {
            "description": "InternalServiceException",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServiceException"
                }
              }
            }
          },
          "484": {
            "description": "ThrottlingException",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ThrottlingException" }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "MaxResults",
            "in": "query",
            "schema": { "type": "string" },
            "description": "Pagination limit",
            "required": false
          },
          {
            "name": "NextToken",
            "in": "query",
            "schema": { "type": "string" },
            "description": "Pagination token",
            "required": false
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["InstanceId", "ContactId"],
                "properties": {
                  "InstanceId": {
                    "description": "The identifier of the Amazon Connect instance.",
                    "type": "string",
                    "pattern": ".*\\S.*",
                    "minLength": 1,
                    "maxLength": 256
                  },
                  "ContactId": {
                    "description": "The identifier of the contact.",
                    "type": "string",
                    "pattern": ".*\\S.*",
                    "minLength": 1,
                    "maxLength": 256
                  },
                  "MaxResults": {
                    "description": "The maximimum number of results to return per page.",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 100
                  },
                  "NextToken": {
                    "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.",
                    "type": "string",
                    "pattern": ".*\\S.*",
                    "minLength": 1,
                    "maxLength": 131070
                  }
                }
              }
            }
          }
        },
        "summary": "List Realtime Contact Analysis Segments"
      },
      "parameters": [
        { "$ref": "#/components/parameters/X-Amz-Content-Sha256" },
        { "$ref": "#/components/parameters/X-Amz-Date" },
        { "$ref": "#/components/parameters/X-Amz-Algorithm" },
        { "$ref": "#/components/parameters/X-Amz-Credential" },
        { "$ref": "#/components/parameters/X-Amz-Security-Token" },
        { "$ref": "#/components/parameters/X-Amz-Signature" },
        { "$ref": "#/components/parameters/X-Amz-SignedHeaders" }
      ]
    }
  },
  "externalDocs": {
    "description": "Amazon Web Services documentation",
    "url": "https://docs.aws.amazon.com/contact-lens/"
  },
  "servers": [
    {
      "url": "http://contact-lens.{region}.amazonaws.com",
      "variables": {
        "region": {
          "description": "The AWS region",
          "enum": [
            "us-east-1",
            "us-east-2",
            "us-west-1",
            "us-west-2",
            "us-gov-west-1",
            "us-gov-east-1",
            "ca-central-1",
            "eu-north-1",
            "eu-west-1",
            "eu-west-2",
            "eu-west-3",
            "eu-central-1",
            "eu-south-1",
            "af-south-1",
            "ap-northeast-1",
            "ap-northeast-2",
            "ap-northeast-3",
            "ap-southeast-1",
            "ap-southeast-2",
            "ap-east-1",
            "ap-south-1",
            "sa-east-1",
            "me-south-1"
          ],
          "default": "us-east-1"
        }
      },
      "description": "The Amazon Connect Contact Lens multi-region endpoint"
    },
    {
      "url": "https://contact-lens.{region}.amazonaws.com",
      "variables": {
        "region": {
          "description": "The AWS region",
          "enum": [
            "us-east-1",
            "us-east-2",
            "us-west-1",
            "us-west-2",
            "us-gov-west-1",
            "us-gov-east-1",
            "ca-central-1",
            "eu-north-1",
            "eu-west-1",
            "eu-west-2",
            "eu-west-3",
            "eu-central-1",
            "eu-south-1",
            "af-south-1",
            "ap-northeast-1",
            "ap-northeast-2",
            "ap-northeast-3",
            "ap-southeast-1",
            "ap-southeast-2",
            "ap-east-1",
            "ap-south-1",
            "sa-east-1",
            "me-south-1"
          ],
          "default": "us-east-1"
        }
      },
      "description": "The Amazon Connect Contact Lens multi-region endpoint"
    },
    {
      "url": "http://contact-lens.{region}.amazonaws.com.cn",
      "variables": {
        "region": {
          "description": "The AWS region",
          "enum": ["cn-north-1", "cn-northwest-1"],
          "default": "cn-north-1"
        }
      },
      "description": "The Amazon Connect Contact Lens endpoint for China (Beijing) and China (Ningxia)"
    },
    {
      "url": "https://contact-lens.{region}.amazonaws.com.cn",
      "variables": {
        "region": {
          "description": "The AWS region",
          "enum": ["cn-north-1", "cn-northwest-1"],
          "default": "cn-north-1"
        }
      },
      "description": "The Amazon Connect Contact Lens endpoint for China (Beijing) and China (Ningxia)"
    }
  ],
  "components": {
    "parameters": {
      "X-Amz-Content-Sha256": {
        "name": "X-Amz-Content-Sha256",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      },
      "X-Amz-Date": {
        "name": "X-Amz-Date",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      },
      "X-Amz-Algorithm": {
        "name": "X-Amz-Algorithm",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      },
      "X-Amz-Credential": {
        "name": "X-Amz-Credential",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      },
      "X-Amz-Security-Token": {
        "name": "X-Amz-Security-Token",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      },
      "X-Amz-Signature": {
        "name": "X-Amz-Signature",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      },
      "X-Amz-SignedHeaders": {
        "name": "X-Amz-SignedHeaders",
        "in": "header",
        "schema": { "type": "string" },
        "required": false,
        "x-ignore": true
      }
    },
    "securitySchemes": {
      "hmac": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "Amazon Signature authorization v4"
      }
    },
    "schemas": {
      "ListRealtimeContactAnalysisSegmentsResponse": {
        "type": "object",
        "required": ["Segments"],
        "properties": {
          "Segments": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RealtimeContactAnalysisSegments"
              },
              { "description": "An analyzed transcript or category." }
            ]
          },
          "NextToken": {
            "allOf": [
              { "$ref": "#/components/schemas/NextToken" },
              {
                "description": "<p>If there are additional results, this is the token for the next set of results. If response includes <code>nextToken</code> there are two possible scenarios:</p> <ul> <li> <p>There are more segments so another call is required to get them.</p> </li> <li> <p>There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.</p> </li> </ul> <p>If response does not include <code>nextToken</code>, the analysis is completed (successfully or failed) and there are no more segments to retrieve.</p>"
              }
            ]
          }
        }
      },
      "InvalidRequestException": {},
      "AccessDeniedException": {},
      "ResourceNotFoundException": {},
      "InternalServiceException": {},
      "ThrottlingException": {},
      "MatchedCategories": {
        "type": "array",
        "items": { "$ref": "#/components/schemas/CategoryName" },
        "minItems": 0,
        "maxItems": 150
      },
      "MatchedDetails": {
        "type": "object",
        "minProperties": 0,
        "maxProperties": 150,
        "additionalProperties": {
          "$ref": "#/components/schemas/CategoryDetails"
        }
      },
      "Categories": {
        "type": "object",
        "required": ["MatchedCategories", "MatchedDetails"],
        "properties": {
          "MatchedCategories": {
            "allOf": [
              { "$ref": "#/components/schemas/MatchedCategories" },
              {
                "description": "The category rules that have been matched in the analyzed segment."
              }
            ]
          },
          "MatchedDetails": {
            "allOf": [
              { "$ref": "#/components/schemas/MatchedDetails" },
              {
                "description": "The category rule that was matched and when it occurred in the transcript."
              }
            ]
          }
        },
        "description": "Provides the category rules that are used to automatically categorize contacts based on uttered keywords and phrases."
      },
      "PointsOfInterest": {
        "type": "array",
        "items": { "$ref": "#/components/schemas/PointOfInterest" },
        "minItems": 0,
        "maxItems": 20
      },
      "CategoryDetails": {
        "type": "object",
        "required": ["PointsOfInterest"],
        "properties": {
          "PointsOfInterest": {
            "allOf": [
              { "$ref": "#/components/schemas/PointsOfInterest" },
              {
                "description": "The section of audio where the category rule was detected."
              }
            ]
          }
        },
        "description": "Provides information about the category rule that was matched."
      },
      "CategoryName": {
        "type": "string",
        "pattern": ".*\\S.*",
        "minLength": 1,
        "maxLength": 256
      },
      "CharacterOffset": { "type": "integer", "minimum": 0 },
      "CharacterOffsets": {
        "type": "object",
        "required": ["BeginOffsetChar", "EndOffsetChar"],
        "properties": {
          "BeginOffsetChar": {
            "allOf": [
              { "$ref": "#/components/schemas/CharacterOffset" },
              { "description": "The beginning of the issue." }
            ]
          },
          "EndOffsetChar": {
            "allOf": [
              { "$ref": "#/components/schemas/CharacterOffset" },
              { "description": "The end of the issue." }
            ]
          }
        },
        "description": "For characters that were detected as issues, where they occur in the transcript."
      },
      "IssueDetected": {
        "type": "object",
        "required": ["CharacterOffsets"],
        "properties": {
          "CharacterOffsets": {
            "allOf": [
              { "$ref": "#/components/schemas/CharacterOffsets" },
              {
                "description": "The offset for when the issue was detected in the segment."
              }
            ]
          }
        },
        "description": "Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation."
      },
      "IssuesDetected": {
        "type": "array",
        "items": { "$ref": "#/components/schemas/IssueDetected" },
        "minItems": 0,
        "maxItems": 20
      },
      "NextToken": {
        "type": "string",
        "pattern": ".*\\S.*",
        "minLength": 1,
        "maxLength": 131070
      },
      "RealtimeContactAnalysisSegments": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/RealtimeContactAnalysisSegment"
        },
        "minItems": 0,
        "maxItems": 100
      },
      "OffsetMillis": { "type": "integer", "minimum": 0 },
      "ParticipantId": {
        "type": "string",
        "pattern": ".*\\S.*",
        "minLength": 1,
        "maxLength": 256
      },
      "ParticipantRole": {
        "type": "string",
        "pattern": ".*\\S.*",
        "minLength": 1,
        "maxLength": 256
      },
      "PointOfInterest": {
        "type": "object",
        "required": ["BeginOffsetMillis", "EndOffsetMillis"],
        "properties": {
          "BeginOffsetMillis": {
            "allOf": [
              { "$ref": "#/components/schemas/OffsetMillis" },
              {
                "description": "The beginning offset in milliseconds where the category rule was detected."
              }
            ]
          },
          "EndOffsetMillis": {
            "allOf": [
              { "$ref": "#/components/schemas/OffsetMillis" },
              {
                "description": "The ending offset in milliseconds where the category rule was detected."
              }
            ]
          }
        },
        "description": "The section of the contact audio where that category rule was detected."
      },
      "Transcript": {
        "type": "object",
        "required": [
          "Id",
          "ParticipantId",
          "ParticipantRole",
          "Content",
          "BeginOffsetMillis",
          "EndOffsetMillis",
          "Sentiment"
        ],
        "properties": {
          "Id": {
            "allOf": [
              { "$ref": "#/components/schemas/TranscriptId" },
              { "description": "The identifier of the transcript." }
            ]
          },
          "ParticipantId": {
            "allOf": [
              { "$ref": "#/components/schemas/ParticipantId" },
              { "description": "The identifier of the participant." }
            ]
          },
          "ParticipantRole": {
            "allOf": [
              { "$ref": "#/components/schemas/ParticipantRole" },
              {
                "description": "The role of participant. For example, is it a customer, agent, or system."
              }
            ]
          },
          "Content": {
            "allOf": [
              { "$ref": "#/components/schemas/TranscriptContent" },
              { "description": "The content of the transcript." }
            ]
          },
          "BeginOffsetMillis": {
            "allOf": [
              { "$ref": "#/components/schemas/OffsetMillis" },
              {
                "description": "The beginning offset in the contact for this transcript."
              }
            ]
          },
          "EndOffsetMillis": {
            "allOf": [
              { "$ref": "#/components/schemas/OffsetMillis" },
              {
                "description": "The end offset in the contact for this transcript."
              }
            ]
          },
          "Sentiment": {
            "allOf": [
              { "$ref": "#/components/schemas/SentimentValue" },
              {
                "description": "The sentiment of the detected for this piece of transcript."
              }
            ]
          },
          "IssuesDetected": {
            "allOf": [
              { "$ref": "#/components/schemas/IssuesDetected" },
              {
                "description": "List of positions where issues were detected on the transcript."
              }
            ]
          }
        },
        "description": "A list of messages in the session."
      },
      "RealtimeContactAnalysisSegment": {
        "type": "object",
        "properties": {
          "Transcript": {
            "allOf": [
              { "$ref": "#/components/schemas/Transcript" },
              { "description": "The analyzed transcript." }
            ]
          },
          "Categories": {
            "allOf": [
              { "$ref": "#/components/schemas/Categories" },
              { "description": "The matched category rules." }
            ]
          }
        },
        "description": "An analyzed segment for a real-time analysis session."
      },
      "SentimentValue": {
        "type": "string",
        "enum": ["POSITIVE", "NEUTRAL", "NEGATIVE"]
      },
      "TranscriptId": {
        "type": "string",
        "pattern": ".*\\S.*",
        "minLength": 1,
        "maxLength": 256
      },
      "TranscriptContent": {
        "type": "string",
        "pattern": ".*\\S.*",
        "minLength": 1
      }
    }
  },
  "security": [{ "hmac": [] }],
  "x-metadata": {
    "apiVersion": "2020-08-21",
    "endpointPrefix": "contact-lens",
    "jsonVersion": "1.1",
    "protocol": "rest-json",
    "serviceAbbreviation": "Amazon Connect Contact Lens",
    "serviceFullName": "Amazon Connect Contact Lens",
    "serviceId": "Connect Contact Lens",
    "signatureVersion": "v4",
    "signingName": "connect",
    "uid": "connect-contact-lens-2020-08-21",
    "targetPrefix": "AmazonConnectContactLens"
  }
}