Amazon CloudWatch Cloudwatch Problem API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Problem API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 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://applicationinsights.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DescribeProblem:
    post:
      operationId: DescribeProblem
      summary: Describe Problem
      description: Describes an application problem.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeProblemResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - EC2WindowsBarleyService.DescribeProblem
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeProblemRequest'
      tags:
      - Problem
  /#ListProblems:
    post:
      operationId: ListProblems
      summary: List Problems
      description: Lists the problems with your application.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListProblemsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - EC2WindowsBarleyService.ListProblems
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListProblemsRequest'
      tags:
      - Problem
  /#UpdateProblem:
    post:
      operationId: UpdateProblem
      summary: Update Problem
      description: Updates the visibility of the problem or specifies the problem as RESOLVED.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateProblemResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - EC2WindowsBarleyService.UpdateProblem
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateProblemRequest'
      tags:
      - Problem
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: applicationinsights
  schemas:
    ApplicationinsightsInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsValidationException:
      type: object
      properties:
        Message:
          type: string
    DescribeProblemRequest:
      type: object
      properties:
        ProblemId:
          type: string
          description: The ID of the problem.
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the owner of the resource group affected by the problem.
      required:
      - ProblemId
    DescribeProblemResponse:
      type: object
      properties:
        Problem:
          $ref: '#/components/schemas/Problem'
        SNSNotificationArn:
          type: string
          description: The SNS notification topic ARN of the problem.
    ListProblemsRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the resource group owner.
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        StartTime:
          type: string
          format: date-time
          description: The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the
            request, problems within the past seven days are returned.
        EndTime:
          type: string
          format: date-time
          description: The time when the problem ended, in epoch seconds. If not specified, problems within the past seven
            days are returned.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. To retrieve the remaining results, make another
            call with the returned NextToken value.
        NextToken:
          type: string
          description: The token to request the next page of results.
        ComponentName:
          type: string
          description: The name of the component.
        Visibility:
          type: string
          enum:
          - IGNORED
          - VISIBLE
          description: Specifies whether or not you can view the problem. If not specified, visible and ignored problems are
            returned.
    ListProblemsResponse:
      type: object
      properties:
        ProblemList:
          type: array
          items:
            $ref: '#/components/schemas/Problem'
          description: The list of problems.
        NextToken:
          type: string
          description: The token used to retrieve the next page of results. This value is null when there are no more results
            to return.
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the resource group owner.
    Problem:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the problem.
        Title:
          type: string
          description: The name of the problem.
        ShortName:
          type: string
          description: The short name of the problem associated with the SNS notification.
        Insights:
          type: string
          description: A detailed analysis of the problem using machine learning.
        Status:
          type: string
          enum:
          - IGNORE
          - RESOLVED
          - PENDING
          - RECURRING
          - RECOVERING
          description: The status of the problem.
        AffectedResource:
          type: string
          description: The resource affected by the problem.
        StartTime:
          type: string
          format: date-time
          description: The time when the problem started, in epoch seconds.
        EndTime:
          type: string
          format: date-time
          description: The time when the problem ended, in epoch seconds.
        SeverityLevel:
          type: string
          enum:
          - Informative
          - Low
          - Medium
          - High
          description: A measure of the level of impact of the problem.
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the owner of the resource group affected by the problem.
        ResourceGroupName:
          type: string
          description: The name of the resource group affected by the problem.
        Feedback:
          type: object
          additionalProperties:
            type: string
            enum:
            - NOT_SPECIFIED
            - USEFUL
            - NOT_USEFUL
          description: Feedback provided by the user about the problem.
        RecurringCount:
          type: integer
          description: The number of times that the same problem reoccurred after the first time it was resolved.
        LastRecurrenceTime:
          type: string
          format: date-time
          description: The last time that the problem reoccurred after its last resolution.
        Visibility:
          type: string
          enum:
          - IGNORED
          - VISIBLE
          description: Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.
        ResolutionMethod:
          type: string
          enum:
          - MANUAL
          - AUTOMATIC
          - UNRESOLVED
          description: Specifies how the problem was resolved. If the value is AUTOMATIC, the system resolved the problem.
            If the value is MANUAL, the user resolved the problem. If the value is UNRESOLVED, then the problem is not resolved.
    UpdateProblemRequest:
      type: object
      properties:
        ProblemId:
          type: string
          description: The ID of the problem.
        UpdateStatus:
          type: string
          enum:
          - RESOLVED
          description: The status of the problem. Arguments can be passed for only problems that show a status of RECOVERING.
        Visibility:
          type: string
          enum:
          - IGNORED
          - VISIBLE
          description: The visibility of a problem. When you pass a value of IGNORED, the problem is removed from the default
            view, and all notifications for the problem are suspended. When VISIBLE is passed, the IGNORED action is reversed.
      required:
      - ProblemId
    UpdateProblemResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/application-insights/service/2018-11-25/application-insights-2018-11-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)