Package software.amazon.awssdk.services.health

Interface HealthClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface HealthClient
extends AutoCloseable

Service client for accessing AWSHealth. This can be created using the static builder() method. 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

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static HealthClientBuilder	builder()	Create a builder that can be used to configure and create a HealthClient.
static HealthClient	create()	Create a HealthClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DescribeAffectedEntitiesResponse	describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)	Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
default DescribeEntityAggregatesResponse	describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest)	Returns the number of entities that are affected by each of the specified events.
default DescribeEventAggregatesResponse	describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest)	Returns the number of events of each event type (issue, scheduled change, and account notification).
default DescribeEventDetailsResponse	describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest)	Returns detailed information about one or more specified events.
default DescribeEventsResponse	describeEvents(DescribeEventsRequest describeEventsRequest)	Returns information about events that meet the specified filter criteria.
default DescribeEventTypesResponse	describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest)	Returns the event types that meet the specified filter criteria.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static HealthClient create()

Create a HealthClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static HealthClientBuilder builder()

Create a builder that can be used to configure and create a HealthClient.

describeAffectedEntities

default DescribeAffectedEntitiesResponse describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
                                                           throws InvalidPaginationTokenException,
                                                                  UnsupportedLocaleException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  HealthException

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:

Result of the DescribeAffectedEntities operation returned by the service.

Throws:

InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.

UnsupportedLocaleException - The specified locale is not supported.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

HealthException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeEntityAggregates

default DescribeEntityAggregatesResponse describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest)
                                                           throws SdkBaseException,
                                                                  SdkClientException,
                                                                  HealthException

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:

Result of the DescribeEntityAggregates operation returned by the service.

Throws:

SdkBaseException

SdkClientException

HealthException

See Also:

AWS API Documentation

describeEventAggregates

default DescribeEventAggregatesResponse describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest)
                                                         throws InvalidPaginationTokenException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                HealthException

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:

Result of the DescribeEventAggregates operation returned by the service.

Throws:

InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

HealthException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeEventDetails

default DescribeEventDetailsResponse describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest)
                                                   throws UnsupportedLocaleException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          HealthException

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:

Result of the DescribeEventDetails operation returned by the service.

Throws:

UnsupportedLocaleException - The specified locale is not supported.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

HealthException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeEventTypes

default DescribeEventTypesResponse describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest)
                                               throws InvalidPaginationTokenException,
                                                      UnsupportedLocaleException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      HealthException

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:

Result of the DescribeEventTypes operation returned by the service.

Throws:

InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.

UnsupportedLocaleException - The specified locale is not supported.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

HealthException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeEvents

default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest)
                                       throws InvalidPaginationTokenException,
                                              UnsupportedLocaleException,
                                              SdkBaseException,
                                              SdkClientException,
                                              HealthException

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:

Result of the DescribeEvents operation returned by the service.

Throws:

InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.

UnsupportedLocaleException - The specified locale is not supported.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

HealthException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()