com.amazonaws.services.health

Interface AWSHealthAsync

All Superinterfaces:

AWSHealth

All Known Implementing Classes:

AbstractAWSHealthAsync, AWSHealthAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSHealthAsync
extends AWSHealth

Interface for accessing AWSHealth asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSHealthAsync instead.

AWS Health

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

• DescribeEvents: Summary information about events.

• DescribeEventDetails: Detailed information about one or more events.

• DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.

In addition, these operations provide information about event types and summary counts of events or affected entities:

• DescribeEventTypes: Information about the kinds of events that AWS Health tracks.

• DescribeEventAggregates: A count of the number of events that meet specified criteria.

• DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

• https://health.us-east-1.amazonaws.com

Field Summary

Fields inherited from interface com.amazonaws.services.health.AWSHealth

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DescribeAffectedEntitiesResult>	describeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest) Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
Future<DescribeAffectedEntitiesResult>	describeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest, AsyncHandler<DescribeAffectedEntitiesRequest,DescribeAffectedEntitiesResult> asyncHandler) Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
Future<DescribeEntityAggregatesResult>	describeEntityAggregatesAsync(DescribeEntityAggregatesRequest describeEntityAggregatesRequest) Returns the number of entities that are affected by each of the specified events.
Future<DescribeEntityAggregatesResult>	describeEntityAggregatesAsync(DescribeEntityAggregatesRequest describeEntityAggregatesRequest, AsyncHandler<DescribeEntityAggregatesRequest,DescribeEntityAggregatesResult> asyncHandler) Returns the number of entities that are affected by each of the specified events.
Future<DescribeEventAggregatesResult>	describeEventAggregatesAsync(DescribeEventAggregatesRequest describeEventAggregatesRequest) Returns the number of events of each event type (issue, scheduled change, and account notification).
Future<DescribeEventAggregatesResult>	describeEventAggregatesAsync(DescribeEventAggregatesRequest describeEventAggregatesRequest, AsyncHandler<DescribeEventAggregatesRequest,DescribeEventAggregatesResult> asyncHandler) Returns the number of events of each event type (issue, scheduled change, and account notification).
Future<DescribeEventDetailsResult>	describeEventDetailsAsync(DescribeEventDetailsRequest describeEventDetailsRequest) Returns detailed information about one or more specified events.
Future<DescribeEventDetailsResult>	describeEventDetailsAsync(DescribeEventDetailsRequest describeEventDetailsRequest, AsyncHandler<DescribeEventDetailsRequest,DescribeEventDetailsResult> asyncHandler) Returns detailed information about one or more specified events.
Future<DescribeEventsResult>	describeEventsAsync(DescribeEventsRequest describeEventsRequest) Returns information about events that meet the specified filter criteria.
Future<DescribeEventsResult>	describeEventsAsync(DescribeEventsRequest describeEventsRequest, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler) Returns information about events that meet the specified filter criteria.
Future<DescribeEventTypesResult>	describeEventTypesAsync(DescribeEventTypesRequest describeEventTypesRequest) Returns the event types that meet the specified filter criteria.
Future<DescribeEventTypesResult>	describeEventTypesAsync(DescribeEventTypesRequest describeEventTypesRequest, AsyncHandler<DescribeEventTypesRequest,DescribeEventTypesResult> asyncHandler) Returns the event types that meet the specified filter criteria.

Methods inherited from interface com.amazonaws.services.health.AWSHealth

describeAffectedEntities, describeEntityAggregates, describeEventAggregates, describeEventDetails, describeEvents, describeEventTypes, getCachedResponseMetadata, setEndpoint, setRegion, shutdown

Method Detail

describeAffectedEntitiesAsync

Future<DescribeAffectedEntitiesResult> describeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)

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.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

Parameters:

describeAffectedEntitiesRequest -

Returns:

A Java Future containing the result of the DescribeAffectedEntities operation returned by the service.

See Also:

