{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2016-08-04",
    "endpointPrefix":"health",
    "jsonVersion":"1.1",
    "protocol":"json",
    "serviceAbbreviation":"AWSHealth",
    "serviceFullName":"AWS Health APIs and Notifications",
    "signatureVersion":"v4",
    "targetPrefix":"AWSHealth_20160804",
    "uid":"health-2016-08-04"
  },
  "operations":{
    "DescribeAffectedEntities":{
      "name":"DescribeAffectedEntities",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeAffectedEntitiesRequest"},
      "output":{"shape":"DescribeAffectedEntitiesResponse"},
      "errors":[
        {"shape":"InvalidPaginationToken"},
        {"shape":"UnsupportedLocale"}
      ],
      "documentation":"<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 AWS 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. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>",
      "idempotent":true
    },
    "DescribeEntityAggregates":{
      "name":"DescribeEntityAggregates",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeEntityAggregatesRequest"},
      "output":{"shape":"DescribeEntityAggregatesResponse"},
      "documentation":"<p>Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.</p>",
      "idempotent":true
    },
    "DescribeEventAggregates":{
      "name":"DescribeEventAggregates",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeEventAggregatesRequest"},
      "output":{"shape":"DescribeEventAggregatesResponse"},
      "errors":[
        {"shape":"InvalidPaginationToken"}
      ],
      "documentation":"<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>",
      "idempotent":true
    },
    "DescribeEventDetails":{
      "name":"DescribeEventDetails",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeEventDetailsRequest"},
      "output":{"shape":"DescribeEventDetailsResponse"},
      "errors":[
        {"shape":"UnsupportedLocale"}
      ],
      "documentation":"<p>Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by <a>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 those, use the <a>DescribeAffectedEntities</a> operation.</p> <p>If a specified event cannot be retrieved, an error message is returned for that event.</p>",
      "idempotent":true
    },
    "DescribeEventTypes":{
      "name":"DescribeEventTypes",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeEventTypesRequest"},
      "output":{"shape":"DescribeEventTypesResponse"},
      "errors":[
        {"shape":"InvalidPaginationToken"},
        {"shape":"UnsupportedLocale"}
      ],
      "documentation":"<p>Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.</p>",
      "idempotent":true
    },
    "DescribeEvents":{
      "name":"DescribeEvents",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeEventsRequest"},
      "output":{"shape":"DescribeEventsResponse"},
      "errors":[
        {"shape":"InvalidPaginationToken"},
        {"shape":"UnsupportedLocale"}
      ],
      "documentation":"<p>Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the <a>DescribeEventDetails</a> and <a>DescribeAffectedEntities</a> operations.</p> <p>If no filter criteria are specified, all events are returned. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent.</p>",
      "idempotent":true
    }
  },
  "shapes":{
    "AffectedEntity":{
      "type":"structure",
      "members":{
        "entityArn":{
          "shape":"entityArn",
          "documentation":"<p>The unique identifier for the entity. Format: <code>arn:aws:health:<i>entity-region</i>:<i>aws-account</i>:entity/<i>entity-id</i> </code>. Example: <code>arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K</code> </p>"
        },
        "eventArn":{
          "shape":"eventArn",
          "documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331</code> </p>"
        },
        "entityValue":{
          "shape":"entityValue",
          "documentation":"<p>The ID of the affected entity.</p>"
        },
        "awsAccountId":{
          "shape":"accountId",
          "documentation":"<p>The 12-digit AWS account number that contains the affected entity.</p>"
        },
        "lastUpdatedTime":{
          "shape":"timestamp",
          "documentation":"<p>The most recent time that the entity was updated.</p>"
        },
        "statusCode":{
          "shape":"entityStatusCode",
          "documentation":"<p>The most recent status of the entity affected by the event. The possible values are <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, and <code>UNKNOWN</code>.</p>"
        },
        "tags":{
          "shape":"tagSet",
          "documentation":"<p>A map of entity tags attached to the affected entity.</p>"
        }
      },
      "documentation":"<p>Information about an entity that is affected by a Health event.</p>"
    },
    "DateTimeRange":{
      "type":"structure",
      "members":{
        "from":{
          "shape":"timestamp",
          "documentation":"<p>The starting date and time of a time range.</p>"
        },
        "to":{
          "shape":"timestamp",
          "documentation":"<p>The ending date and time of a time range.</p>"
        }
      },
      "documentation":"<p>A range of dates and times that is used by the <a>EventFilter</a> and <a>EntityFilter</a> objects. If <code>from</code> is set and <code>to</code> is set: match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code> inclusive. If <code>from</code> is set and <code>to</code> is not set: match items where the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set and <code>to</code> is set: match items where the timestamp value is equal to or before <code>to</code>.</p>"
    },
    "DescribeAffectedEntitiesRequest":{
      "type":"structure",
      "required":["filter"],
      "members":{
        "filter":{
          "shape":"EntityFilter",
          "documentation":"<p>Values to narrow the results returned. At least one event ARN is required. </p>"
        },
        "locale":{
          "shape":"locale",
          "documentation":"<p>The locale (language) to return information in. The default is English.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        },
        "maxResults":{
          "shape":"maxResults",
          "documentation":"<p>The maximum number of items to return in one batch.</p>"
        }
      }
    },
    "DescribeAffectedEntitiesResponse":{
      "type":"structure",
      "members":{
        "entities":{
          "shape":"EntityList",
          "documentation":"<p>The entities that match the filter criteria.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        }
      }
    },
    "DescribeEntityAggregatesRequest":{
      "type":"structure",
      "members":{
        "eventArns":{
          "shape":"EventArnsList",
          "documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"</code> </p>"
        }
      }
    },
    "DescribeEntityAggregatesResponse":{
      "type":"structure",
      "members":{
        "entityAggregates":{
          "shape":"EntityAggregateList",
          "documentation":"<p>The number of entities that are affected by each of the specified events.</p>"
        }
      }
    },
    "DescribeEventAggregatesRequest":{
      "type":"structure",
      "required":["aggregateField"],
      "members":{
        "filter":{
          "shape":"EventFilter",
          "documentation":"<p>Values to narrow the results returned.</p>"
        },
        "aggregateField":{
          "shape":"eventAggregateField",
          "documentation":"<p>The only currently supported value is <code>eventTypeCategory</code>.</p>"
        },
        "maxResults":{
          "shape":"maxResults",
          "documentation":"<p>The maximum number of items to return in one batch.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        }
      }
    },
    "DescribeEventAggregatesResponse":{
      "type":"structure",
      "members":{
        "eventAggregates":{
          "shape":"EventAggregateList",
          "documentation":"<p>The number of events in each category that meet the optional filter criteria.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        }
      }
    },
    "DescribeEventDetailsFailedSet":{
      "type":"list",
      "member":{"shape":"EventDetailsErrorItem"}
    },
    "DescribeEventDetailsRequest":{
      "type":"structure",
      "required":["eventArns"],
      "members":{
        "eventArns":{
          "shape":"eventArnList",
          "documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"</code> </p>"
        },
        "locale":{
          "shape":"locale",
          "documentation":"<p>The locale (language) to return information in. The default is English.</p>"
        }
      }
    },
    "DescribeEventDetailsResponse":{
      "type":"structure",
      "members":{
        "successfulSet":{
          "shape":"DescribeEventDetailsSuccessfulSet",
          "documentation":"<p>Information about the events that could be retrieved.</p>"
        },
        "failedSet":{
          "shape":"DescribeEventDetailsFailedSet",
          "documentation":"<p>Error messages for any events that could not be retrieved.</p>"
        }
      }
    },
    "DescribeEventDetailsSuccessfulSet":{
      "type":"list",
      "member":{"shape":"EventDetails"}
    },
    "DescribeEventTypesRequest":{
      "type":"structure",
      "members":{
        "filter":{
          "shape":"EventTypeFilter",
          "documentation":"<p>Values to narrow the results returned.</p>"
        },
        "locale":{
          "shape":"locale",
          "documentation":"<p>The locale (language) to return information in. The default is English.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        },
        "maxResults":{
          "shape":"maxResults",
          "documentation":"<p>The maximum number of items to return in one batch.</p>"
        }
      }
    },
    "DescribeEventTypesResponse":{
      "type":"structure",
      "members":{
        "eventTypes":{
          "shape":"EventTypeList",
          "documentation":"<p>List of event types to be matched with.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        }
      }
    },
    "DescribeEventsRequest":{
      "type":"structure",
      "members":{
        "filter":{
          "shape":"EventFilter",
          "documentation":"<p>Values to narrow the results returned.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        },
        "maxResults":{
          "shape":"maxResults",
          "documentation":"<p>The maximum number of items to return in one batch.</p>"
        },
        "locale":{
          "shape":"locale",
          "documentation":"<p>The locale (language) to return information in. The default is English.</p>"
        }
      }
    },
    "DescribeEventsResponse":{
      "type":"structure",
      "members":{
        "events":{
          "shape":"EventList",
          "documentation":"<p>The events that match the specified filter criteria.</p>"
        },
        "nextToken":{
          "shape":"nextToken",
          "documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>"
        }
      }
    },
    "EntityAggregate":{
      "type":"structure",
      "members":{
        "eventArn":{
          "shape":"eventArn",
          "documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331</code> </p>"