Module Smaws_Client_Health.Types

type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec tag_value = string
type nonrec tag_key = string
type nonrec tag_set = (tag_key * tag_value) list
type nonrec tag_filter = tag_set list
type nonrec string_ = string
type nonrec service = string
type nonrec service_list = service list
type nonrec region = string
type nonrec region_list = region list
type nonrec next_token = string
type nonrec metadata_value = string
type nonrec metadata_key = string
type nonrec max_results_lower_range = int
type nonrec max_results = int
type nonrec locale = string
type nonrec health_service_access_status_for_organization = string
type nonrec event_type2 = string
type nonrec event_type_list2 = event_type2 list
type nonrec event_type_code = string
type nonrec event_type_category =
  1. | INVESTIGATION
  2. | SCHEDULED_CHANGE
  3. | ACCOUNT_NOTIFICATION
  4. | ISSUE
type nonrec event_type_category_list2 = event_type_category list
type nonrec event_status_code =
  1. | UPCOMING
  2. | CLOSED
  3. | OPEN
type nonrec event_status_code_list = event_status_code list
type nonrec event_scope_code =
  1. | NONE
  2. | ACCOUNT_SPECIFIC
  3. | PUBLIC
type nonrec event_metadata = (metadata_key * metadata_value) list
type nonrec event_arn = string
type nonrec event_arn_list = event_arn list
type nonrec event_aggregate_field =
  1. | EventTypeCategory
type nonrec entity_value = string
type nonrec entity_value_list = entity_value list
type nonrec entity_url = string
type nonrec count = int
type nonrec entity_status_code =
  1. | RESOLVED
  2. | PENDING
  3. | UNKNOWN
  4. | UNIMPAIRED
  5. | IMPAIRED
type nonrec entity_statuses = (entity_status_code * count) list
type nonrec entity_status_code_list = entity_status_code list
type nonrec entity_metadata_value = string
type nonrec entity_metadata_key = string
type nonrec entity_metadata = (entity_metadata_key * entity_metadata_value) list
type nonrec entity_arn = string
type nonrec entity_arn_list = entity_arn list
type nonrec date_time_range = {
  1. to_ : timestamp option;
    (*

    The ending date and time of a time range.

    *)
  2. from_ : timestamp option;
    (*

    The starting date and time of a time range.

    *)
}

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.

type nonrec date_time_range_list = date_time_range list
type nonrec account_id = string
type nonrec aws_account_ids_list = account_id list
type nonrec availability_zone = string
type nonrec availability_zones = availability_zone list
type nonrec aggregate_value = string
type nonrec affected_accounts_list = account_id list
type nonrec unsupported_locale = {
  1. message : string_ option;
}

The specified locale is not supported.

type nonrec event_actionability =
  1. | INFORMATIONAL
  2. | ACTION_MAY_BE_REQUIRED
  3. | ACTION_REQUIRED
type nonrec event_persona =
  1. | BILLING
  2. | SECURITY
  3. | OPERATIONS
type nonrec event_persona_list = event_persona list
type nonrec organization_event = {
  1. personas : event_persona_list option;
    (*

    A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

    *)
  2. actionability : event_actionability option;
    (*

    The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

    *)
  3. status_code : event_status_code option;
    (*

    The most recent status of the event. Possible values are open, closed, and upcoming.

    *)
  4. last_updated_time : timestamp option;
    (*

    The most recent date and time that the event was updated.

    *)
  5. end_time : timestamp option;
    (*

    The date and time that the event ended.

    *)
  6. start_time : timestamp option;
    (*

    The date and time that the event began.

    *)
  7. region : region option;
    (*

    The Amazon Web Services Region name of the event.

    *)
  8. event_scope_code : event_scope_code option;
    (*

    This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

    • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
    • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts 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.
    • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
    *)
  9. event_type_category : event_type_category option;
    (*

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

    *)
  10. event_type_code : event_type_code option;
    (*

    The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

    *)
  11. service : service option;
    (*

    The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

    *)
  12. arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}

Summary information about an event, returned by the DescribeEventsForOrganization operation.

