com.amazonaws.services.health

Class AWSHealthClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.health.AWSHealthClient

All Implemented Interfaces:

AWSHealth

Direct Known Subclasses:

AWSHealthAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSHealthClient
extends AmazonWebServiceClient
implements AWSHealth

Client for accessing AWSHealth. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSHealthClient() Deprecated. use AWSHealthClientBuilder.defaultClient()
AWSHealthClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSHealthClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSHealthClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSHealthClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSHealthClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSHealthClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSHealthClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSHealthClientBuilder	builder()
DescribeAffectedAccountsForOrganizationResult	describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest request) Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
DescribeAffectedEntitiesResult	describeAffectedEntities(DescribeAffectedEntitiesRequest request) Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
DescribeAffectedEntitiesForOrganizationResult	describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest request) 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 request) Returns the number of entities that are affected by each of the specified events.
DescribeEventAggregatesResult	describeEventAggregates(DescribeEventAggregatesRequest request) Returns the number of events of each event type (issue, scheduled change, and account notification).
DescribeEventDetailsResult	describeEventDetails(DescribeEventDetailsRequest request) Returns detailed information about one or more specified events.
DescribeEventDetailsForOrganizationResult	describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest request) Returns detailed information about one or more specified events for one or more accounts in your organization.
DescribeEventsResult	describeEvents(DescribeEventsRequest request) Returns information about events that meet the specified filter criteria.
DescribeEventsForOrganizationResult	describeEventsForOrganization(DescribeEventsForOrganizationRequest request) Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria.
DescribeEventTypesResult	describeEventTypes(DescribeEventTypesRequest request) Returns the event types that meet the specified filter criteria.
DescribeHealthServiceStatusForOrganizationResult	describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest request) This operation provides status information on enabling or disabling AWS Health to work with your organization.
DisableHealthServiceAccessForOrganizationResult	disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest request) Calling this operation disables Health from working with AWS Organizations.
EnableHealthServiceAccessForOrganizationResult	enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest request) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

setEndpoint, setRegion, shutdown

Constructor Detail

AWSHealthClient

@Deprecated
public AWSHealthClient()

Deprecated. use AWSHealthClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWSHealth. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSHealthClient

@Deprecated
public AWSHealthClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWSHealth. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSHealth (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSHealthClient

@Deprecated
public AWSHealthClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSHealthClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWSHealth using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSHealthClient

@Deprecated
public AWSHealthClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWSHealth using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSHealth (ex: proxy settings, retry counts, etc.).

AWSHealthClient

@Deprecated
public AWSHealthClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWSHealth using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSHealthClient

@Deprecated
public AWSHealthClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWSHealth using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSHealth (ex: proxy settings, retry counts, etc.).

AWSHealthClient

@Deprecated
public AWSHealthClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWSHealth using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSHealth (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSHealthClientBuilder builder()

describeAffectedAccountsForOrganization

public DescribeAffectedAccountsForOrganizationResult describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest request)

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.

Specified by:

describeAffectedAccountsForOrganization in interface AWSHealth

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

public DescribeAffectedEntitiesResult describeAffectedEntities(DescribeAffectedEntitiesRequest request)

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.

Specified by:

describeAffectedEntities in interface AWSHealth

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

public DescribeAffectedEntitiesForOrganizationResult describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest request)

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.

Specified by:

describeAffectedEntitiesForOrganization in interface AWSHealth

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

public DescribeEntityAggregatesResult describeEntityAggregates(DescribeEntityAggregatesRequest request)

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.

Specified by:

describeEntityAggregates in interface AWSHealth

Parameters:

describeEntityAggregatesRequest -

Returns:

Result of the DescribeEntityAggregates operation returned by the service.

See Also:

AWS API Documentation

describeEventAggregates

public DescribeEventAggregatesResult describeEventAggregates(DescribeEventAggregatesRequest request)

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.

Specified by:

describeEventAggregates in interface AWSHealth

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

public DescribeEventDetailsResult describeEventDetails(DescribeEventDetailsRequest request)

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.

Specified by:

describeEventDetails in interface AWSHealth

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

public DescribeEventDetailsForOrganizationResult describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest request)

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.

Specified by:

describeEventDetailsForOrganization in interface AWSHealth

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

public DescribeEventTypesResult describeEventTypes(DescribeEventTypesRequest request)

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.

Specified by:

describeEventTypes in interface AWSHealth

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

public DescribeEventsResult describeEvents(DescribeEventsRequest request)

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.

Specified by:

describeEvents in interface AWSHealth

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

public DescribeEventsForOrganizationResult describeEventsForOrganization(DescribeEventsForOrganizationRequest request)

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.

Specified by:

describeEventsForOrganization in interface AWSHealth

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

public DescribeHealthServiceStatusForOrganizationResult describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest request)

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.

Specified by:

describeHealthServiceStatusForOrganization in interface AWSHealth

Parameters:

describeHealthServiceStatusForOrganizationRequest -

Returns:

Result of the DescribeHealthServiceStatusForOrganization operation returned by the service.

See Also:

AWS API Documentation

disableHealthServiceAccessForOrganization

public DisableHealthServiceAccessForOrganizationResult disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest request)

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.

Specified by:

disableHealthServiceAccessForOrganization in interface AWSHealth

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

public EnableHealthServiceAccessForOrganizationResult enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest request)

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.

Specified by:

enableHealthServiceAccessForOrganization in interface AWSHealth

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSHealth

Parameters:

request - The originally executed request

Returns:

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