Amazon Health Dashboard Health Dashboard Operations API

The Health Dashboard Operations API from Amazon Health Dashboard — 2 operation(s) for health dashboard operations.

Operations 2

POST /#DescribeEntityAggregatesForOrganization Describe Entity Aggregates For Organization #
POST /#DescribeServiceLifecycle Describe Service Lifecycle #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-health-dashboard:amazon-health-dashboard-operations-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.

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

OpenAPI Specification

amazon-health-dashboard-operations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AWS Health APIs and Notifications Operations API
  version: '2016-08-04'
  description: Generated from AWS's published Smithy model for AWS Health APIs and Notifications. 2 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://health.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#DescribeEntityAggregatesForOrganization:
    post:
      operationId: DescribeEntityAggregatesForOrganization
      summary: Describe Entity Aggregates For Organization
      description: Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEntityAggregatesForOrganizationResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHealth_20160804.DescribeEntityAggregatesForOrganization
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEntityAggregatesForOrganizationRequest'
      tags:
      - Operations
  /#DescribeServiceLifecycle:
    post:
      operationId: DescribeServiceLifecycle
      summary: Describe Service Lifecycle
      description: Returns lifecycle information for Amazon Web Services services, including end-of-life dates, version recommendations, and lifecycle events.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeServiceLifecycleResponse'
              example:
                serviceLifecycles:
                - service: BEDROCK
                  version: ai21.jamba-1-5-large-v1:0
                  title: AI21 Labs Jamba 1.5 Large
                  lifecycleEvents:
                  - lifecycleEventType: STANDARD_SUPPORT_END
                    date: '2026-05-26T00:00:00Z'
                    regions:
                    - all
                    impactRisks:
                    - END_OF_SUPPORT
                    description: Model enters Legacy state — no longer actively maintained. Public extended access (pricing may increase) starts 2026-08-26
                  - lifecycleEventType: EXTENDED_SUPPORT_END
                    date: '2026-11-26T00:00:00Z'
                    regions:
                    - all
                    impactRisks:
                    - AVAILABILITY
                    description: Model is no longer available for inference
                - service: BEDROCK
                  version: amazon.nova-2-lite-v1:0
                  title: Amazon Nova 2 Lite
                  lifecycleEvents:
                  - lifecycleEventType: SUPPORTED
                    date: '2025-12-02T00:00:00Z'
                    regions:
                    - all
                    impactRisks: []
                    description: Amazon Nova 2 Lite available on Amazon Bedrock
                nextToken: AQICAHjDhCYeYPq-zXMzcdNOIWJQKCUN1s1J84fdK4ztGn9uoAExampleTokenExampleTokenExampleToken
        '400':
          description: InvalidPaginationToken
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidPaginationToken'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHealth_20160804.DescribeServiceLifecycle
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeServiceLifecycleRequest'
            example:
              maxResults: 5
      tags:
      - Operations
components:
  schemas:
    OrganizationEntityAggregate:
      type: object
      properties:
        eventArn:
          type: string
          description: 'A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"'
        count:
          type: integer
          description: The number of entities for the organization that match the filter criteria for the specified events.
        statuses:
          type: object
          additionalProperties:
            type: integer
          description: The number of affected entities aggregated by the entitiy status codes.
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountEntityAggregate'
          description: A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event. If there are no awsAccountIds provided in the request, this field will be empty in the response.
    AccountEntityAggregate:
      type: object
      properties:
        accountId:
          type: string
          description: The 12-digit Amazon Web Services account numbers that contains the affected entities.
        count:
          type: integer
          description: The number of entities that match the filter criteria for the specified events.
        statuses:
          type: object
          additionalProperties:
            type: integer
          description: The number of affected entities aggregated by the entity status codes.
    ServiceLifecycleFilter:
      type: object
      properties:
        service:
          type: string
          description: The Amazon Web Services service name to filter by.
    InvalidPaginationToken:
      type: object
      properties:
        message:
          type: string
    LifecycleEvent:
      type: object
      properties:
        lifecycleEventType:
          type: string
          description: The type of lifecycle event (for example, end-of-support, end-of-life).
        date:
          type: string
          format: date-time
          description: The date of the lifecycle event.
        regions:
          type: array
          items:
            type: string
          description: The Amazon Web Services Regions affected by this lifecycle event.
        impactRisks:
          type: array
          items:
            type: string
          description: The potential impact risks associated with this lifecycle event.
        description:
          type: string
          description: A description of the lifecycle event.
    DescribeServiceLifecycleRequest:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/ServiceLifecycleFilter'
        nextToken:
          type: string
          description: If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
        maxResults:
          type: integer
          description: The maximum number of items to return in one batch, between 1 and 20, inclusive.
    DescribeEntityAggregatesForOrganizationResponse:
      type: object
      properties:
        organizationEntityAggregates:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationEntityAggregate'
          description: The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.
    DescribeEntityAggregatesForOrganizationRequest:
      type: object
      properties:
        eventArns:
          type: array
          items:
            type: string
          description: 'A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"'
        awsAccountIds:
          type: array
          items:
            type: string
          description: A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
      required:
      - eventArns
    ServiceLifecycle:
      type: object
      properties:
        service:
          type: string
          description: The name of the Amazon Web Services service.
        version:
          type: string
          description: The version of the service.
        title:
          type: string
          description: A human-readable title for the lifecycle entry.
        recommendedVersion:
          type: string
          description: The recommended version to upgrade to.
        lifecycleEvents:
          type: array
          items:
            $ref: '#/components/schemas/LifecycleEvent'
          description: The list of lifecycle events for this service version.
    DescribeServiceLifecycleResponse:
      type: object
      properties:
        serviceLifecycles:
          type: array
          items:
            $ref: '#/components/schemas/ServiceLifecycle'
          description: The list of service lifecycle entries matching the filter criteria.
        nextToken:
          type: string
          description: If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
  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: health
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/health/service/2016-08-04/health-2016-08-04.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)