openapi: 3.0.0
info:
version: 2016-08-04
x-release: v4
title: 'AWS Health APIs and Notifications #X Amz Target=AWSHealth 20160804.DescribeAffectedAccountsForOrganization #X Amz Target=AWSHealth 20160804.DescribeAffectedAccountsForOrganization #X Amz Target=AWSHealth 20160804.DescribeEventDetailsForOrganization API'
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: mike.ralphson@gmail.com
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
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)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSHealth 20160804.DescribeEventDetailsForOrganization'
paths:
/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetailsForOrganization:
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'
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
tags:
- '#X Amz Target=AWSHealth 20160804.DescribeEventDetailsForOrganization'
components:
schemas:
OrganizationEventDetails:
type: object
properties:
awsAccountId:
allOf:
- $ref: '#/components/schemas/accountId'
- description: The 12-digit Amazon Web Services account numbers that contains the affected entities.
event:
$ref: '#/components/schemas/Event'
eventDescription:
$ref: '#/components/schemas/EventDescription'
eventMetadata:
allOf:
- $ref: '#/components/schemas/eventMetadata'
- description: Additional metadata about the event.
description: Detailed information about an event. A combination of an <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a> object, an <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html">EventDescription</a> object, and additional metadata about the event. Returned by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation.
eventScopeCode:
type: string
enum:
- PUBLIC
- ACCOUNT_SPECIFIC
- NONE
accountId:
type: string
pattern: ^\S+$
maxLength: 12
DescribeEventDetailsForOrganizationResponse:
type: object
properties:
successfulSet:
allOf:
- $ref: '#/components/schemas/DescribeEventDetailsForOrganizationSuccessfulSet'
- description: Information about the events that could be retrieved.
failedSet:
allOf:
- $ref: '#/components/schemas/DescribeEventDetailsForOrganizationFailedSet'
- description: Error messages for any events that could not be retrieved.
eventDescription:
type: string
availabilityZone:
type: string
pattern: '[a-z]{2}\-[0-9a-z\-]{4,16}'
minLength: 6
maxLength: 18
eventMetadata:
type: object
additionalProperties:
$ref: '#/components/schemas/metadataValue'
eventStatusCode:
type: string
enum:
- open
- closed
- upcoming
metadataValue:
type: string
maxLength: 32766
timestamp:
type: string
format: date-time
region:
type: string
pattern: '[^:/]{2,25}'
minLength: 2
maxLength: 25
eventTypeCode:
type: string
pattern: '[a-zA-Z0-9\_\-]{3,100}'
minLength: 3
maxLength: 100
EventDescription:
type: object
properties:
latestDescription:
allOf:
- $ref: '#/components/schemas/eventDescription'
- description: The most recent description of the event.
description: The detailed description of the event. Included in the information returned by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.
DescribeEventDetailsForOrganizationFailedSet:
type: array
items:
$ref: '#/components/schemas/OrganizationEventDetailsErrorItem'
EventAccountFilter:
type: object
required:
- eventArn
properties:
eventArn:
allOf:
- $ref: '#/components/schemas/eventArn'
- description: <p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>
awsAccountId:
allOf:
- $ref: '#/components/schemas/accountId'
- description: The 12-digit Amazon Web Services account numbers that contains the affected entities.
description: The values used to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> operations.
eventTypeCategory:
type: string
enum:
- issue
- accountNotification
- scheduledChange
- investigation
minLength: 3
maxLength: 255
DescribeEventDetailsForOrganizationSuccessfulSet:
type: array
items:
$ref: '#/components/schemas/OrganizationEventDetails'
OrganizationEventDetailFiltersList:
type: array
items:
$ref: '#/components/schemas/EventAccountFilter'
minItems: 1
maxItems: 10
DescribeEventDetailsForOrganizationRequest:
type: object
required:
- organizationEventDetailFilters
title: DescribeEventDetailsForOrganizationRequest
properties:
organizationEventDetailFilters:
allOf:
- $ref: '#/components/schemas/OrganizationEventDetailFiltersList'
- description: A set of JSON elements that includes the <code>awsAccountId</code> and the <code>eventArn</code>.
locale:
allOf:
- $ref: '#/components/schemas/locale'
- description: The locale (language) to return information in. English (en) is the default and the only supported value at this time.
Event:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/eventArn'
- description: <p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>
service:
allOf:
- $ref: '#/components/schemas/service'
- description: The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.
eventTypeCode:
allOf:
- $ref: '#/components/schemas/eventTypeCode'
- description: The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i> </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.
eventTypeCategory:
allOf:
- $ref: '#/components/schemas/eventTypeCategory'
- description: A list of event type category codes. Possible values are <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently, the <code>investigation</code> value isn't supported at this time.
region:
allOf:
- $ref: '#/components/schemas/region'
- description: The Amazon Web Services Region name of the event.
availabilityZone:
allOf:
- $ref: '#/components/schemas/availabilityZone'
- description: The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
startTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The date and time that the event began.
endTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The date and time that the event ended.
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The most recent date and time that the event was updated.
statusCode:
allOf:
- $ref: '#/components/schemas/eventStatusCode'
- description: The most recent status of the event. Possible values are <code>open</code>, <code>closed</code>, and <code>upcoming</code>.
eventScopeCode:
allOf:
- $ref: '#/components/schemas/eventScopeCode'
- description: <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p> <ul> <li> <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the <code>affectedAccounts</code> value is always empty.</p> </li> <li> <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.</p> </li> <li> <p>If the <code>eventScopeCode</code> value is <code>NONE</code>, then the <code>eventArn</code> that you specified in the request is invalid or doesn't exist.</p> </li> </ul>
description: <p>Summary information about an Health event.</p> <p>Health events can be public or account-specific:</p> <ul> <li> <p> <i>Public events</i> might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.</p> </li> <li> <p> <i>Account-specific</i> events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.</p> </li> </ul> <p>You can determine if an event is public or account-specific by using the <code>eventScopeCode</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a>.</p>
OrganizationEventDetailsErrorItem:
type: object
properties:
awsAccountId:
allOf:
- $ref: '#/components/schemas/accountId'
- description: Error information returned when a <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation can't find a specified event.
eventArn:
allOf:
- $ref: '#/components/schemas/eventArn'
- description: <p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>
errorName:
allOf:
- $ref: '#/components/schemas/string'
- description: The name of the error.
errorMessage:
allOf:
- $ref: '#/components/schemas/string'
- description: <p>A message that describes the error.</p> <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p> <ul> <li> <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.</p> </li> <li> <p>We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.</p> </li> <li> <p>Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.</p> </li> </ul>
description: Error information returned when a <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation can't find a specified event.
UnsupportedLocale: {}
service:
type: string
pattern: '[^:/]{2,30}'
minLength: 2
maxLength: 30
string:
type: string
eventArn:
type: string
pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
maxLength: 1600
locale:
type: string
pattern: .{2,256}
minLength: 2
maxLength: 256
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/health/
x-hasEquivalentPaths: true