All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.health.AWSHealthAsync Maven / Gradle / Ivy

/*
 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.health;

import javax.annotation.Generated;

import com.amazonaws.services.health.model.*;

/**
 * Interface for accessing AWSHealth asynchronously. Each asynchronous method will return a Java Future object
 * representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.health.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: *

* *

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

* *

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

* *

* You can use the following operations to enable or disable 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 *

    *
  • *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSHealthAsync extends AWSHealth { /** *

* 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. *

* * @param describeAffectedAccountsForOrganizationRequest * @return A Java Future containing the result of the DescribeAffectedAccountsForOrganization operation returned by * the service. * @sample AWSHealthAsync.DescribeAffectedAccountsForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeAffectedAccountsForOrganizationAsync( 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. *

* * @param describeAffectedAccountsForOrganizationRequest * @param 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. * @return A Java Future containing the result of the DescribeAffectedAccountsForOrganization operation returned by * the service. * @sample AWSHealthAsyncHandler.DescribeAffectedAccountsForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeAffectedAccountsForOrganizationAsync( DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param describeAffectedEntitiesRequest * @return A Java Future containing the result of the DescribeAffectedEntities operation returned by the service. * @sample AWSHealthAsync.DescribeAffectedEntities * @see AWS API Documentation */ java.util.concurrent.Future 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. *