AWS API Documentation

describeAffectedEntitiesAsync

Future<DescribeAffectedEntitiesResult> describeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest,
                                                                     AsyncHandler<DescribeAffectedEntitiesRequest,DescribeAffectedEntitiesResult> asyncHandler)

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.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

Parameters:

describeAffectedEntitiesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeAffectedEntities operation returned by the service.

See Also:

AWS API Documentation

describeEntityAggregatesAsync

Future<DescribeEntityAggregatesResult> describeEntityAggregatesAsync(DescribeEntityAggregatesRequest describeEntityAggregatesRequest)

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.

Parameters:

describeEntityAggregatesRequest -

Returns:

A Java Future containing the result of the DescribeEntityAggregates operation returned by the service.

See Also:

AWS API Documentation

describeEntityAggregatesAsync

Future<DescribeEntityAggregatesResult> describeEntityAggregatesAsync(DescribeEntityAggregatesRequest describeEntityAggregatesRequest,
                                                                     AsyncHandler<DescribeEntityAggregatesRequest,DescribeEntityAggregatesResult> asyncHandler)

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.

Parameters:

describeEntityAggregatesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeEntityAggregates operation returned by the service.

See Also:

AWS API Documentation

describeEventAggregatesAsync

Future<DescribeEventAggregatesResult> describeEventAggregatesAsync(DescribeEventAggregatesRequest describeEventAggregatesRequest)

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.

Parameters:

describeEventAggregatesRequest -

Returns:

A Java Future containing the result of the DescribeEventAggregates operation returned by the service.

See Also:

AWS API Documentation

describeEventAggregatesAsync

Future<DescribeEventAggregatesResult> describeEventAggregatesAsync(DescribeEventAggregatesRequest describeEventAggregatesRequest,
                                                                   AsyncHandler<DescribeEventAggregatesRequest,DescribeEventAggregatesResult> asyncHandler)

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.

Parameters:

describeEventAggregatesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeEventAggregates operation returned by the service.

See Also:

AWS API Documentation

describeEventDetailsAsync

Future<DescribeEventDetailsResult> describeEventDetailsAsync(DescribeEventDetailsRequest describeEventDetailsRequest)

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., 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 those, use the DescribeAffectedEntities operation.

If a specified event cannot be retrieved, an error message is returned for that event.

Parameters:

describeEventDetailsRequest -

Returns:

A Java Future containing the result of the DescribeEventDetails operation returned by the service.

See Also:

AWS API Documentation

describeEventDetailsAsync

Future<DescribeEventDetailsResult> describeEventDetailsAsync(DescribeEventDetailsRequest describeEventDetailsRequest,
                                                             AsyncHandler<DescribeEventDetailsRequest,DescribeEventDetailsResult> asyncHandler)

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., 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 those, use the DescribeAffectedEntities operation.

If a specified event cannot be retrieved, an error message is returned for that event.

Parameters:

describeEventDetailsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeEventDetails operation returned by the service.

See Also:

AWS API Documentation

describeEventTypesAsync

Future<DescribeEventTypesResult> describeEventTypesAsync(DescribeEventTypesRequest describeEventTypesRequest)

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.

Parameters:

describeEventTypesRequest -

Returns:

A Java Future containing the result of the DescribeEventTypes operation returned by the service.

See Also:

AWS API Documentation

describeEventTypesAsync

Future<DescribeEventTypesResult> describeEventTypesAsync(DescribeEventTypesRequest describeEventTypesRequest,
                                                         AsyncHandler<DescribeEventTypesRequest,DescribeEventTypesResult> asyncHandler)

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.

Parameters:

describeEventTypesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeEventTypes operation returned by the service.

See Also:

AWS API Documentation

describeEventsAsync

Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest)

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.

Parameters:

describeEventsRequest -

Returns:

A Java Future containing the result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeEventsAsync

Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest,
                                                 AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)

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.

Parameters:

describeEventsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation