openapi: 3.0.0
info:
version: 2016-08-04
x-release: v4
title: AWS Health APIs and Notifications
description: <fullname>Health</fullname> <p>The Health API provides programmatic access to the Health information that appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health
Dashboard</a>. You can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p> <note> <ul> <li> <p>You must have a Business,
Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an Amazon
Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a <code>SubscriptionRequiredException</code> error.</p> </li> <li> <p>You can use the
Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an
active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API.
For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the <i>Health User Guide</i>.</p> </li> </ul> </note> <p>For
authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>.</p> <p>If your Amazon Web
Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization.
You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational
view API operations to enable this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating Health
events</a> in the <i>Health User Guide</i>.</p> <note> <p>When you use the Health API operations to return Health events, see the following recommendations:</p> <ul> <li> <p>Use the <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a> parameter to specify whether to return Health events that are
public or account-specific.</p> </li> <li> <p>Use pagination to view all events from the response. For example, if you call the <code>DescribeEventsForOrganization</code> operation to get all
events in your organization, you might receive several page results. Specify the <code>nextToken</code> in the next request to return more results.</p> </li> </ul> </note>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: health
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/health-2016-08-04.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/health/
servers:
- url: https://health.us-east-1.amazonaws.com
variables: {}
description: The general AWSHealth multi-region endpoint
- url: http://health.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWSHealth endpoint for China (Beijing) and China (Ningxia)
- url: https://health.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWSHealth endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedAccountsForOrganization:
post:
operationId: DescribeAffectedAccountsForOrganization
description: <p>Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p> <p>Before you can call this operation, you must first enable Health to work with Organizations. To
do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from
your organization's management account.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAffectedAccountsForOrganizationResponse"
examples:
DescribeAffectedAccountsForOrganization200Example:
summary: Default DescribeAffectedAccountsForOrganization 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: InvalidPaginationToken
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidPaginationToken"
examples:
DescribeAffectedAccountsForOrganization480Example:
summary: Default DescribeAffectedAccountsForOrganization 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAffectedAccountsForOrganizationRequest"
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeAffectedAccountsForOrganization
summary: Amazon Health Dashboard Describe Affected Accounts for Organization
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntities:
post:
operationId: DescribeAffectedEntities
description: <p>Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of
customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is
unknown, include at least one entity indicating this.</p> <p>At least one event ARN is required.</p> <note> <ul> <li> <p>This API operation uses pagination. Specify the <code>nextToken</code>
parameter in the next request to return more results.</p> </li> <li> <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
Health events. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and
action-based conditions</a> in the <i>Health User Guide</i>.</p> </li> </ul> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAffectedEntitiesResponse"
examples:
DescribeAffectedEntities200Example:
summary: Default DescribeAffectedEntities 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: InvalidPaginationToken
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidPaginationToken"
examples:
DescribeAffectedEntities480Example:
summary: Default DescribeAffectedEntities 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"481":
description: UnsupportedLocale
content:
application/json:
schema:
$ref: "#/components/schemas/UnsupportedLocale"
examples:
DescribeAffectedEntities481Example:
summary: Default DescribeAffectedEntities 481 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAffectedEntitiesRequest"
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeAffectedEntities
summary: Amazon Health Dashboard Describe Affected Entities
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntitiesForOrganization:
post:
operationId: DescribeAffectedEntitiesForOrganization
description: <p>Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities
can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.</p> <p>At least one event Amazon Resource Name
(ARN) and account ID are required.</p> <p>Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
management account.</p> <note> <ul> <li> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </li> <li> <p>This
operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see <a
href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User
Guide</i>.</p> </li> </ul> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAffectedEntitiesForOrganizationResponse"
examples:
DescribeAffectedEntitiesForOrganization200Example:
summary: Default DescribeAffectedEntitiesForOrganization 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: InvalidPaginationToken
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidPaginationToken"
examples:
DescribeAffectedEntitiesForOrganization480Example:
summary: Default DescribeAffectedEntitiesForOrganization 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"481":
description: UnsupportedLocale
content:
application/json:
schema:
$ref: "#/components/schemas/UnsupportedLocale"
examples:
DescribeAffectedEntitiesForOrganization481Example:
summary: Default DescribeAffectedEntitiesForOrganization 481 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAffectedEntitiesForOrganizationRequest"
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeAffectedEntitiesForOrganization
summary: Amazon Health Dashboard Describe Affected Entities for Organization
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeEntityAggregates:
post:
operationId: DescribeEntityAggregates
description: Returns the number of entities that are affected by each of the specified events.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEntityAggregatesResponse"
examples:
DescribeEntityAggregates200Example:
summary: Default DescribeEntityAggregates 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEntityAggregatesRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeEntityAggregates
summary: Amazon Health Dashboard Describe Entity Aggregates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeEventAggregates:
post:
operationId: DescribeEventAggregates
description: <p>Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are
returned.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventAggregatesResponse"
examples:
DescribeEventAggregates200Example:
summary: Default DescribeEventAggregates 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: InvalidPaginationToken
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidPaginationToken"
examples:
DescribeEventAggregates480Example:
summary: Default DescribeEventAggregates 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventAggregatesRequest"
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeEventAggregates
summary: Amazon Health Dashboard Describe Event Aggregates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetails:
post:
operationId: DescribeEventDetails
description: <p>Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a>), a detailed event description, and possible additional metadata that depends upon the
nature of the event. Affected entities are not included. To retrieve the entities, use the <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p> <p>If a specified event can't be retrieved, an error
message is returned for that event.</p> <note> <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in
the <i>Health User Guide</i>.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventDetailsResponse"
examples:
DescribeEventDetails200Example:
summary: Default DescribeEventDetails 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: UnsupportedLocale
content:
application/json:
schema:
$ref: "#/components/schemas/UnsupportedLocale"
examples:
DescribeEventDetails480Example:
summary: Default DescribeEventDetails 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventDetailsRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeEventDetails
summary: Amazon Health Dashboard Describe Event Details
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetailsForOrganization:
post:
operationId: DescribeEventDetailsForOrganization
description: <p>Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data
(such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the
resources related to the event. To return affected entities, use the <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> operation.</p> <note> <p>Before you
can call this operation, you must first enable Health to work with Organizations. To do this, call the <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
management account.</p> </note> <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify the <code>organizationEventDetailFilters</code> object in the request.
Depending on the Health event type, note the following differences:</p> <ul> <li> <p>To return event details for a public event, you must specify a null value for the <code>awsAccountId</code>
parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.</p> </li> <li> <p>To return event details for
an event that is specific to an account in your organization, you must specify the <code>awsAccountId</code> parameter in the request. If you don't specify an account ID, Health returns an
error message because the event is specific to an account in your organization. </p> </li> </ul> <p>For more information, see <a
href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p> <note> <p>This operation doesn't support resource-level permissions. You can't use this operation to
allow or deny access to specific Health events. For more information, see <a
href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User
Guide</i>.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventDetailsForOrganizationResponse"
examples:
DescribeEventDetailsForOrganization200Example:
summary: Default DescribeEventDetailsForOrganization 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: UnsupportedLocale
content:
application/json:
schema:
$ref: "#/components/schemas/UnsupportedLocale"
examples:
DescribeEventDetailsForOrganization480Example:
summary: Default DescribeEventDetailsForOrganization 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventDetailsForOrganizationRequest"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeEventDetailsForOrganization
summary: Amazon Health Dashboard Describe Event Details for Organization
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.DescribeEventTypes:
post:
operationId: DescribeEventTypes
description: <p>Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web
Services service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
<p>If you don't specify a filter criteria, the API operation returns all event types, in no particular order. </p> <note> <p>This API operation uses pagination. Specify the
<code>nextToken</code> parameter in the next request to return more results.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventTypesResponse"
examples:
DescribeEventTypes200Example:
summary: Default DescribeEventTypes 200 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"480":
description: InvalidPaginationToken
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidPaginationToken"
examples:
DescribeEventTypes480Example:
summary: Default DescribeEventTypes 480 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
"481":
description: UnsupportedLocale
content:
application/json:
schema:
$ref: "#/components/schemas/UnsupportedLocale"
examples:
DescribeEventTypes481Example:
summary: Default DescribeEventTypes 481 response
x-microcks-default: true
value:
eventArn: arn:aws:health:us-east-1::event/EC2/AWS_EC2_INSTANCE_ISSUE/abc
statusCode: open
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventTypesRequest"
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSHealth_20160804.DescribeEventTypes
summary: Amazon Health Dashboard Describe Event Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=AWSHealth_20160804.Descr
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-health-dashboard/refs/heads/main/openapi/amazon-health-dashboard-openapi.yaml