com.amazonaws.services.health

Interface AWSHealth

All Known Subinterfaces:

AWSHealthAsync

All Known Implementing Classes:

AbstractAWSHealth, AbstractAWSHealthAsync, AWSHealthAsyncClient, AWSHealthClient

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

Interface for accessing AWSHealth.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSHealth 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.

AWS Health integrates with AWS Organizations to provide a centralized view of AWS Health events across all accounts in your organization.

• DescribeEventsForOrganization: Summary information about events across the organization.

• DescribeAffectedAccountsForOrganization: List of accounts in your organization impacted by an event.

• DescribeEventDetailsForOrganization: Detailed information about events in your organization.

• DescribeAffectedEntitiesForOrganization: Information about AWS resources in your organization that are affected by events.

You can use the following operations to enable or disable AWS Health from working with AWS Organizations.

• EnableHealthServiceAccessForOrganization: Enables AWS Health to work with AWS Organizations.

• DisableHealthServiceAccessForOrganization: Disables AWS Health from working with AWS Organizations.

• DescribeHealthServiceStatusForOrganization: Status information about enabling or disabling AWS Health from working with AWS Organizations.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DescribeAffectedAccountsForOrganizationResult	describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest) Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
DescribeAffectedEntitiesResult	describeAffectedEntities(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest) Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
DescribeAffectedEntitiesForOrganizationResult	describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest) Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria.
DescribeEntityAggregatesResult	describeEntityAggregates(DescribeEntityAggregatesRequest describeEntityAggregatesRequest) Returns the number of entities that are affected by each of the specified events.
DescribeEventAggregatesResult	describeEventAggregates(DescribeEventAggregatesRequest describeEventAggregatesRequest) Returns the number of events of each event type (issue, scheduled change, and account notification).
DescribeEventDetailsResult	describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest) Returns detailed information about one or more specified events.
DescribeEventDetailsForOrganizationResult	describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest describeEventDetailsForOrganizationRequest) Returns detailed information about one or more specified events for one or more accounts in your organization.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns information about events that meet the specified filter criteria.
DescribeEventsForOrganizationResult	describeEventsForOrganization(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest) Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria.
DescribeEventTypesResult	describeEventTypes(DescribeEventTypesRequest describeEventTypesRequest) Returns the event types that meet the specified filter criteria.
DescribeHealthServiceStatusForOrganizationResult	describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest describeHealthServiceStatusForOrganizationRequest) This operation provides status information on enabling or disabling AWS Health to work with your organization.
DisableHealthServiceAccessForOrganizationResult	disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest disableHealthServiceAccessForOrganizationRequest) Calling this operation disables Health from working with AWS Organizations.
EnableHealthServiceAccessForOrganizationResult	enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest enableHealthServiceAccessForOrganizationRequest) Calling this operation enables AWS Health to work with AWS Organizations.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("health.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "health.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "health.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "health.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "health.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

describeAffectedAccountsForOrganization

DescribeAffectedAccountsForOrganizationResult describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest)

Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Parameters:

describeAffectedAccountsForOrganizationRequest -

Returns:

Result of the DescribeAffectedAccountsForOrganization operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

describeAffectedEntities

DescribeAffectedEntitiesResult describeAffectedEntities(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:

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.

See Also:

AWS API Documentation

describeAffectedEntitiesForOrganization

DescribeAffectedEntitiesForOrganizationResult describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.

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

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Parameters:

describeAffectedEntitiesForOrganizationRequest -

Returns:

Result of the DescribeAffectedEntitiesForOrganization operation returned by the service.

Throws:

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

UnsupportedLocaleException - The specified locale is not supported.

See Also:

AWS API Documentation

describeEntityAggregates

DescribeEntityAggregatesResult describeEntityAggregates(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:

Result of the DescribeEntityAggregates operation returned by the service.

See Also:

AWS API Documentation

describeEventAggregates

DescribeEventAggregatesResult describeEventAggregates(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:

Result of the DescribeEventAggregates operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

describeEventDetails

DescribeEventDetailsResult describeEventDetails(DescribeEventDetailsRequest describeEventDetailsRequest)

Returns detailed information about one or more specified events. Information includes standard event data (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 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.

See Also:

AWS API Documentation

describeEventDetailsForOrganization

DescribeEventDetailsForOrganizationResult describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest describeEventDetailsForOrganizationRequest)

Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization, 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 DescribeAffectedEntitiesForOrganization operation.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Parameters:

describeEventDetailsForOrganizationRequest -

Returns:

Result of the DescribeEventDetailsForOrganization operation returned by the service.

Throws:

UnsupportedLocaleException - The specified locale is not supported.

See Also:

AWS API Documentation

describeEventTypes

DescribeEventTypesResult describeEventTypes(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:

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.

See Also:

AWS API Documentation

describeEvents

DescribeEventsResult describeEvents(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:

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.

See Also:

AWS API Documentation

describeEventsForOrganization

DescribeEventsForOrganizationResult describeEventsForOrganization(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest)

Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria. Events are returned in a summary form and do not include the accounts impacted, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeAffectedAccountsForOrganization, DescribeEventDetailsForOrganization, and DescribeAffectedEntitiesForOrganization operations.

If no filter criteria are specified, all events across your organization are returned. Results are sorted by lastModifiedTime, starting with the most recent.

Before you can call this operation, you must first enable Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Parameters:

describeEventsForOrganizationRequest -

Returns:

Result of the DescribeEventsForOrganization operation returned by the service.

Throws:

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

UnsupportedLocaleException - The specified locale is not supported.

See Also:

AWS API Documentation

describeHealthServiceStatusForOrganization

DescribeHealthServiceStatusForOrganizationResult describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest describeHealthServiceStatusForOrganizationRequest)

This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.

Parameters:

describeHealthServiceStatusForOrganizationRequest -

Returns:

Result of the DescribeHealthServiceStatusForOrganization operation returned by the service.

See Also:

AWS API Documentation

disableHealthServiceAccessForOrganization

DisableHealthServiceAccessForOrganizationResult disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest disableHealthServiceAccessForOrganizationRequest)

Calling this operation disables Health from working with AWS Organizations. This does not remove the Service Linked Role (SLR) from the the master account in your organization. Use the IAM console, API, or AWS CLI to remove the SLR if desired. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.

Parameters:

disableHealthServiceAccessForOrganizationRequest -

Returns:

Result of the DisableHealthServiceAccessForOrganization operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

enableHealthServiceAccessForOrganization

EnableHealthServiceAccessForOrganizationResult enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest enableHealthServiceAccessForOrganizationRequest)

Calling this operation enables AWS Health to work with AWS Organizations. This applies a Service Linked Role (SLR) to the master account in the organization. To learn more about the steps in this process, visit enabling service access for AWS Health in AWS Organizations. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.

Parameters:

enableHealthServiceAccessForOrganizationRequest -

Returns:

Result of the EnableHealthServiceAccessForOrganization operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.