Smaws_Client_Health (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_date_time_range : 
  ?to_:Types.timestamp ->
  ?from_:Types.timestamp ->
  unit ->
  Types.date_time_range

val make_organization_event : 
  ?personas:Types.event_persona_list ->
  ?actionability:Types.event_actionability ->
  ?status_code:Types.event_status_code ->
  ?last_updated_time:Types.timestamp ->
  ?end_time:Types.timestamp ->
  ?start_time:Types.timestamp ->
  ?region:Types.region ->
  ?event_scope_code:Types.event_scope_code ->
  ?event_type_category:Types.event_type_category ->
  ?event_type_code:Types.event_type_code ->
  ?service:Types.service ->
  ?arn:Types.event_arn ->
  unit ->
  Types.organization_event

val make_organization_event_filter : 
  ?personas:Types.event_persona_list ->
  ?event_status_codes:Types.event_status_code_list ->
  ?event_type_categories:Types.event_type_category_list2 ->
  ?entity_values:Types.entity_value_list ->
  ?entity_arns:Types.entity_arn_list ->
  ?last_updated_time:Types.date_time_range ->
  ?end_time:Types.date_time_range ->
  ?start_time:Types.date_time_range ->
  ?regions:Types.region_list ->
  ?services:Types.service_list ->
  ?aws_account_ids:Types.aws_account_ids_list ->
  ?event_type_codes:Types.event_type_list2 ->
  ?actionabilities:Types.event_actionability_list ->
  unit ->
  Types.organization_event_filter

val make_organization_event_details_error_item : 
  ?error_message:Types.string_ ->
  ?error_name:Types.string_ ->
  ?event_arn:Types.event_arn ->
  ?aws_account_id:Types.account_id ->
  unit ->
  Types.organization_event_details_error_item

val make_event : 
  ?personas:Types.event_persona_list ->
  ?actionability:Types.event_actionability ->
  ?event_scope_code:Types.event_scope_code ->
  ?status_code:Types.event_status_code ->
  ?last_updated_time:Types.timestamp ->
  ?end_time:Types.timestamp ->
  ?start_time:Types.timestamp ->
  ?availability_zone:Types.availability_zone ->
  ?region:Types.region ->
  ?event_type_category:Types.event_type_category ->
  ?event_type_code:Types.event_type_code ->
  ?service:Types.service ->
  ?arn:Types.event_arn ->
  unit ->
  Types.event

val make_event_description : 
  ?latest_description:Types.event_description2 ->
  unit ->
  Types.event_description

val make_organization_event_details : 
  ?event_metadata:Types.event_metadata ->
  ?event_description:Types.event_description ->
  ?event:Types.event ->
  ?aws_account_id:Types.account_id ->
  unit ->
  Types.organization_event_details

val make_event_account_filter : 
  ?aws_account_id:Types.account_id ->
  event_arn:Types.event_arn ->
  unit ->
  Types.event_account_filter

val make_account_entity_aggregate : 
  ?statuses:Types.entity_statuses ->
  ?count:Types.count ->
  ?account_id:Types.event_arn ->
  unit ->
  Types.account_entity_aggregate

val make_organization_entity_aggregate : 
  ?accounts:Types.account_entity_aggregates_list ->
  ?statuses:Types.entity_statuses ->
  ?count:Types.count ->
  ?event_arn:Types.event_arn ->
  unit ->
  Types.organization_entity_aggregate

val make_entity_account_filter : 
  ?status_codes:Types.entity_status_code_list ->
  ?aws_account_id:Types.account_id ->
  event_arn:Types.event_arn ->
  unit ->
  Types.entity_account_filter

val make_organization_affected_entities_error_item : 
  ?error_message:Types.string_ ->
  ?error_name:Types.string_ ->
  ?event_arn:Types.event_arn ->
  ?aws_account_id:Types.account_id ->
  unit ->
  Types.organization_affected_entities_error_item

val make_event_type : 
  ?personas:Types.event_type_persona_list ->
  ?actionability:Types.event_type_actionability ->
  ?category:Types.event_type_category ->
  ?code:Types.event_type_code ->
  ?service:Types.service ->
  unit ->
  Types.event_type

val make_event_type_filter : 
  ?personas:Types.event_type_persona_list ->
  ?actionabilities:Types.event_type_actionability_list ->
  ?event_type_categories:Types.event_type_category_list ->
  ?services:Types.service_list ->
  ?event_type_codes:Types.event_type_code_list ->
  unit ->
  Types.event_type_filter

val make_event_filter : 
  ?personas:Types.event_persona_list ->
  ?event_status_codes:Types.event_status_code_list ->
  ?tags:Types.tag_filter ->
  ?event_type_categories:Types.event_type_category_list2 ->
  ?entity_values:Types.entity_value_list ->
  ?entity_arns:Types.entity_arn_list ->
  ?last_updated_times:Types.date_time_range_list ->
  ?end_times:Types.date_time_range_list ->
  ?start_times:Types.date_time_range_list ->
  ?availability_zones:Types.availability_zones ->
  ?regions:Types.region_list ->
  ?services:Types.service_list ->
  ?event_type_codes:Types.event_type_list2 ->
  ?event_arns:Types.event_arn_list ->
  ?actionabilities:Types.event_actionability_list ->
  unit ->
  Types.event_filter

val make_event_details_error_item : 
  ?error_message:Types.string_ ->
  ?error_name:Types.string_ ->
  ?event_arn:Types.event_arn ->
  unit ->
  Types.event_details_error_item

val make_event_details : 
  ?event_metadata:Types.event_metadata ->
  ?event_description:Types.event_description ->
  ?event:Types.event ->
  unit ->
  Types.event_details

val make_event_aggregate : 
  ?count:Types.count ->
  ?aggregate_value:Types.aggregate_value ->
  unit ->
  Types.event_aggregate

val make_affected_entity : 
  ?entity_metadata:Types.entity_metadata ->
  ?tags:Types.tag_set ->
  ?status_code:Types.entity_status_code ->
  ?last_updated_time:Types.timestamp ->
  ?aws_account_id:Types.account_id ->
  ?entity_url:Types.entity_url ->
  ?entity_value:Types.entity_value ->
  ?event_arn:Types.event_arn ->
  ?entity_arn:Types.entity_arn ->
  unit ->
  Types.affected_entity

val make_entity_filter : 
  ?status_codes:Types.entity_status_code_list ->
  ?tags:Types.tag_filter ->
  ?last_updated_times:Types.date_time_range_list ->
  ?entity_values:Types.entity_value_list ->
  ?entity_arns:Types.entity_arn_list ->
  event_arns:Types.event_arn_list ->
  unit ->
  Types.entity_filter

val make_entity_aggregate : 
  ?statuses:Types.entity_statuses ->
  ?count:Types.count ->
  ?event_arn:Types.event_arn ->
  unit ->
  Types.entity_aggregate

val make_describe_health_service_status_for_organization_response : 
  ?health_service_access_status_for_organization:
    Types.health_service_access_status_for_organization ->
  unit ->
  Types.describe_health_service_status_for_organization_response

val make_describe_events_response : 
  ?next_token:Types.next_token ->
  ?events:Types.event_list ->
  unit ->
  Types.describe_events_response

val make_describe_events_request : 
  ?locale:Types.locale ->
  ?max_results:Types.max_results_lower_range ->
  ?next_token:Types.next_token ->
  ?filter:Types.event_filter ->
  unit ->
  Types.describe_events_request

val make_describe_events_for_organization_response : 
  ?next_token:Types.next_token ->
  ?events:Types.organization_event_list ->
  unit ->
  Types.describe_events_for_organization_response

val make_describe_events_for_organization_request : 
  ?locale:Types.locale ->
  ?max_results:Types.max_results_lower_range ->
  ?next_token:Types.next_token ->
  ?filter:Types.organization_event_filter ->
  unit ->
  Types.describe_events_for_organization_request

val make_describe_event_types_response : 
  ?next_token:Types.next_token ->
  ?event_types:Types.event_type_list ->
  unit ->
  Types.describe_event_types_response

val make_describe_event_types_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  ?locale:Types.locale ->
  ?filter:Types.event_type_filter ->
  unit ->
  Types.describe_event_types_request

val make_describe_event_details_response : 
  ?failed_set:Types.describe_event_details_failed_set ->
  ?successful_set:Types.describe_event_details_successful_set ->
  unit ->
  Types.describe_event_details_response

val make_describe_event_details_request : 
  ?locale:Types.locale ->
  event_arns:Types.event_arn_list ->
  unit ->
  Types.describe_event_details_request

val make_describe_event_details_for_organization_response : 
  ?failed_set:Types.describe_event_details_for_organization_failed_set ->
  ?successful_set:Types.describe_event_details_for_organization_successful_set ->
  unit ->
  Types.describe_event_details_for_organization_response

val make_describe_event_details_for_organization_request : 
  ?locale:Types.locale ->
  organization_event_detail_filters:
    Types.organization_event_detail_filters_list ->
  unit ->
  Types.describe_event_details_for_organization_request

val make_describe_event_aggregates_response : 
  ?next_token:Types.next_token ->
  ?event_aggregates:Types.event_aggregate_list ->
  unit ->
  Types.describe_event_aggregates_response

val make_describe_event_aggregates_request : 
  ?next_token:Types.next_token ->
  ?max_results:Types.max_results ->
  ?filter:Types.event_filter ->
  aggregate_field:Types.event_aggregate_field ->
  unit ->
  Types.describe_event_aggregates_request

val make_describe_entity_aggregates_response : 
  ?entity_aggregates:Types.entity_aggregate_list ->
  unit ->
  Types.describe_entity_aggregates_response

val make_describe_entity_aggregates_request : 
  ?event_arns:Types.event_arns_list ->
  unit ->
  Types.describe_entity_aggregates_request

val make_describe_entity_aggregates_for_organization_response : 
  ?organization_entity_aggregates:Types.organization_entity_aggregates_list ->
  unit ->
  Types.describe_entity_aggregates_for_organization_response

val make_describe_entity_aggregates_for_organization_request : 
  ?aws_account_ids:Types.organization_account_ids_list ->
  event_arns:Types.organization_event_arns_list ->
  unit ->
  Types.describe_entity_aggregates_for_organization_request

val make_describe_affected_entities_response : 
  ?next_token:Types.next_token ->
  ?entities:Types.entity_list ->
  unit ->
  Types.describe_affected_entities_response

val make_describe_affected_entities_request : 
  ?max_results:Types.max_results_lower_range ->
  ?next_token:Types.next_token ->
  ?locale:Types.locale ->
  filter:Types.entity_filter ->
  unit ->
  Types.describe_affected_entities_request

val make_describe_affected_entities_for_organization_response : 
  ?next_token:Types.next_token ->
  ?failed_set:Types.describe_affected_entities_for_organization_failed_set ->
  ?entities:Types.entity_list ->
  unit ->
  Types.describe_affected_entities_for_organization_response

val make_describe_affected_entities_for_organization_request : 
  ?organization_entity_account_filters:
    Types.organization_entity_account_filters_list ->
  ?max_results:Types.max_results_lower_range ->
  ?next_token:Types.next_token ->
  ?locale:Types.locale ->
  ?organization_entity_filters:Types.organization_entity_filters_list ->
  unit ->
  Types.describe_affected_entities_for_organization_request

val make_describe_affected_accounts_for_organization_response : 
  ?next_token:Types.next_token ->
  ?event_scope_code:Types.event_scope_code ->
  ?affected_accounts:Types.affected_accounts_list ->
  unit ->
  Types.describe_affected_accounts_for_organization_response

val make_describe_affected_accounts_for_organization_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  event_arn:Types.event_arn ->
  unit ->
  Types.describe_affected_accounts_for_organization_request

Operations

module DescribeAffectedAccountsForOrganization : sig ... end

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 Event.

module DescribeAffectedEntities : sig ... end

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.

module DescribeAffectedEntitiesForOrganization : sig ... end

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.

module DescribeEntityAggregates : sig ... end

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

module DescribeEntityAggregatesForOrganization : sig ... end

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.

module DescribeEventAggregates : sig ... end

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.

module DescribeEventDetails : sig ... end

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 DescribeEvents), 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 DescribeAffectedEntities operation.

module DescribeEventDetailsForOrganization : sig ... end

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 DescribeAffectedEntitiesForOrganization operation.

module DescribeEventTypes : sig ... end

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 EventType object.

module DescribeEvents : sig ... end

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 DescribeEventDetails and DescribeAffectedEntities operations.

module DescribeEventsForOrganization : sig ... end

Returns information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

module DescribeHealthServiceStatusForOrganization : sig ... end

This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.

module DisableHealthServiceAccessForOrganization : sig ... end

Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the Health User Guide.

module EnableHealthServiceAccessForOrganization : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end