Amazon Connect Connect Alias API

openapi: 3.1.0
info:
  title: Amazon Connect Service Alias API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 8 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:
  /contact-flows/{InstanceId}/{ContactFlowId}/alias:
    put:
      operationId: CreateContactFlowAlias
      summary: Create Contact Flow Alias
      description: Creates a named alias that points to a specific version of a flow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateContactFlowAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '429':
          description: LimitExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactFlowAliasRequest'
      tags:
      - Alias
  /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/alias:
    put:
      operationId: CreateContactFlowModuleAlias
      summary: Create Contact Flow Module Alias
      description: Creates a named alias that points to a specific version of a contact flow module.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateContactFlowModuleAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '429':
          description: LimitExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactFlowModuleAliasRequest'
      tags:
      - Alias
  /contact-flows/{InstanceId}/{ContactFlowId}/alias/{AliasId}:
    delete:
      operationId: DeleteContactFlowAlias
      summary: Delete Contact Flow Alias
      description: Deletes an alias from a flow without deleting the version that the alias points to.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteContactFlowAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DeleteContactFlowAliasRequest'
      tags:
      - Alias
    get:
      operationId: DescribeContactFlowAlias
      summary: Describe Contact Flow Alias
      description: Returns information about a specific flow alias, including the version that it points to.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeContactFlowAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DescribeContactFlowAliasRequest'
      tags:
      - Alias
    post:
      operationId: UpdateContactFlowAlias
      summary: Update Contact Flow Alias
      description: Updates the name, description, or flow version associated with an alias.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactFlowAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConditionalOperationFailedException; DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConditionalOperationFailedException'
        '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/UpdateContactFlowAliasRequest'
      tags:
      - Alias
  /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/alias/{AliasId}:
    delete:
      operationId: DeleteContactFlowModuleAlias
      summary: Delete Contact Flow Module Alias
      description: Removes an alias reference, breaking the named connection to the underlying module version without affecting
        the version itself.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteContactFlowModuleAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DeleteContactFlowModuleAliasRequest'
      tags:
      - Alias
    get:
      operationId: DescribeContactFlowModuleAlias
      summary: Describe Contact Flow Module Alias
      description: Retrieves detailed information about a specific alias, including which version it currently points to and
        its metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeContactFlowModuleAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DescribeContactFlowModuleAliasRequest'
      tags:
      - Alias
    post:
      operationId: UpdateContactFlowModuleAlias
      summary: Update Contact Flow Module Alias
      description: Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactFlowModuleAliasResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConditionalOperationFailedException; DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConditionalOperationFailedException'
        '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/UpdateContactFlowModuleAliasRequest'
      tags:
      - Alias
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
    ConditionalOperationFailedException:
      type: object
      properties:
        Message:
          type: string
    ContactFlowAliasInfo:
      type: object
      properties:
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        ContactFlowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        AliasId:
          type: string
          description: The identifier of the alias.
        Version:
          type: integer
          description: The version of the flow.
        Name:
          type: string
          description: The name of the alias.
        Description:
          type: string
          description: The description of the alias.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
    ContactFlowModuleAliasInfo:
      type: object
      properties:
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
        ContactFlowModuleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow module.
        AliasId:
          type: string
          description: The identifier of the alias.
        Version:
          type: integer
          description: The version of the flow module.
        Name:
          type: string
          description: The name of the alias.
        Description:
          type: string
          description: The description of the alias.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
    CreateContactFlowAliasRequest:
      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.
        Description:
          type: string
          description: The description of the alias.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        ContactFlowVersion:
          type: integer
          description: The version of the flow.
        AliasName:
          type: string
          description: The name of the alias.
      required:
      - InstanceId
      - ContactFlowId
      - ContactFlowVersion
      - AliasName
    CreateContactFlowAliasResponse:
      type: object
      properties:
        ContactFlowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        Id:
          type: string
          description: The identifier of the alias.
    CreateContactFlowModuleAliasRequest:
      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.
        Description:
          type: string
          description: The description of the alias.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
        ContactFlowModuleVersion:
          type: integer
          description: The version of the flow module.
        AliasName:
          type: string
          description: The name of the alias.
      required:
      - InstanceId
      - ContactFlowModuleId
      - ContactFlowModuleVersion
      - AliasName
    CreateContactFlowModuleAliasResponse:
      type: object
      properties:
        ContactFlowModuleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow module.
        Id:
          type: string
          description: The identifier of the alias.
    DeleteContactFlowAliasRequest:
      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.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        AliasId:
          type: string
          description: The identifier of the alias.
      required:
      - InstanceId
      - ContactFlowId
      - AliasId
    DeleteContactFlowAliasResponse:
      type: object
      properties: {}
    DeleteContactFlowModuleAliasRequest:
      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.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
        AliasId:
          type: string
          description: The identifier of the alias.
      required:
      - InstanceId
      - ContactFlowModuleId
      - AliasId
    DeleteContactFlowModuleAliasResponse:
      type: object
      properties: {}
    DescribeContactFlowAliasRequest:
      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.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        AliasId:
          type: string
          description: The identifier of the alias.
      required:
      - InstanceId
      - ContactFlowId
      - AliasId
    DescribeContactFlowAliasResponse:
      type: object
      properties:
        ContactFlowAlias:
          $ref: '#/components/schemas/ContactFlowAliasInfo'
    DescribeContactFlowModuleAliasRequest:
      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.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
        AliasId:
          type: string
          description: The identifier of the alias.
      required:
      - InstanceId
      - ContactFlowModuleId
      - AliasId
    DescribeContactFlowModuleAliasResponse:
      type: object
      properties:
        ContactFlowModuleAlias:
          $ref: '#/components/schemas/ContactFlowModuleAliasInfo'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the limit.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateContactFlowAliasRequest:
      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.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        AliasId:
          type: string
          description: The identifier of the alias.
        Name:
          type: string
          description: The name of the alias.
        Description:
          type: string
          description: The description of the alias.
        ContactFlowVersion:
          type: integer
          description: The version of the flow.
      required:
      - InstanceId
      - ContactFlowId
      - AliasId
    UpdateContactFlowAliasResponse:
      type: object
      properties: {}
    UpdateContactFlowModuleAliasRequest:
      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.
        ContactFlowModuleId:
          type: string
          description: The identifier of the flow module.
        AliasId:
          type: string
          description: The identifier of the alias.
        Name:
          type: string
          description: The name of the alias.
        Description:
          type: string
          description: The description of the alias.
        ContactFlowModuleVersion:
          type: integer
          description: The version of the flow module.
      required:
      - InstanceId
      - ContactFlowModuleId
      - AliasId
    UpdateContactFlowModuleAliasResponse:
      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)