Amazon Connect Connect Content API

openapi: 3.1.0
info:
  title: Amazon Connect Service Content API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 3 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}/content:
    post:
      operationId: UpdateContactFlowContent
      summary: Update Contact Flow Content
      description: Updates the specified flow. You can also create and update flows using the Connect Customer Flow language.
        Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED.
        After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactFlowContentResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidContactFlowException; InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidContactFlowException'
        '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/UpdateContactFlowContentRequest'
      tags:
      - Content
  /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content:
    post:
      operationId: UpdateContactFlowModuleContent
      summary: Update Contact Flow Module Content
      description: Updates specified flow module for the specified Connect Customer instance. Use the $SAVED alias in the
        request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is
        published, $SAVED needs to be supplied to view saved content that has not been published.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactFlowModuleContentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidContactFlowModuleException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidContactFlowModuleException'
        '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/UpdateContactFlowModuleContentRequest'
      tags:
      - Content
  /metrics/definitions/{InstanceId}/{MetricId}/content:
    post:
      operationId: UpdateMetricContent
      summary: Update Metric Content
      description: Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer
        instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMetricContentResponse'
        '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/UpdateMetricContentRequest'
      tags:
      - Content
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
    CalculationComponent:
      type: object
      properties:
        Alias:
          type: string
          description: The alias used to reference this component in the calculation expression.
        MetricName:
          type: string
          description: The name of an AWS-managed metric used in this calculation component (for example, CONTACTS_HANDLED).
            Mutually exclusive with MetricId.
        MetricId:
          type: string
          description: The ARN of an AWS-managed metric used in this calculation component. Mutually exclusive with MetricName.
        MetricFilters:
          type: array
          items:
            $ref: '#/components/schemas/MetricFilter'
          description: The filters applied to the calculation component.
      required:
      - Alias
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidContactFlowException:
      type: object
      properties:
        problems:
          type: array
          items:
            $ref: '#/components/schemas/ProblemDetail'
          description: The problems with the flow. Please fix before trying again.
    InvalidContactFlowModuleException:
      type: object
      properties:
        Problems:
          type: array
          items:
            $ref: '#/components/schemas/ProblemDetail'
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    MetricCalculation:
      type: object
      properties:
        CalculationComponents:
          type: array
          items:
            $ref: '#/components/schemas/CalculationComponent'
          description: The list of component metrics referenced in the calculation formula. Each component has an alias used
            in the formula expression.
        Calculation:
          type: string
          description: The formula expression that defines how the metric is calculated. Uses component aliases (for example,
            100 * SUM(M1) / SUM(M2)).
      required:
      - CalculationComponents
      - Calculation
    MetricFilter:
      type: object
      properties:
        MetricFilterKey:
          type: string
          description: The key identifying the field to filter on.
        Negate:
          type: boolean
          description: Specifies whether the filter condition is negated. When set to true, the filter excludes matching data
            instead of including it.
        NumberCondition:
          $ref: '#/components/schemas/MetricFilterNumberCondition'
        StringCondition:
          $ref: '#/components/schemas/MetricFilterStringCondition'
        BooleanCondition:
          $ref: '#/components/schemas/MetricFilterBooleanCondition'
      required:
      - MetricFilterKey
    MetricFilterBooleanCondition:
      type: object
      properties:
        Comparison:
          type: string
          enum:
          - IS_TRUE
          - IS_FALSE
          description: 'The comparison operator. Valid values: IS_TRUE (matches when the field is true) | IS_FALSE (matches
            when the field is false).'
      required:
      - Comparison
    MetricFilterNumberCondition:
      type: object
      properties:
        Comparison:
          type: string
          enum:
          - LESSER
          - LESSER_OR_EQUAL
          - GREATER
          - GREATER_OR_EQUAL
          description: 'The comparison operator. Valid values: LESSER (less than) | LESSER_OR_EQUAL (less than or equal to)
            | GREATER (greater than) | GREATER_OR_EQUAL (greater than or equal to).'
        Values:
          type: array
          items:
            type: number
          description: The numeric values to compare against.
      required:
      - Comparison
      - Values
    MetricFilterStringCondition:
      type: object
      properties:
        Comparison:
          type: string
          enum:
          - MATCHES_ANY
          - MATCHES_NONE
          description: 'The comparison operator. Valid values: MATCHES_ANY (matches any of the specified values) | MATCHES_NONE
            (matches none of the specified values).'
        Values:
          type: array
          items:
            type: string
          description: The string values to compare against.
      required:
      - Comparison
      - Values
    ProblemDetail:
      type: object
      properties:
        message:
          type: string
          description: The problem detail's message.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateContactFlowContentRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
        Content:
          type: string
          description: 'The JSON string that represents the content of the flow. For an example, see Example flow in Connect
            Customer Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000.'
      required:
      - InstanceId
      - ContactFlowId
      - Content
    UpdateContactFlowContentResponse:
      type: object
      properties: {}
    UpdateContactFlowModuleContentRequest:
      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.
        Content:
          type: string
          description: The JSON string that represents the content of the flow. For an example, see Example flow in Connect
            Customer Flow language.
        Settings:
          type: string
          description: Serialized JSON string of the flow module Settings schema.
      required:
      - InstanceId
      - ContactFlowModuleId
    UpdateContactFlowModuleContentResponse:
      type: object
      properties: {}
    UpdateMetricContentRequest:
      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.
        MetricId:
          type: string
          description: The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of
            the metric. Adding $LATEST or omitting a qualifier will update the published version.
        MetricCalculation:
          $ref: '#/components/schemas/MetricCalculation'
        Unit:
          type: string
          enum:
          - INTEGER
          - DOUBLE
          - PERCENT
          - SECONDS
          description: The updated display unit for the metric.
        PositiveTrendIndicator:
          type: string
          enum:
          - POSITIVE
          - NEGATIVE
          - NEUTRAL
          description: 'How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.'
      required:
      - InstanceId
      - MetricId
    UpdateMetricContentResponse:
      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)