type nonrec organization_event_list = organization_event list
type nonrec event_actionability_list = event_actionability list
type nonrec organization_event_filter = {
  1. personas : event_persona_list option;
    (*

    A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.

    *)
  2. event_status_codes : event_status_code_list option;
    (*

    A list of event status codes.

    *)
  3. event_type_categories : event_type_category_list2 option;
    (*

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

    *)
  4. entity_values : entity_value_list option;
    (*

    A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

    *)
  5. entity_arns : entity_arn_list option;
    (*

    A list of entity ARNs (unique identifiers).

    *)
  6. last_updated_time : date_time_range option;
  7. end_time : date_time_range option;
  8. start_time : date_time_range option;
  9. regions : region_list option;
    (*

    A list of Amazon Web Services Regions.

    *)
  10. services : service_list option;
    (*

    The Amazon Web Services services associated with the event. For example, EC2, RDS.

    *)
  11. aws_account_ids : aws_account_ids_list option;
    (*

    A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
  12. event_type_codes : event_type_list2 option;
    (*

    A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".

    *)
  13. actionabilities : event_actionability_list option;
    (*

    A list of actionability values to filter events. Use this to filter events based on whether they require action (ACTION_REQUIRED), may require action (ACTION_MAY_BE_REQUIRED) or are informational (INFORMATIONAL).

    *)
}

The values to filter results from the DescribeEventsForOrganization operation.

type nonrec organization_event_details_error_item = {
  1. error_message : string_ option;
    (*

    A message that describes the error.

    If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

    • 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.
    • 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.
    • 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.
    *)
  2. error_name : string_ option;
    (*

    The name of the error.

    *)
  3. event_arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
  4. aws_account_id : account_id option;
    (*

    Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.

    *)
}

Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.

type nonrec event = {
  1. personas : event_persona_list option;
    (*

    A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

    *)
  2. actionability : event_actionability option;
    (*

    The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

    *)
  3. event_scope_code : event_scope_code option;
    (*

    This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

    • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
    • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts 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.
    • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
    *)
  4. status_code : event_status_code option;
    (*

    The most recent status of the event. Possible values are open, closed, and upcoming.

    *)
  5. last_updated_time : timestamp option;
    (*

    The most recent date and time that the event was updated.

    *)
  6. end_time : timestamp option;
    (*

    The date and time that the event ended.

    *)
  7. start_time : timestamp option;
    (*

    The date and time that the event began.

    *)
  8. availability_zone : availability_zone option;
    (*

    The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

    *)
  9. region : region option;
    (*

    The Amazon Web Services Region name of the event.

    *)
  10. event_type_category : event_type_category option;
    (*

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

    *)
  11. event_type_code : event_type_code option;
    (*

    The unique identifier for the event type. The format is

    AWS_{i SERVICE}_{i DESCRIPTION}

    ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

    *)
  12. service : service option;
    (*

    The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

    *)
  13. arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}

Summary information about an Health event.

Health events can be public or account-specific:

  • Public events 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.
  • Account-specific 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.

You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.

type nonrec event_description2 = string
type nonrec event_description = {
  1. latest_description : event_description2 option;
    (*

    The most recent description of the event.

    *)
}

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

type nonrec organization_event_details = {
  1. event_metadata : event_metadata option;
    (*

    Additional metadata about the event.

    *)
  2. event_description : event_description option;
  3. event : event option;
  4. aws_account_id : account_id option;
    (*

    The 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
}

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.

type nonrec event_account_filter = {
  1. aws_account_id : account_id option;
    (*

    The 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
  2. event_arn : event_arn;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}

The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.

type nonrec organization_event_detail_filters_list = event_account_filter list
type nonrec organization_event_arns_list = event_arn list
type nonrec organization_entity_filters_list = event_account_filter list
type nonrec account_entity_aggregate = {
  1. statuses : entity_statuses option;
    (*

    The number of affected entities aggregated by the entity status codes.

    *)
  2. count : count option;
    (*

    The number of entities that match the filter criteria for the specified events.

    *)
  3. account_id : event_arn option;
    (*

    The 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
}

The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.

type nonrec account_entity_aggregates_list = account_entity_aggregate list
type nonrec organization_entity_aggregate = {
  1. accounts : account_entity_aggregates_list option;
    (*

    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.

    *)
  2. statuses : entity_statuses option;
    (*

    The number of affected entities aggregated by the entitiy status codes.

    *)
  3. count : count option;
    (*

    The number of entities for the organization that match the filter criteria for the specified events.

    *)
  4. event_arn : event_arn option;
    (*

    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"

    *)
}

The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.

type nonrec organization_entity_aggregates_list = organization_entity_aggregate list
type nonrec entity_account_filter = {
  1. status_codes : entity_status_code_list option;
    (*

    A list of entity status codes.

    *)
  2. aws_account_id : account_id option;
    (*

    The 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
  3. event_arn : event_arn;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}

A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.

type nonrec organization_entity_account_filters_list = entity_account_filter list
type nonrec organization_affected_entities_error_item = {
  1. error_message : string_ option;
    (*

    A message that describes the error. Follow the error message and retry your request.

    For example, the InvalidAccountInputError error message appears if you call the DescribeAffectedEntitiesForOrganization operation and specify the AccountSpecific value for the EventScopeCode parameter, but don't specify an Amazon Web Services account.

    *)
  2. error_name : string_ option;
    (*

    The name of the error.

    *)
  3. event_arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
  4. aws_account_id : account_id option;
    (*

    The 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
}

Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.

type nonrec organization_account_ids_list = account_id list
type nonrec invalid_pagination_token = {
  1. message : string_ option;
}

The specified pagination token (nextToken) is not valid.

type nonrec event_type_persona =
  1. | BILLING
  2. | SECURITY
  3. | OPERATIONS
type nonrec event_type_persona_list = event_type_persona list
type nonrec event_type_actionability =
  1. | INFORMATIONAL
  2. | ACTION_MAY_BE_REQUIRED
  3. | ACTION_REQUIRED
type nonrec event_type = {
  1. personas : event_type_persona_list option;
    (*

    A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

    *)
  2. actionability : event_type_actionability option;
    (*

    The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

    *)
  3. category : event_type_category option;
    (*

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

    *)
  4. code : event_type_code option;
    (*

    The unique identifier for the event type. The format is

    AWS_{i SERVICE}_{i DESCRIPTION}

    ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

    *)
  5. service : service option;
    (*

    The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

    *)
}

Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

You can use the DescribeEventTypes API operation to return this information about an event.

You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events in the Health User Guide.

type nonrec event_type_list = event_type list
type nonrec event_type_code_list = event_type_code list
type nonrec event_type_category_list = event_type_category list
type nonrec event_type_actionability_list = event_type_actionability list
type nonrec event_type_filter = {
  1. personas : event_type_persona_list option;
    (*

    A list of persona classifications to filter event types. Possible values are OPERATIONS, SECURITY, and BILLING.

    *)
  2. actionabilities : event_type_actionability_list option;
    (*

    A list of actionability values to filter event types. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL.

    *)
  3. event_type_categories : event_type_category_list option;
    (*

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

    *)
  4. services : service_list option;
    (*

    The Amazon Web Services services associated with the event. For example, EC2, RDS.

    *)
  5. event_type_codes : event_type_code_list option;
    (*

    A list of event type codes.

    *)
}

The values to use to filter results from the DescribeEventTypes operation.

type nonrec event_list = event list
type nonrec event_filter = {
  1. personas : event_persona_list option;
    (*

    A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.

    *)
  2. event_status_codes : event_status_code_list option;
    (*

    A list of event status codes.

    *)
  3. tags : tag_filter option;
    (*

    A map of entity tags attached to the affected entity.

    Currently, the tags property isn't supported.

    *)
  4. event_type_categories : event_type_category_list2 option;
    (*

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

    *)
  5. entity_values : entity_value_list option;
    (*

    A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

    *)
  6. entity_arns : entity_arn_list option;
    (*

    A list of entity ARNs (unique identifiers).

    *)
  7. last_updated_times : date_time_range_list option;
    (*

    A list of dates and times that the event was last updated.

    *)
  8. end_times : date_time_range_list option;
    (*

    A list of dates and times that the event ended.

    *)
  9. start_times : date_time_range_list option;
    (*

    A list of dates and times that the event began.

    *)
  10. availability_zones : availability_zones option;
    (*

    A list of Amazon Web Services Availability Zones.

    *)
  11. regions : region_list option;
    (*

    A list of Amazon Web Services Regions.

    *)
  12. services : service_list option;
    (*

    The Amazon Web Services services associated with the event. For example, EC2, RDS.

    *)
  13. event_type_codes : event_type_list2 option;
    (*

    A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".

    *)
  14. event_arns : event_arn_list option;
    (*

    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"

    *)
  15. actionabilities : event_actionability_list option;
    (*

    A list of actionability values to filter events. Use this to filter events based on whether they require action (ACTION_REQUIRED), may require action (ACTION_MAY_BE_REQUIRED) or are informational (INFORMATIONAL).

    *)
}

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

type nonrec event_details_error_item = {
  1. error_message : string_ option;
    (*

    A message that describes the error.

    *)
  2. error_name : string_ option;
    (*

    The name of the error.

    *)
  3. event_arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}

Error information returned when a DescribeEventDetails operation can't find a specified event.

type nonrec event_details = {
  1. event_metadata : event_metadata option;
    (*

    Additional metadata about the event.

    *)
  2. event_description : event_description option;
    (*

    The most recent description of the event.

    *)
  3. event : event option;
    (*

    Summary information about the event.

    *)
}

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.

type nonrec event_arns_list = event_arn list
type nonrec event_aggregate = {
  1. count : count option;
    (*

    The number of events of the associated issue type.

    *)
  2. aggregate_value : aggregate_value option;
    (*

    The issue type for the associated count.

    *)
}

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

type nonrec event_aggregate_list = event_aggregate list
type nonrec affected_entity = {
  1. entity_metadata : entity_metadata option;
    (*

    Additional metadata about the affected entity.

    *)
  2. tags : tag_set option;
    (*

    A map of entity tags attached to the affected entity.

    Currently, the tags property isn't supported.

    *)
  3. status_code : entity_status_code option;
    (*

    The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, UNKNOWN, PENDING, and RESOLVED.

    *)
  4. last_updated_time : timestamp option;
    (*

    The most recent time that the entity was updated.

    *)
  5. aws_account_id : account_id option;
    (*

    The 12-digit Amazon Web Services account number that contains the affected entity.

    *)
  6. entity_url : entity_url option;
    (*

    The URL of the affected entity.

    *)
  7. entity_value : entity_value option;
    (*

    The ID of the affected entity.

    *)
  8. event_arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
  9. entity_arn : entity_arn option;
    (*

    The unique identifier for the entity. Format:

    arn:aws:health:{i entity-region}:{i aws-account}:entity/{i entity-id}

    . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K

    *)
}

Information about an entity that is affected by a Health event.

type nonrec entity_list = affected_entity list
type nonrec entity_filter = {
  1. status_codes : entity_status_code_list option;
    (*

    A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).

    *)
  2. tags : tag_filter option;
    (*

    A map of entity tags attached to the affected entity.

    Currently, the tags property isn't supported.

    *)
  3. last_updated_times : date_time_range_list option;
    (*

    A list of the most recent dates and times that the entity was updated.

    *)
  4. entity_values : entity_value_list option;
    (*

    A list of IDs for affected entities.

    *)
  5. entity_arns : entity_arn_list option;
    (*

    A list of entity ARNs (unique identifiers).

    *)
  6. event_arns : event_arn_list;
    (*

    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"

    *)
}

The values to use to filter results from the DescribeAffectedEntities operation.

type nonrec entity_aggregate = {
  1. statuses : entity_statuses option;
    (*

    The number of affected entities aggregated by the entity status codes.

    *)
  2. count : count option;
    (*

    The number of entities that match the criteria for the specified events.

    *)
  3. event_arn : event_arn option;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

type nonrec entity_aggregate_list = entity_aggregate list
type nonrec concurrent_modification_exception = {
  1. message : string_ option;
}

EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

type nonrec describe_health_service_status_for_organization_response = {
  1. health_service_access_status_for_organization : health_service_access_status_for_organization option;
    (*

    Information about the status of enabling or disabling the Health organizational view feature in your organization.

    Valid values are ENABLED | DISABLED | PENDING.

    *)
}
type nonrec describe_events_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. events : event_list option;
    (*

    The events that match the specified filter criteria.

    *)
}
type nonrec describe_events_request = {
  1. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  2. max_results : max_results_lower_range option;
    (*

    The maximum number of items to return in one batch, between 1 and 100, inclusive.

    *)
  3. next_token : next_token option;
    (*

    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.

    *)
  4. filter : event_filter option;
    (*

    Values to narrow the results returned.

    *)
}
type nonrec describe_events_for_organization_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. events : organization_event_list option;
    (*

    The events that match the specified filter criteria.

    *)
}
type nonrec describe_events_for_organization_request = {
  1. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  2. max_results : max_results_lower_range option;
    (*

    The maximum number of items to return in one batch, between 1 and 100, inclusive.

    *)
  3. next_token : next_token option;
    (*

    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.

    *)
  4. filter : organization_event_filter option;
    (*

    Values to narrow the results returned.

    *)
}
type nonrec describe_event_types_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. event_types : event_type_list option;
    (*

    A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format

    AWS_{i SERVICE}_{i DESCRIPTION}

    ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

    *)
}
type nonrec describe_event_types_request = {
  1. max_results : max_results option;
    (*

    The maximum number of items to return in one batch, between 10 and 100, inclusive.

    If you don't specify the maxResults parameter, this operation returns a maximum of 30 items by default.

    *)
  2. next_token : next_token option;
    (*

    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.

    *)
  3. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  4. filter : event_type_filter option;
    (*

    Values to narrow the results returned.

    *)
}
type nonrec describe_event_details_successful_set = event_details list
type nonrec describe_event_details_failed_set = event_details_error_item list
type nonrec describe_event_details_response = {
  1. failed_set : describe_event_details_failed_set option;
    (*

    Error messages for any events that could not be retrieved.

    *)
  2. successful_set : describe_event_details_successful_set option;
    (*

    Information about the events that could be retrieved.

    *)
}
type nonrec describe_event_details_request = {
  1. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  2. event_arns : event_arn_list;
    (*

    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"

    *)
}
type nonrec describe_event_details_for_organization_successful_set = organization_event_details list
type nonrec describe_event_details_for_organization_failed_set = organization_event_details_error_item list
type nonrec describe_event_details_for_organization_response = {
  1. failed_set : describe_event_details_for_organization_failed_set option;
    (*

    Error messages for any events that could not be retrieved.

    *)
  2. successful_set : describe_event_details_for_organization_successful_set option;
    (*

    Information about the events that could be retrieved.

    *)
}
type nonrec describe_event_details_for_organization_request = {
  1. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  2. organization_event_detail_filters : organization_event_detail_filters_list;
    (*

    A set of JSON elements that includes the awsAccountId and the eventArn.

    *)
}
type nonrec describe_event_aggregates_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. event_aggregates : event_aggregate_list option;
    (*

    The number of events in each category that meet the optional filter criteria.

    *)
}
type nonrec describe_event_aggregates_request = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of items to return in one batch, between 10 and 100, inclusive.

    *)
  3. aggregate_field : event_aggregate_field;
    (*

    The only currently supported value is eventTypeCategory.

    *)
  4. filter : event_filter option;
    (*

    Values to narrow the results returned.

    *)
}
type nonrec describe_entity_aggregates_response = {
  1. entity_aggregates : entity_aggregate_list option;
    (*

    The number of entities that are affected by each of the specified events.

    *)
}
type nonrec describe_entity_aggregates_request = {
  1. event_arns : event_arns_list option;
    (*

    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"

    *)
}
type nonrec describe_entity_aggregates_for_organization_response = {
  1. organization_entity_aggregates : organization_entity_aggregates_list option;
    (*

    The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.

    *)
}
type nonrec describe_entity_aggregates_for_organization_request = {
  1. aws_account_ids : organization_account_ids_list option;
    (*

    A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

    *)
  2. event_arns : organization_event_arns_list;
    (*

    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"

    *)
}
type nonrec describe_affected_entities_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. entities : entity_list option;
    (*

    The entities that match the filter criteria.

    *)
}
type nonrec describe_affected_entities_request = {
  1. max_results : max_results_lower_range option;
    (*

    The maximum number of items to return in one batch, between 1 and 100, inclusive.

    *)
  2. next_token : next_token option;
    (*

    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.

    *)
  3. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  4. filter : entity_filter;
    (*

    Values to narrow the results returned. At least one event ARN is required.

    *)
}
type nonrec describe_affected_entities_for_organization_failed_set = organization_affected_entities_error_item list
type nonrec describe_affected_entities_for_organization_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. failed_set : describe_affected_entities_for_organization_failed_set option;
    (*

    A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.

    *)
  3. entities : entity_list option;
    (*

    A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.

    *)
}
type nonrec describe_affected_entities_for_organization_request = {
  1. organization_entity_account_filters : organization_entity_account_filters_list option;
    (*

    A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.

    *)
  2. max_results : max_results_lower_range option;
    (*

    The maximum number of items to return in one batch, between 1 and 100, inclusive.

    *)
  3. next_token : next_token option;
    (*

    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.

    *)
  4. locale : locale option;
    (*

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

    *)
  5. organization_entity_filters : organization_entity_filters_list option;
    (*

    A JSON set of elements including the awsAccountId and the eventArn.

    *)
}
type nonrec describe_affected_accounts_for_organization_response = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. event_scope_code : event_scope_code option;
    (*

    This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

    • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
    • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts 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.
    • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
    *)
  3. affected_accounts : affected_accounts_list option;
    (*

    A JSON set of elements of the affected accounts.

    *)
}
type nonrec describe_affected_accounts_for_organization_request = {
  1. max_results : max_results option;
    (*

    The maximum number of items to return in one batch, between 10 and 100, inclusive.

    *)
  2. next_token : next_token option;
    (*

    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.

    *)
  3. event_arn : event_arn;
    (*

    The unique identifier for the event. The event ARN has the

    arn:aws:health:{i event-region}::event/{i SERVICE}/{i EVENT_TYPE_CODE}/{i EVENT_TYPE_PLUS_ID}

    format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

    *)
}