* * @param describeAffectedEntitiesRequest * @param 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. * @return A Java Future containing the result of the DescribeAffectedEntities operation returned by the service. * @sample AWSHealthAsyncHandler.DescribeAffectedEntities * @see AWS API Documentation */ java.util.concurrent.Future describeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeAffectedEntitiesForOrganizationRequest * @return A Java Future containing the result of the DescribeAffectedEntitiesForOrganization operation returned by * the service. * @sample AWSHealthAsync.DescribeAffectedEntitiesForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeAffectedEntitiesForOrganizationAsync( 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. *

* * @param describeAffectedEntitiesForOrganizationRequest * @param 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. * @return A Java Future containing the result of the DescribeAffectedEntitiesForOrganization operation returned by * the service. * @sample AWSHealthAsyncHandler.DescribeAffectedEntitiesForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeAffectedEntitiesForOrganizationAsync( DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param describeEntityAggregatesRequest * @return A Java Future containing the result of the DescribeEntityAggregates operation returned by the service. * @sample AWSHealthAsync.DescribeEntityAggregates * @see AWS API Documentation */ java.util.concurrent.Future 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. *

* * @param describeEntityAggregatesRequest * @param 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. * @return A Java Future containing the result of the DescribeEntityAggregates operation returned by the service. * @sample AWSHealthAsyncHandler.DescribeEntityAggregates * @see AWS API Documentation */ java.util.concurrent.Future describeEntityAggregatesAsync(DescribeEntityAggregatesRequest describeEntityAggregatesRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param describeEventAggregatesRequest * @return A Java Future containing the result of the DescribeEventAggregates operation returned by the service. * @sample AWSHealthAsync.DescribeEventAggregates * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param describeEventAggregatesRequest * @param 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. * @return A Java Future containing the result of the DescribeEventAggregates operation returned by the service. * @sample AWSHealthAsyncHandler.DescribeEventAggregates * @see AWS * API Documentation */ java.util.concurrent.Future describeEventAggregatesAsync(DescribeEventAggregatesRequest describeEventAggregatesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeEventDetailsRequest * @return A Java Future containing the result of the DescribeEventDetails operation returned by the service. * @sample AWSHealthAsync.DescribeEventDetails * @see AWS * API Documentation */ java.util.concurrent.Future describeEventDetailsAsync(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. *

* * @param describeEventDetailsRequest * @param 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. * @return A Java Future containing the result of the DescribeEventDetails operation returned by the service. * @sample AWSHealthAsyncHandler.DescribeEventDetails * @see AWS * API Documentation */ java.util.concurrent.Future describeEventDetailsAsync(DescribeEventDetailsRequest describeEventDetailsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeEventDetailsForOrganizationRequest * @return A Java Future containing the result of the DescribeEventDetailsForOrganization operation returned by the * service. * @sample AWSHealthAsync.DescribeEventDetailsForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeEventDetailsForOrganizationAsync( 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. *

* * @param describeEventDetailsForOrganizationRequest * @param 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. * @return A Java Future containing the result of the DescribeEventDetailsForOrganization operation returned by the * service. * @sample AWSHealthAsyncHandler.DescribeEventDetailsForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeEventDetailsForOrganizationAsync( DescribeEventDetailsForOrganizationRequest describeEventDetailsForOrganizationRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param describeEventTypesRequest * @return A Java Future containing the result of the DescribeEventTypes operation returned by the service. * @sample AWSHealthAsync.DescribeEventTypes * @see AWS API * Documentation */ java.util.concurrent.Future 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. *

* * @param describeEventTypesRequest * @param 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. * @return A Java Future containing the result of the DescribeEventTypes operation returned by the service. * @sample AWSHealthAsyncHandler.DescribeEventTypes * @see AWS API * Documentation */ java.util.concurrent.Future describeEventTypesAsync(DescribeEventTypesRequest describeEventTypesRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param describeEventsRequest * @return A Java Future containing the result of the DescribeEvents operation returned by the service. * @sample AWSHealthAsync.DescribeEvents * @see AWS API * Documentation */ java.util.concurrent.Future 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. *

* * @param describeEventsRequest * @param 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. * @return A Java Future containing the result of the DescribeEvents operation returned by the service. * @sample AWSHealthAsyncHandler.DescribeEvents * @see AWS API * Documentation */ java.util.concurrent.Future describeEventsAsync(DescribeEventsRequest describeEventsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeEventsForOrganizationRequest * @return A Java Future containing the result of the DescribeEventsForOrganization operation returned by the * service. * @sample AWSHealthAsync.DescribeEventsForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeEventsForOrganizationAsync( 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. *

* * @param describeEventsForOrganizationRequest * @param 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. * @return A Java Future containing the result of the DescribeEventsForOrganization operation returned by the * service. * @sample AWSHealthAsyncHandler.DescribeEventsForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeEventsForOrganizationAsync( DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeHealthServiceStatusForOrganizationRequest * @return A Java Future containing the result of the DescribeHealthServiceStatusForOrganization operation returned * by the service. * @sample AWSHealthAsync.DescribeHealthServiceStatusForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeHealthServiceStatusForOrganizationAsync( 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. *

* * @param describeHealthServiceStatusForOrganizationRequest * @param 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. * @return A Java Future containing the result of the DescribeHealthServiceStatusForOrganization operation returned * by the service. * @sample AWSHealthAsyncHandler.DescribeHealthServiceStatusForOrganization * @see AWS API Documentation */ java.util.concurrent.Future describeHealthServiceStatusForOrganizationAsync( DescribeHealthServiceStatusForOrganizationRequest describeHealthServiceStatusForOrganizationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param disableHealthServiceAccessForOrganizationRequest * @return A Java Future containing the result of the DisableHealthServiceAccessForOrganization operation returned * by the service. * @sample AWSHealthAsync.DisableHealthServiceAccessForOrganization * @see AWS API Documentation */ java.util.concurrent.Future disableHealthServiceAccessForOrganizationAsync( 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. *

* * @param disableHealthServiceAccessForOrganizationRequest * @param 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. * @return A Java Future containing the result of the DisableHealthServiceAccessForOrganization operation returned * by the service. * @sample AWSHealthAsyncHandler.DisableHealthServiceAccessForOrganization * @see AWS API Documentation */ java.util.concurrent.Future disableHealthServiceAccessForOrganizationAsync( DisableHealthServiceAccessForOrganizationRequest disableHealthServiceAccessForOrganizationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param enableHealthServiceAccessForOrganizationRequest * @return A Java Future containing the result of the EnableHealthServiceAccessForOrganization operation returned by * the service. * @sample AWSHealthAsync.EnableHealthServiceAccessForOrganization * @see AWS API Documentation */ java.util.concurrent.Future enableHealthServiceAccessForOrganizationAsync( 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. *

* * @param enableHealthServiceAccessForOrganizationRequest * @param 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. * @return A Java Future containing the result of the EnableHealthServiceAccessForOrganization operation returned by * the service. * @sample AWSHealthAsyncHandler.EnableHealthServiceAccessForOrganization * @see AWS API Documentation */ java.util.concurrent.Future enableHealthServiceAccessForOrganizationAsync( EnableHealthServiceAccessForOrganizationRequest enableHealthServiceAccessForOrganizationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy