find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-cloudwatch:amazon-cloudwatch-workload-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon CloudWatch Workload 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:
  /#AddWorkload:
    post:
      operationId: AddWorkload
      summary: Add Workload
      description: Adds a workload to a component. Each component can have at most five workloads.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AddWorkloadResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ApplicationinsightsInternalServerException'
        '400':
          description: ResourceInUseException; 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.AddWorkload
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AddWorkloadRequest'
      tags:
      - Workload
  /#DescribeWorkload:
    post:
      operationId: DescribeWorkload
      summary: Describe Workload
      description: Describes a workload and its configuration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeWorkloadResponse'
        '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.DescribeWorkload
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeWorkloadRequest'
      tags:
      - Workload
  /#ListWorkloads:
    post:
      operationId: ListWorkloads
      summary: List Workloads
      description: Lists the workloads that are configured on a given component.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListWorkloadsResponse'
        '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.ListWorkloads
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListWorkloadsRequest'
      tags:
      - Workload
  /#RemoveWorkload:
    post:
      operationId: RemoveWorkload
      summary: Remove Workload
      description: Remove workload from a component.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RemoveWorkloadResponse'
        '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.RemoveWorkload
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/RemoveWorkloadRequest'
      tags:
      - Workload
  /#UpdateWorkload:
    post:
      operationId: UpdateWorkload
      summary: Update Workload
      description: Adds a workload to a component. Each component can have at most five workloads.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateWorkloadResponse'
        '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.UpdateWorkload
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateWorkloadRequest'
      tags:
      - Workload
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:
    AddWorkloadRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        ComponentName:
          type: string
          description: The name of the component.
        WorkloadConfiguration:
          $ref: '#/components/schemas/WorkloadConfiguration'
      required:
      - ResourceGroupName
      - ComponentName
      - WorkloadConfiguration
    AddWorkloadResponse:
      type: object
      properties:
        WorkloadId:
          type: string
          description: The ID of the workload.
        WorkloadConfiguration:
          $ref: '#/components/schemas/WorkloadConfiguration'
    ApplicationinsightsInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ApplicationinsightsValidationException:
      type: object
      properties:
        Message:
          type: string
    DescribeWorkloadRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        ComponentName:
          type: string
          description: The name of the component.
        WorkloadId:
          type: string
          description: The ID of the workload.
        AccountId:
          type: string
          description: The Amazon Web Services account ID for the workload owner.
      required:
      - ResourceGroupName
      - ComponentName
      - WorkloadId
    DescribeWorkloadResponse:
      type: object
      properties:
        WorkloadId:
          type: string
          description: The ID of the workload.
        WorkloadRemarks:
          type: string
          description: If logging is supported for the resource type, shows whether the component has configured logs to be
            monitored.
        WorkloadConfiguration:
          $ref: '#/components/schemas/WorkloadConfiguration'
    ListWorkloadsRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        ComponentName:
          type: string
          description: The name of the component.
        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 of the owner of the workload.
      required:
      - ResourceGroupName
      - ComponentName
    ListWorkloadsResponse:
      type: object
      properties:
        WorkloadList:
          type: array
          items:
            $ref: '#/components/schemas/Workload'
          description: The list of workloads.
        NextToken:
          type: string
          description: The token to request the next page of results.
    RemoveWorkloadRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        ComponentName:
          type: string
          description: The name of the component.
        WorkloadId:
          type: string
          description: The ID of the workload.
      required:
      - ResourceGroupName
      - ComponentName
      - WorkloadId
    RemoveWorkloadResponse:
      type: object
      properties: {}
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
    UpdateWorkloadRequest:
      type: object
      properties:
        ResourceGroupName:
          type: string
          description: The name of the resource group.
        ComponentName:
          type: string
          description: The name of the component.
        WorkloadId:
          type: string
          description: The ID of the workload.
        WorkloadConfiguration:
          $ref: '#/components/schemas/WorkloadConfiguration'
      required:
      - ResourceGroupName
      - ComponentName
      - WorkloadConfiguration
    UpdateWorkloadResponse:
      type: object
      properties:
        WorkloadId:
          type: string
          description: The ID of the workload.
        WorkloadConfiguration:
          $ref: '#/components/schemas/WorkloadConfiguration'
    Workload:
      type: object
      properties:
        WorkloadId:
          type: string
          description: The ID of the workload.
        ComponentName:
          type: string
          description: The name of the component.
        WorkloadName:
          type: string
          description: The name of the workload.
        Tier:
          type: string
          enum:
          - CUSTOM
          - DEFAULT
          - DOT_NET_CORE
          - DOT_NET_WORKER
          - DOT_NET_WEB_TIER
          - DOT_NET_WEB
          - SQL_SERVER
          - SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP
          - MYSQL
          - POSTGRESQL
          - JAVA_JMX
          - ORACLE
          - SAP_HANA_MULTI_NODE
          - SAP_HANA_SINGLE_NODE
          - SAP_HANA_HIGH_AVAILABILITY
          - SAP_ASE_SINGLE_NODE
          - SAP_ASE_HIGH_AVAILABILITY
          - SQL_SERVER_FAILOVER_CLUSTER_INSTANCE
          - SHAREPOINT
          - ACTIVE_DIRECTORY
          - SAP_NETWEAVER_STANDARD
          - SAP_NETWEAVER_DISTRIBUTED
          - SAP_NETWEAVER_HIGH_AVAILABILITY
          description: The tier of the workload.
        WorkloadRemarks:
          type: string
          description: If logging is supported for the resource type, shows whether the component has configured logs to be
            monitored.
        MissingWorkloadConfig:
          type: boolean
          description: Indicates whether all of the component configurations required to monitor a workload were provided.
    WorkloadConfiguration:
      type: object
      properties:
        WorkloadName:
          type: string
          description: The name of the workload.
        Tier:
          type: string
          enum:
          - CUSTOM
          - DEFAULT
          - DOT_NET_CORE
          - DOT_NET_WORKER
          - DOT_NET_WEB_TIER
          - DOT_NET_WEB
          - SQL_SERVER
          - SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP
          - MYSQL
          - POSTGRESQL
          - JAVA_JMX
          - ORACLE
          - SAP_HANA_MULTI_NODE
          - SAP_HANA_SINGLE_NODE
          - SAP_HANA_HIGH_AVAILABILITY
          - SAP_ASE_SINGLE_NODE
          - SAP_ASE_HIGH_AVAILABILITY
          - SQL_SERVER_FAILOVER_CLUSTER_INSTANCE
          - SHAREPOINT
          - ACTIVE_DIRECTORY
          - SAP_NETWEAVER_STANDARD
          - SAP_NETWEAVER_DISTRIBUTED
          - SAP_NETWEAVER_HIGH_AVAILABILITY
          description: The configuration of the workload tier.
        Configuration:
          type: string
          description: The configuration settings of the workload.
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)