Amazon Connect Connect Overrides API

openapi: 3.1.0
info:
  title: Amazon Connect Service Overrides 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:
  /hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides:
    put:
      operationId: CreateHoursOfOperationOverride
      summary: Create Hours Of Operation Override
      description: Creates an hours of operation override in an Connect Customer hours of operation resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateHoursOfOperationOverrideResponse'
        '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/CreateHoursOfOperationOverrideRequest'
      tags:
      - Overrides
    get:
      operationId: ListHoursOfOperationOverrides
      summary: List Hours Of Operation Overrides
      description: List the hours of operation overrides.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListHoursOfOperationOverridesResponse'
        '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/ListHoursOfOperationOverridesRequest'
      tags:
      - Overrides
  /hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}:
    delete:
      operationId: DeleteHoursOfOperationOverride
      summary: Delete Hours Of Operation Override
      description: Deletes an hours of operation override in an Connect Customer hours of operation resource.
      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/DeleteHoursOfOperationOverrideRequest'
      tags:
      - Overrides
    get:
      operationId: DescribeHoursOfOperationOverride
      summary: Describe Hours Of Operation Override
      description: Describes the hours of operation override.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeHoursOfOperationOverrideResponse'
        '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/DescribeHoursOfOperationOverrideRequest'
      tags:
      - Overrides
    post:
      operationId: UpdateHoursOfOperationOverride
      summary: Update Hours Of Operation Override
      description: Update the hours of operation override.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/UpdateHoursOfOperationOverrideRequest'
      tags:
      - Overrides
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:
    ConditionalOperationFailedException:
      type: object
      properties:
        Message:
          type: string
    CreateHoursOfOperationOverrideRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance.
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation
        Name:
          type: string
          description: The name of the hours of operation override.
        Description:
          type: string
          description: The description of the hours of operation override.
        Config:
          type: array
          items:
            $ref: '#/components/schemas/HoursOfOperationOverrideConfig'
          description: 'Configuration information for the hours of operation override: day, start time, and end time.'
        EffectiveFrom:
          type: string
          description: The date from when the hours of operation override is effective.
        EffectiveTill:
          type: string
          description: The date until when the hours of operation override is effective.
        RecurrenceConfig:
          $ref: '#/components/schemas/RecurrenceConfig'
        OverrideType:
          type: string
          enum:
          - STANDARD
          - OPEN
          - CLOSED
          description: Whether the override will be defined as a standard or as a recurring event. For more information about
            how override types are applied, see Build your list of overrides in the Administrator Guide.
      required:
      - InstanceId
      - HoursOfOperationId
      - Name
      - Config
      - EffectiveFrom
      - EffectiveTill
    CreateHoursOfOperationOverrideResponse:
      type: object
      properties:
        HoursOfOperationOverrideId:
          type: string
          description: The identifier for the hours of operation override.
    DeleteHoursOfOperationOverrideRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance.
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        HoursOfOperationOverrideId:
          type: string
          description: The identifier for the hours of operation override.
      required:
      - InstanceId
      - HoursOfOperationId
      - HoursOfOperationOverrideId
    DescribeHoursOfOperationOverrideRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance.
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        HoursOfOperationOverrideId:
          type: string
          description: The identifier for the hours of operation override.
      required:
      - InstanceId
      - HoursOfOperationId
      - HoursOfOperationOverrideId
    DescribeHoursOfOperationOverrideResponse:
      type: object
      properties:
        HoursOfOperationOverride:
          $ref: '#/components/schemas/HoursOfOperationOverride'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    HoursOfOperationOverride:
      type: object
      properties:
        HoursOfOperationOverrideId:
          type: string
          description: The identifier for the hours of operation override.
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        HoursOfOperationArn:
          type: string
          description: The Amazon Resource Name (ARN) for the hours of operation.
        Name:
          type: string
          description: The name of the hours of operation override.
        Description:
          type: string
          description: The description of the hours of operation override.
        Config:
          type: array
          items:
            $ref: '#/components/schemas/HoursOfOperationOverrideConfig'
          description: 'Configuration information for the hours of operation override: day, start time, and end time.'
        EffectiveFrom:
          type: string
          description: The date from which the hours of operation override would be effective.
        EffectiveTill:
          type: string
          description: The date until the hours of operation override is effective.
        RecurrenceConfig:
          $ref: '#/components/schemas/RecurrenceConfig'
        OverrideType:
          type: string
          enum:
          - STANDARD
          - OPEN
          - CLOSED
          description: Whether the override will be defined as a standard or as a recurring event.
    HoursOfOperationOverrideConfig:
      type: object
      properties:
        Day:
          type: string
          enum:
          - SUNDAY
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          description: The day that the hours of operation override applies to.
        StartTime:
          $ref: '#/components/schemas/OverrideTimeSlice'
        EndTime:
          $ref: '#/components/schemas/OverrideTimeSlice'
    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.
    ListHoursOfOperationOverridesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance.
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        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
      - HoursOfOperationId
    ListHoursOfOperationOverridesResponse:
      type: object
      properties:
        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.
        HoursOfOperationOverrideList:
          type: array
          items:
            $ref: '#/components/schemas/HoursOfOperationOverride'
          description: Information about the hours of operation override.
        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.
    OverrideTimeSlice:
      type: object
      properties:
        Hours:
          type: integer
          description: The hours.
        Minutes:
          type: integer
          description: The minutes.
      required:
      - Hours
      - Minutes
    RecurrenceConfig:
      type: object
      properties:
        RecurrencePattern:
          $ref: '#/components/schemas/RecurrencePattern'
      required:
      - RecurrencePattern
    RecurrencePattern:
      type: object
      properties:
        Frequency:
          type: string
          enum:
          - WEEKLY
          - MONTHLY
          - YEARLY
          description: Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works
            in conjunction with the Interval field to determine the exact repetition sequence.
        Interval:
          type: integer
          description: 'Specifies the number of frequency units between each occurrence. Must be a positive integer. Examples:
            To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY
            frequency.'
        ByMonth:
          type: array
          items:
            type: integer
          description: 'Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY
            frequency to schedule events in specific month. Note: It does not accept multiple values in the same list'
        ByMonthDay:
          type: array
          items:
            type: integer
          description: 'Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency
            to schedule events on specific date within a month. Examples: [15] for events on the 15th of each month, [-1]
            for events on the last day of month. Note: It does not accept multiple values in the same list. If a specified
            day doesn''t exist in a particular month (e.g., day 31 in February), the event will be skipped for that month.
            This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches
            (specific dates vs. relative weekday positions).'
        ByWeekdayOccurrence:
          type: array
          items:
            type: integer
          description: 'Specifies which occurrence of a weekday within the month the event should occur on. Must be used with
            MONTHLY or YEARLY frequency. Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds
            to last occurrence of the weekday in the month The weekday itself is specified separately in the HoursOfOperationConfig.
            Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2],
            Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.'
      required:
      - Frequency
      - Interval
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateHoursOfOperationOverrideRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance.
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        HoursOfOperationOverrideId:
          type: string
          description: The identifier for the hours of operation override.
        Name:
          type: string
          description: The name of the hours of operation override.
        Description:
          type: string
          description: The description of the hours of operation override.
        Config:
          type: array
          items:
            $ref: '#/components/schemas/HoursOfOperationOverrideConfig'
          description: 'Configuration information for the hours of operation override: day, start time, and end time.'
        EffectiveFrom:
          type: string
          description: The date from when the hours of operation override would be effective.
        EffectiveTill:
          type: string
          description: The date until the hours of operation override is effective.
        RecurrenceConfig:
          $ref: '#/components/schemas/RecurrenceConfig'
        OverrideType:
          type: string
          enum:
          - STANDARD
          - OPEN
          - CLOSED
          description: Whether the override will be defined as a standard or as a recurring event. For more information about
            how override types are applied, see Build your list of overrides in the Administrator Guide.
      required:
      - InstanceId
      - HoursOfOperationId
      - HoursOfOperationOverrideId
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)