Module Awso_health.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule Count : sig ... end
Sourcemodule EntityStatusCode : sig ... end
Sourcemodule EventPersona : sig ... end
Sourcemodule EntityStatuses : sig ... end
Sourcemodule EventArn : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule EventTypePersona : sig ... end
Sourcemodule EventActionability : sig ... end
Sourcemodule EventPersonaList : sig ... end
Sourcemodule AvailabilityZone : sig ... end
Sourcemodule EventScopeCode : sig ... end
Sourcemodule EventStatusCode : sig ... end
Sourcemodule EventTypeCategory : sig ... end
Sourcemodule EventTypeCode : sig ... end
Sourcemodule Region : sig ... end
Sourcemodule Service : sig ... end
Sourcemodule MetadataKey : sig ... end
Sourcemodule MetadataValue : sig ... end
Sourcemodule AccountEntityAggregate : sig ... end

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

Sourcemodule EntityMetadataKey : sig ... end
Sourcemodule EntityMetadataValue : sig ... end
Sourcemodule DateTimeRange : sig ... end

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.

Sourcemodule EntityArn : sig ... end
Sourcemodule EntityValue : sig ... end
Sourcemodule TagSet : sig ... end
Sourcemodule AccountId : sig ... end
Sourcemodule EventTypeActionability : sig ... end
Sourcemodule EventTypePersonaList : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule Event : sig ... end

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.

Sourcemodule EventDescription : sig ... end

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

Sourcemodule EventMetadata : sig ... end
Sourcemodule AggregateValue : sig ... end
Sourcemodule EntityMetadata : sig ... end
Sourcemodule EntityUrl : sig ... end
Sourcemodule EntityStatusCodeList : sig ... end
Sourcemodule EventActionabilityList : sig ... end
Sourcemodule AvailabilityZones : sig ... end
Sourcemodule DateTimeRangeList : sig ... end
Sourcemodule EntityArnList : sig ... end
Sourcemodule EntityValueList : sig ... end
Sourcemodule EventArnList : sig ... end
Sourcemodule EventStatusCodeList : sig ... end
Sourcemodule RegionList : sig ... end
Sourcemodule ServiceList : sig ... end
Sourcemodule TagFilter : sig ... end
Sourcemodule OrganizationEvent : sig ... end

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

Sourcemodule AwsAccountIdsList : sig ... end
Sourcemodule EventType : sig ... end

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.

Sourcemodule EventTypeCategoryList : sig ... end
Sourcemodule EventTypeCodeList : sig ... end
Sourcemodule EventDetailsErrorItem : sig ... end

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

Sourcemodule EventDetails : sig ... end

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.

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

Sourcemodule OrganizationEventDetails : sig ... end

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.

Sourcemodule EventAccountFilter : sig ... end

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

Sourcemodule EventAggregate : sig ... end

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

Sourcemodule EntityAggregate : sig ... end

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

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.

Sourcemodule AffectedEntity : sig ... end

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

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

Sourcemodule EntityAccountFilter : sig ... end

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

Sourcemodule EventList : sig ... end
Sourcemodule InvalidPaginationToken : sig ... end

The specified pagination token (nextToken) is not valid.

Sourcemodule UnsupportedLocale : sig ... end

The specified locale is not supported.

Sourcemodule NextToken : sig ... end
Sourcemodule EventFilter : sig ... end

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

Sourcemodule Locale : sig ... end
Sourcemodule MaxResultsLowerRange : sig ... end
Sourcemodule OrganizationEventList : sig ... end
Sourcemodule OrganizationEventFilter : sig ... end

The values to filter results from the DescribeEventsForOrganization operation.

Sourcemodule EventTypeList : sig ... end
Sourcemodule EventTypeFilter : sig ... end

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

Sourcemodule MaxResults : sig ... end
Sourcemodule EventAggregateList : sig ... end
Sourcemodule EventAggregateField : sig ... end
Sourcemodule EntityAggregateList : sig ... end
Sourcemodule EventArnsList : sig ... end
Sourcemodule OrganizationEventArnsList : sig ... end
Sourcemodule EntityList : sig ... end
Sourcemodule EntityFilter : sig ... end

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

Sourcemodule AffectedAccountsList : 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.

Sourcemodule DescribeEventsResponse : 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. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Sourcemodule DescribeEventsRequest : 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. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of Health events, see Event. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of Health events, see Event. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Sourcemodule DescribeEventTypesRequest : 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. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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. If a specified event can't be retrieved, an error message is returned for that event. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

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. If a specified event can't be retrieved, an error message is returned for that event. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

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. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences: To return event details for a public event, you must specify a null value for the awsAccountId 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. To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId 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. For more information, see Event. 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 Resource- and action-based conditions in the Health User Guide.

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. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences: To return event details for a public event, you must specify a null value for the awsAccountId 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. To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId 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. For more information, see Event. 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 Resource- and action-based conditions in the Health User Guide.

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. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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

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

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

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

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. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

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. At least one event ARN is required. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

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. At least one event Amazon Resource Name (ARN) and account ID are required. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 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 Resource- and action-based conditions in the Health User Guide.

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. At least one event Amazon Resource Name (ARN) and account ID are required. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 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 Resource- and action-based conditions in the Health User Guide.

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. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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. Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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