Amazon Connect Connect Predefined Attributes API

openapi: 3.1.0
info:
  title: Amazon Connect Service Predefined Attributes 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:
  /predefined-attributes/{InstanceId}:
    put:
      operationId: CreatePredefinedAttribute
      summary: Create Predefined Attribute
      description: 'Creates a new predefined attribute for the specified Connect Customer instance. A predefined attribute
        is made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas. Use
        cases Following are common uses cases for this API: Create an attribute for routing proficiency (for example, agent
        certification) that has predefined values (for example, a list of possible certifications). For more information,
        see Create predefined attributes for routing contacts to agents. Create an attribute for business unit name that has
        a list of predefined business unit names used in your organization. This is a use case where information for a contact
        varies between transfers or conferences. For more information, see Use contact segment attributes. Endpoints: See
        Connect Customer endpoints and quotas.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/CreatePredefinedAttributeRequest'
      tags:
      - Predefined Attributes
    get:
      operationId: ListPredefinedAttributes
      summary: List Predefined Attributes
      description: 'Lists predefined attributes for the specified Connect Customer instance. A predefined attribute is made
        up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification)
        that has predefined values (for example, a list of possible certifications). For more information, see Create predefined
        attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such
        as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For
        the predefined attributes per instance quota, see Connect Customer quotas. Endpoints: See Connect Customer endpoints
        and quotas.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPredefinedAttributesResponse'
        '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/ListPredefinedAttributesRequest'
      tags:
      - Predefined Attributes
  /predefined-attributes/{InstanceId}/{Name}:
    delete:
      operationId: DeletePredefinedAttribute
      summary: Delete Predefined Attribute
      description: Deletes a predefined attribute from the specified Connect Customer instance.
      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'
        '409':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '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/DeletePredefinedAttributeRequest'
      tags:
      - Predefined Attributes
    get:
      operationId: DescribePredefinedAttribute
      summary: Describe Predefined Attribute
      description: 'Describes a predefined attribute for the specified Connect Customer instance. A predefined attribute is
        made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification)
        that has predefined values (for example, a list of possible certifications). For more information, see Create predefined
        attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such
        as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For
        the predefined attributes per instance quota, see Connect Customer quotas. Endpoints: See Connect Customer endpoints
        and quotas.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribePredefinedAttributeResponse'
        '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/DescribePredefinedAttributeRequest'
      tags:
      - Predefined Attributes
    post:
      operationId: UpdatePredefinedAttribute
      summary: Update Predefined Attribute
      description: 'Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is
        made up of a name and a value. For the predefined attributes per instance quota, see Connect Customer quotas. Use
        cases Following are common uses cases for this API: Update routing proficiency (for example, agent certification)
        that has predefined values (for example, a list of possible certifications). For more information, see Create predefined
        attributes for routing contacts to agents. Update an attribute for business unit name that has a list of predefined
        business unit names used in your organization. This is a use case where information for a contact varies between transfers
        or conferences. For more information, see Use contact segment attributes. Endpoints: See Connect Customer endpoints
        and quotas.'
      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/UpdatePredefinedAttributeRequest'
      tags:
      - Predefined Attributes
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:
    CreatePredefinedAttributeRequest:
      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.
        Name:
          type: string
          description: The name of the predefined attribute.
        Values:
          $ref: '#/components/schemas/PredefinedAttributeValues'
        Purposes:
          type: array
          items:
            type: string
          description: Values that enable you to categorize your predefined attributes. You can use them in custom UI elements
            across the Connect Customer admin website.
        AttributeConfiguration:
          $ref: '#/components/schemas/InputPredefinedAttributeConfiguration'
      required:
      - InstanceId
      - Name
    DeletePredefinedAttributeRequest:
      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.
        Name:
          type: string
          description: The name of the predefined attribute.
      required:
      - InstanceId
      - Name
    DescribePredefinedAttributeRequest:
      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.
        Name:
          type: string
          description: The name of the predefined attribute.
      required:
      - InstanceId
      - Name
    DescribePredefinedAttributeResponse:
      type: object
      properties:
        PredefinedAttribute:
          $ref: '#/components/schemas/PredefinedAttribute'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    InputPredefinedAttributeConfiguration:
      type: object
      properties:
        EnableValueValidationOnAssociation:
          type: boolean
          description: When this parameter is set to true, Connect Customer enforces strict validation on the specific values,
            if the values are predefined in attributes. The contact will store only valid and predefined values for the predefined
            attribute key.
    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.
    ListPredefinedAttributesRequest:
      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.
        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
    ListPredefinedAttributesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        PredefinedAttributeSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/PredefinedAttributeSummary'
          description: Summary of the predefined attributes.
    PredefinedAttribute:
      type: object
      properties:
        Name:
          type: string
          description: The name of the predefined attribute.
        Values:
          $ref: '#/components/schemas/PredefinedAttributeValues'
        Purposes:
          type: array
          items:
            type: string
          description: Values that enable you to categorize your predefined attributes. You can use them in custom UI elements
            across the Connect Customer admin website.
        AttributeConfiguration:
          $ref: '#/components/schemas/PredefinedAttributeConfiguration'
        LastModifiedTime:
          type: string
          format: date-time
          description: Last modified time.
        LastModifiedRegion:
          type: string
          description: Last modified region.
    PredefinedAttributeConfiguration:
      type: object
      properties:
        EnableValueValidationOnAssociation:
          type: boolean
          description: When this parameter is set to true, Connect Customer enforces strict validation on the specific values,
            if the values are predefined in attributes. The contact will store only valid and predefined values for teh predefined
            attribute key.
        IsReadOnly:
          type: boolean
          description: A boolean flag used to indicate whether a predefined attribute should be displayed in the Connect Customer
            admin website.
    PredefinedAttributeSummary:
      type: object
      properties:
        Name:
          type: string
          description: The name of the predefined attribute.
        LastModifiedTime:
          type: string
          format: date-time
          description: Last modified time.
        LastModifiedRegion:
          type: string
          description: Last modified region.
    PredefinedAttributeValues:
      type: object
      properties:
        StringList:
          type: array
          items:
            type: string
          description: Predefined attribute values of type string list.
      description: Exactly one member is set.
    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.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdatePredefinedAttributeRequest:
      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.
        Name:
          type: string
          description: The name of the predefined attribute.
        Values:
          $ref: '#/components/schemas/PredefinedAttributeValues'
        Purposes:
          type: array
          items:
            type: string
          description: Values that enable you to categorize your predefined attributes. You can use them in custom UI elements
            across the Connect Customer admin website.
        AttributeConfiguration:
          $ref: '#/components/schemas/InputPredefinedAttributeConfiguration'
      required:
      - InstanceId
      - Name
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)