Amazon Connect Connect Storage Config API

openapi: 3.1.0
info:
  title: Amazon Connect Service Storage Config 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:
  /instance/{InstanceId}/storage-config:
    put:
      operationId: AssociateInstanceStorageConfig
      summary: Associate Instance Storage Config
      description: This API is in preview release for Connect Customer and is subject to change. Associates a storage resource
        type for the first time. You can only associate one type of storage configuration in a single call. This means, for
        example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not
        create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified
        in the storage configuration, like an S3 bucket, exists when being used for association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateInstanceStorageConfigResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/AssociateInstanceStorageConfigRequest'
      tags:
      - Storage Config
  /instance/{InstanceId}/storage-config/{AssociationId}:
    get:
      operationId: DescribeInstanceStorageConfig
      summary: Describe Instance Storage Config
      description: This API is in preview release for Connect Customer and is subject to change. Retrieves the current storage
        configurations for the specified resource type, association ID, and instance ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeInstanceStorageConfigResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/DescribeInstanceStorageConfigRequest'
      tags:
      - Storage Config
    delete:
      operationId: DisassociateInstanceStorageConfig
      summary: Disassociate Instance Storage Config
      description: This API is in preview release for Connect Customer and is subject to change. Removes the storage type
        configurations for the specified resource type and association ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/DisassociateInstanceStorageConfigRequest'
      tags:
      - Storage Config
    post:
      operationId: UpdateInstanceStorageConfig
      summary: Update Instance Storage Config
      description: This API is in preview release for Connect Customer and is subject to change. Updates an existing configuration
        for a resource type. This API is idempotent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/UpdateInstanceStorageConfigRequest'
      tags:
      - Storage Config
  /instance/{InstanceId}/storage-configs:
    get:
      operationId: ListInstanceStorageConfigs
      summary: List Instance Storage Configs
      description: This API is in preview release for Connect Customer and is subject to change. Returns a paginated list
        of storage configs for the identified instance and resource type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstanceStorageConfigsResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/ListInstanceStorageConfigsRequest'
      tags:
      - Storage Config
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:
    AssociateInstanceStorageConfigRequest:
      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.
        ResourceType:
          type: string
          enum:
          - CHAT_TRANSCRIPTS
          - CALL_RECORDINGS
          - SCHEDULED_REPORTS
          - MEDIA_STREAMS
          - CONTACT_TRACE_RECORDS
          - AGENT_EVENTS
          - REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
          - ATTACHMENTS
          - CONTACT_EVALUATIONS
          - SCREEN_RECORDINGS
          - REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
          - REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
          - EMAIL_MESSAGES
          description: 'A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:
            For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS. For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
            REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel
            contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. If you have previously
            associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOI'
        StorageConfig:
          $ref: '#/components/schemas/InstanceStorageConfig'
        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. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - InstanceId
      - ResourceType
      - StorageConfig
    AssociateInstanceStorageConfigResponse:
      type: object
      properties:
        AssociationId:
          type: string
          description: The existing association identifier that uniquely identifies the resource type and storage config for
            the given instance ID.
    DescribeInstanceStorageConfigRequest:
      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.
        AssociationId:
          type: string
          description: The existing association identifier that uniquely identifies the resource type and storage config for
            the given instance ID.
        ResourceType:
          type: string
          enum:
          - CHAT_TRANSCRIPTS
          - CALL_RECORDINGS
          - SCHEDULED_REPORTS
          - MEDIA_STREAMS
          - CONTACT_TRACE_RECORDS
          - AGENT_EVENTS
          - REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
          - ATTACHMENTS
          - CONTACT_EVALUATIONS
          - SCREEN_RECORDINGS
          - REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
          - REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
          - EMAIL_MESSAGES
          description: A valid resource type.
      required:
      - InstanceId
      - AssociationId
      - ResourceType
    DescribeInstanceStorageConfigResponse:
      type: object
      properties:
        StorageConfig:
          $ref: '#/components/schemas/InstanceStorageConfig'
    DisassociateInstanceStorageConfigRequest:
      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.
        AssociationId:
          type: string
          description: The existing association identifier that uniquely identifies the resource type and storage config for
            the given instance ID.
        ResourceType:
          type: string
          enum:
          - CHAT_TRANSCRIPTS
          - CALL_RECORDINGS
          - SCHEDULED_REPORTS
          - MEDIA_STREAMS
          - CONTACT_TRACE_RECORDS
          - AGENT_EVENTS
          - REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
          - ATTACHMENTS
          - CONTACT_EVALUATIONS
          - SCREEN_RECORDINGS
          - REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
          - REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
          - EMAIL_MESSAGES
          description: A valid resource type.
        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. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - InstanceId
      - AssociationId
      - ResourceType
    EncryptionConfig:
      type: object
      properties:
        EncryptionType:
          type: string
          enum:
          - KMS
          description: The type of encryption.
        KeyId:
          type: string
          description: The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just
            the ID. Connect Customer supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
      required:
      - EncryptionType
      - KeyId
    InstanceStorageConfig:
      type: object
      properties:
        AssociationId:
          type: string
          description: The existing association identifier that uniquely identifies the resource type and storage config for
            the given instance ID.
        StorageType:
          type: string
          enum:
          - S3
          - KINESIS_VIDEO_STREAM
          - KINESIS_STREAM
          - KINESIS_FIREHOSE
          description: A valid storage type.
        S3Config:
          $ref: '#/components/schemas/S3Config'
        KinesisVideoStreamConfig:
          $ref: '#/components/schemas/KinesisVideoStreamConfig'
        KinesisStreamConfig:
          $ref: '#/components/schemas/KinesisStreamConfig'
        KinesisFirehoseConfig:
          $ref: '#/components/schemas/KinesisFirehoseConfig'
      required:
      - StorageType
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    KinesisFirehoseConfig:
      type: object
      properties:
        FirehoseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the delivery stream.
      required:
      - FirehoseArn
    KinesisStreamConfig:
      type: object
      properties:
        StreamArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data stream.
      required:
      - StreamArn
    KinesisVideoStreamConfig:
      type: object
      properties:
        Prefix:
          type: string
          description: The prefix of the video stream.
        RetentionPeriodHours:
          type: integer
          description: The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data
            store that is associated with the stream. The default value is 0, indicating that the stream does not persist
            data.
        EncryptionConfig:
          $ref: '#/components/schemas/EncryptionConfig'
      required:
      - Prefix
      - RetentionPeriodHours
      - EncryptionConfig
    ListInstanceStorageConfigsRequest:
      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.
        ResourceType:
          type: string
          enum:
          - CHAT_TRANSCRIPTS
          - CALL_RECORDINGS
          - SCHEDULED_REPORTS
          - MEDIA_STREAMS
          - CONTACT_TRACE_RECORDS
          - AGENT_EVENTS
          - REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
          - ATTACHMENTS
          - CONTACT_EVALUATIONS
          - SCREEN_RECORDINGS
          - REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
          - REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
          - EMAIL_MESSAGES
          description: A valid resource type.
        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.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
      required:
      - InstanceId
      - ResourceType
    ListInstanceStorageConfigsResponse:
      type: object
      properties:
        StorageConfigs:
          type: array
          items:
            $ref: '#/components/schemas/InstanceStorageConfig'
          description: A valid storage type.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    ResourceConflictException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    S3Config:
      type: object
      properties:
        BucketName:
          type: string
          description: The S3 bucket name.
        BucketPrefix:
          type: string
          description: The S3 bucket prefix.
        EncryptionConfig:
          $ref: '#/components/schemas/EncryptionConfig'
      required:
      - BucketName
      - BucketPrefix
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateInstanceStorageConfigRequest:
      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.
        AssociationId:
          type: string
          description: The existing association identifier that uniquely identifies the resource type and storage config for
            the given instance ID.
        ResourceType:
          type: string
          enum:
          - CHAT_TRANSCRIPTS
          - CALL_RECORDINGS
          - SCHEDULED_REPORTS
          - MEDIA_STREAMS
          - CONTACT_TRACE_RECORDS
          - AGENT_EVENTS
          - REAL_TIME_CONTACT_ANALYSIS_SEGMENTS
          - ATTACHMENTS
          - CONTACT_EVALUATIONS
          - SCREEN_RECORDINGS
          - REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS
          - REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
          - EMAIL_MESSAGES
          description: A valid resource type.
        StorageConfig:
          $ref: '#/components/schemas/InstanceStorageConfig'
        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. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - InstanceId
      - AssociationId
      - ResourceType
      - StorageConfig
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)