Amazon CloudWatch Cloudwatch Application API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Application API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 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://applicationinsights.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateApplication:
    post:
      operationId: CreateApplication
      summary: Create Application
      description: Adds an application that is created from a resource group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateApplicationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsInternalServerException'
        '400':
          description: ResourceInUseException; TagsAlreadyExistException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - EC2WindowsBarleyService.CreateApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
      tags:
      - Application
  /#DeleteApplication:
    post:
      operationId: DeleteApplication
      summary: Delete Application
      description: Removes the specified application from monitoring. Does not delete the application.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteApplicationResponse'
        '400':
          description: BadRequestException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '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'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - EC2WindowsBarleyService.DeleteApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteApplicationRequest'
      tags:
      - Application
  /#DescribeApplication:
    post:
      operationId: DescribeApplication
      summary: Describe Application
      description: Describes the application.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeApplicationResponse'
        '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.DescribeApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeApplicationRequest'
      tags:
      - Application
  /#ListApplications:
    post:
      operationId: ListApplications
      summary: List Applications
      description: Lists the IDs of the applications that you are monitoring.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListApplicationsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsInternalServerException'
        '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.ListApplications
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListApplicationsRequest'
      tags:
      - Application
  /#UpdateApplication:
    post:
      operationId: UpdateApplication
      summary: Update Application
      description: Updates the application.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateApplicationResponse'
        '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.UpdateApplication
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateApplicationRequest'
      tags:
      - Application
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:
    ApplicationInfo:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the owner of the application.
        ResourceGroupName:
          type: string
          description: The name of the resource group used for the application.
        LifeCycle:
          type: string
          description: The lifecycle of the application.
        OpsItemSNSTopicArn:
          type: string
          description: The SNS topic provided to Application Insights that is associated to the created opsItems to receive
            SNS notifications for opsItem updates.
        SNSNotificationArn:
          type: string
          description: The SNS topic ARN that is associated with SNS notifications for updates or issues.
        OpsCenterEnabled:
          type: boolean
          description: Indicates whether Application Insights will create opsItems for any problem detected by Application
            Insights for an application.
        CWEMonitorEnabled:
          type: boolean
          description: Indicates whether Application Insights can listen to CloudWatch events for the application resources,
            such as instance terminated, failed deployment, and others.
        Remarks:
          type: string
          description: 'The issues on the user side that block Application Insights from successfully monitoring an application.
            Example remarks include: “Configuring application, detected 1 Errors, 3 Warnings” “Configuring application, detected
            1 Unconfigured Components”'
        AutoConfigEnabled:
          type: boolean
          description: Indicates whether auto-configuration is turned on for this application.
        DiscoveryType:
          type: string
          enum:
          - RESOURCE_GROUP_BASED
          - ACCOUNT_BASED
          description: The method used by Application Insights to onboard your resources.
        AttachMissingPermission:
          type: boolean
          description: If set to true, the managed policies for SSM and CW will be attached to the instance roles if they
            are missing.
    ApplicationinsightsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsTag:
      type: object
      properties:
        Key:
          type: string
          description: One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters.
            The minimum length is 1 character.
        Value:
          type: string
          description: The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256
            characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value,
            don't specify a value for this parameter.
      required:
      - Key
      - Value
    ApplicationinsightsValidationException:
      type: object
      properties:
        Message:
          type: string
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    CreateApplicationRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        OpsCenterEnabled:
          type: boolean
          description: When set to true, creates opsItems for any problems detected on an application.
        CWEMonitorEnabled:
          type: boolean
          description: Indicates whether Application Insights can listen to CloudWatch events for the application resources,
            such as instance terminated, failed deployment, and others.
        OpsItemSNSTopicArn:
          type: string
          description: The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you
            to receive notifications for updates to the opsItem.
        SNSNotificationArn:
          type: string
          description: The SNS notification topic ARN.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationinsightsTag'
          description: List of tags to add to the application. tag key (Key) and an associated tag value (Value). The maximum
            length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
        AutoConfigEnabled:
          type: boolean
          description: Indicates whether Application Insights automatically configures unmonitored resources in the resource
            group.
        AutoCreate:
          type: boolean
          description: Configures all of the resources in the resource group by applying the recommended configurations.
        GroupingType:
          type: string
          enum:
          - ACCOUNT_BASED
          description: Application Insights can create applications based on a resource group or on an account. To create
            an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.
        AttachMissingPermission:
          type: boolean
          description: If set to true, the managed policies for SSM and CW will be attached to the instance roles if they
            are missing.
    CreateApplicationResponse:
      type: object
      properties:
        ApplicationInfo:
          $ref: '#/components/schemas/ApplicationInfo'
    DeleteApplicationRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
      required:
      - ResourceGroupName
    DeleteApplicationResponse:
      type: object
      properties: {}
    DescribeApplicationRequest:
      type: object
      properties:
        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.
      required:
      - ResourceGroupName
    DescribeApplicationResponse:
      type: object
      properties:
        ApplicationInfo:
          $ref: '#/components/schemas/ApplicationInfo'
    ListApplicationsRequest:
      type: object
      properties:
        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.
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the resource group owner.
    ListApplicationsResponse:
      type: object
      properties:
        ApplicationInfoList:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationInfo'
          description: The list of applications.
        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.
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
    UpdateApplicationRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        OpsCenterEnabled:
          type: boolean
          description: When set to true, creates opsItems for any problems detected on an application.
        CWEMonitorEnabled:
          type: boolean
          description: Indicates whether Application Insights can listen to CloudWatch events for the application resources,
            such as instance terminated, failed deployment, and others.
        OpsItemSNSTopicArn:
          type: string
          description: The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you
            to receive notifications for updates to the opsItem.
        SNSNotificationArn:
          type: string
          description: The SNS topic ARN. Allows you to receive SNS notifications for updates and issues with an application.
        RemoveSNSTopic:
          type: boolean
          description: Disassociates the SNS topic from the opsItem created for detected problems.
        AutoConfigEnabled:
          type: boolean
          description: Turns auto-configuration on or off.
        AttachMissingPermission:
          type: boolean
          description: If set to true, the managed policies for SSM and CW will be attached to the instance roles if they
            are missing.
      required:
      - ResourceGroupName
    UpdateApplicationResponse:
      type: object
      properties:
        ApplicationInfo:
          $ref: '#/components/schemas/ApplicationInfo'
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)