Amazon Connect Connect Traffic Distribution Group API

openapi: 3.1.0
info:
  title: Amazon Connect Service Traffic Distribution Group API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 4 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:
  /traffic-distribution-group:
    put:
      operationId: CreateTrafficDistributionGroup
      summary: Create Traffic Distribution Group
      description: Creates a traffic distribution group given an Connect Customer instance that has been replicated. The SignInConfig
        distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup
        data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,
        an InvalidRequestException is returned. For more information about creating traffic distribution groups, see Set up
        traffic distribution groups in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTrafficDistributionGroupResponse'
        '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; ResourceNotReadyException
          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/CreateTrafficDistributionGroupRequest'
      tags:
      - Traffic Distribution Group
  /traffic-distribution-group/{TrafficDistributionGroupId}:
    delete:
      operationId: DeleteTrafficDistributionGroup
      summary: Delete Traffic Distribution Group
      description: Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution
        group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution
        groups in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTrafficDistributionGroupResponse'
        '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: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTrafficDistributionGroupRequest'
      tags:
      - Traffic Distribution Group
    get:
      operationId: DescribeTrafficDistributionGroup
      summary: Describe Traffic Distribution Group
      description: Gets details and status of a traffic distribution group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeTrafficDistributionGroupResponse'
        '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/DescribeTrafficDistributionGroupRequest'
      tags:
      - Traffic Distribution Group
  /traffic-distribution-groups:
    get:
      operationId: ListTrafficDistributionGroups
      summary: List Traffic Distribution Groups
      description: Lists traffic distribution groups.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTrafficDistributionGroupsResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTrafficDistributionGroupsRequest'
      tags:
      - Traffic Distribution Group
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
    CreateTrafficDistributionGroupRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name for the traffic distribution group.
        Description:
          type: string
          description: A description for the traffic distribution group.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance that has been replicated. You can find the instanceId
            in the ARN of the instance.
        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.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
      required:
      - Name
      - InstanceId
    CreateTrafficDistributionGroupResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution
            group.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the traffic distribution group.
    DeleteTrafficDistributionGroupRequest:
      type: object
      properties:
        TrafficDistributionGroupId:
          type: string
          description: The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution
            group.
      required:
      - TrafficDistributionGroupId
    DeleteTrafficDistributionGroupResponse:
      type: object
      properties: {}
    DescribeTrafficDistributionGroupRequest:
      type: object
      properties:
        TrafficDistributionGroupId:
          type: string
          description: The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being
            called in the Region where the traffic distribution group was created. The ARN must be provided if the call is
            from the replicated Region.
      required:
      - TrafficDistributionGroupId
    DescribeTrafficDistributionGroupResponse:
      type: object
      properties:
        TrafficDistributionGroup:
          $ref: '#/components/schemas/TrafficDistributionGroup'
    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.
    ListTrafficDistributionGroupsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
        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.
        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.
    ListTrafficDistributionGroupsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        TrafficDistributionGroupSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/TrafficDistributionGroupSummary'
          description: A list of traffic distribution groups.
    ResourceConflictException:
      type: object
      properties:
        Message:
          type: string
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - CONTACT
          - CONTACT_FLOW
          - INSTANCE
          - PARTICIPANT
          - HIERARCHY_LEVEL
          - HIERARCHY_GROUP
          - USER
          - PHONE_NUMBER
          description: The type of resource.
        ResourceId:
          type: string
          description: The identifier for the resource.
    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
    TrafficDistributionGroup:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being
            called in the Region where the traffic distribution group was created. The ARN must be provided if the call is
            from the replicated Region.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the traffic distribution group.
        Name:
          type: string
          description: The name of the traffic distribution group.
        Description:
          type: string
          description: The description of the traffic distribution group.
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN).
        Status:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - ACTIVE
          - CREATION_FAILED
          - PENDING_DELETION
          - DELETION_FAILED
          - UPDATE_IN_PROGRESS
          description: The status of the traffic distribution group. CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup
            operation is still in progress and has not yet completed. ACTIVE means the previous CreateTrafficDistributionGroup
            operation has succeeded. CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation
            has failed. PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress
            and has not yet completed. DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
            UPDATE_IN_PROGRESS means the prev
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        IsDefault:
          type: boolean
          description: Whether this is the default traffic distribution group created during instance replication. The default
            traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution
            group is deleted as part of the process for deleting a replica. The SignInConfig distribution is available only
            on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type).
            If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,
            an InvalidRequestException is returned.
    TrafficDistributionGroupSummary:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being
            called in the Region where the traffic distribution group was created. The ARN must be provided if the call is
            from the replicated Region.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the traffic distribution group.
        Name:
          type: string
          description: The name of the traffic distribution group.
        InstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the instance.
        Status:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - ACTIVE
          - CREATION_FAILED
          - PENDING_DELETION
          - DELETION_FAILED
          - UPDATE_IN_PROGRESS
          description: The status of the traffic distribution group. CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup
            operation is still in progress and has not yet completed. ACTIVE means the previous CreateTrafficDistributionGroup
            operation has succeeded. CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation
            has failed. PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress
            and has not yet completed. DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
            UPDATE_IN_PROGRESS means the prev
        IsDefault:
          type: boolean
          description: Whether this is the default traffic distribution group created during instance replication. The default
            traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution
            group is deleted as part of the process for deleting a replica.
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)