Amazon Connect Connect Domains API

openapi: 3.1.0
info:
  title: Amazon Connect Service Domains API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 2 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://profile.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains:
    get:
      operationId: ListDomains
      summary: List Domains
      description: Returns a list of all the domains for an AWS account that have been created.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileListDomainsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileListDomainsRequest'
      tags:
      - Domains
  /#ListDomains:
    post:
      operationId: ListDomains
      summary: List Domains
      description: Lists all the domains in the Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/VoiceidListDomainsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/VoiceidInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/VoiceidValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - VoiceID.ListDomains
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/VoiceidListDomainsRequest'
      tags:
      - Domains
      servers:
      - url: https://voiceid.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_voiceid: []
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: profile
    sigv4_voiceid:
      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: voiceid
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    ListDomainItem:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the domain was created.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the domain was most recently edited.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - DomainName
      - CreatedAt
      - LastUpdatedAt
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileListDomainsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token from the previous ListDomain API call.
        MaxResults:
          type: integer
          description: The maximum number of objects returned per page.
    ProfileListDomainsResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ListDomainItem'
          description: The list of ListDomains instances.
        NextToken:
          type: string
          description: The pagination token from the previous ListDomains API call.
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServerSideEncryptionConfiguration:
      type: object
      properties:
        KmsKeyId:
          type: string
          description: The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric
            customer managed keys.
      required:
      - KmsKeyId
    ServerSideEncryptionUpdateDetails:
      type: object
      properties:
        OldKmsKeyId:
          type: string
          description: The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was
            updated to a new KMS key ID.
        UpdateStatus:
          type: string
          description: Status of the server-side encryption update. During an update, if there is an issue with the domain's
            current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve
            this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption
            configuration will re-attempt this update process.
        Message:
          type: string
          description: Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains
            the cause of the failure.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    VoiceidDomainSummary:
      type: object
      properties:
        DomainId:
          type: string
          description: The identifier of the domain.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the domain.
        Name:
          type: string
          description: The client-provided name for the domain.
        Description:
          type: string
          description: The description of the domain.
        DomainStatus:
          type: string
          description: The current status of the domain.
        ServerSideEncryptionConfiguration:
          $ref: '#/components/schemas/ServerSideEncryptionConfiguration'
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the domain was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The timestamp of when the domain was last updated.
        ServerSideEncryptionUpdateDetails:
          $ref: '#/components/schemas/ServerSideEncryptionUpdateDetails'
        WatchlistDetails:
          $ref: '#/components/schemas/WatchlistDetails'
    VoiceidInternalServerException:
      type: object
      properties:
        Message:
          type: string
    VoiceidListDomainsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of results that are returned per call. You can use NextToken to obtain more pages
            of results. The default is 100; the maximum allowed page size is also 100.
        NextToken:
          type: string
          description: If NextToken is returned, there are more results available. The value of NextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments
            unchanged. Each pagination token expires after 24 hours.
    VoiceidListDomainsResponse:
      type: object
      properties:
        DomainSummaries:
          type: array
          items:
            $ref: '#/components/schemas/VoiceidDomainSummary'
          description: A list containing details about each domain in the Amazon Web Services account.
        NextToken:
          type: string
          description: If NextToken is returned, there are more results available. The value of NextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments
            unchanged. Each pagination token expires after 24 hours.
    VoiceidValidationException:
      type: object
      properties:
        Message:
          type: string
    WatchlistDetails:
      type: object
      properties:
        DefaultWatchlistId:
          type: string
          description: The identifier of the default watchlist.
      required:
      - DefaultWatchlistId
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/voice-id/service/2021-09-27/voice-id-2021-09-27.json