Package software.amazon.awssdk.services.health

Interface HealthClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface HealthClient
extends AwsClient
    Service client for accessing AWSHealth. This can be created using the static builder() method. Health

    The Health API provides access to the Health information that appears in the Health Dashboard. You can use the API operations to get information about events that might affect your Amazon Web Services and resources.

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.

    For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see Best practices for managing Amazon Web Services access keys in the Amazon Web Services General Reference.

    You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Health API in the Health User Guide.

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

    If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating Health events in the Health User Guide.

    When you use the Health API operations to return Health events, see the following recommendations:

    • Use the eventScopeCode parameter to specify whether to return Health events that are public or account-specific.

    • Use pagination to view all events from the response. For example, if you call the DescribeEventsForOrganization operation to get all events in your organization, you might receive several page results. Specify the nextToken in the next request to return more results.

    • Method Detail

      • describeAffectedAccountsForOrganizationPaginator

        default DescribeAffectedAccountsForOrganizationIterable describeAffectedAccountsForOrganizationPaginator​(DescribeAffectedAccountsForOrganizationRequest describeAffectedAccountsForOrganizationRequest)
                                                                                                  throws InvalidPaginationTokenException,
                                                                                                         AwsServiceException,
                                                                                                         SdkClientException,
                                                                                                         HealthException

        Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.

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

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeAffectedAccountsForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationIterable responses = client.describeAffectedAccountsForOrganizationPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationIterable responses = client
             .describeAffectedAccountsForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedAccountsForOrganizationIterable responses = client.describeAffectedAccountsForOrganizationPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeAffectedAccountsForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationRequest) operation.

        Parameters:
        describeAffectedAccountsForOrganizationRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeAffectedEntities

        default DescribeAffectedEntitiesResponse describeAffectedEntities​(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
                                                           throws InvalidPaginationTokenException,
                                                                  UnsupportedLocaleException,
                                                                  AwsServiceException,
                                                                  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 Amazon Web 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.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        • This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

        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.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeAffectedEntitiesPaginator

        default DescribeAffectedEntitiesIterable describeAffectedEntitiesPaginator​(DescribeAffectedEntitiesRequest describeAffectedEntitiesRequest)
                                                                    throws InvalidPaginationTokenException,
                                                                           UnsupportedLocaleException,
                                                                           AwsServiceException,
                                                                           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 Amazon Web 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.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        • This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.


        This is a variant of describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client
             .describeAffectedEntitiesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest) operation.

        Parameters:
        describeAffectedEntitiesRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeAffectedEntitiesPaginator

        default DescribeAffectedEntitiesIterable describeAffectedEntitiesPaginator​(Consumer<DescribeAffectedEntitiesRequest.Builder> describeAffectedEntitiesRequest)
                                                                    throws InvalidPaginationTokenException,
                                                                           UnsupportedLocaleException,
                                                                           AwsServiceException,
                                                                           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 Amazon Web 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.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        • This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.


        This is a variant of describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client
             .describeAffectedEntitiesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesIterable responses = client.describeAffectedEntitiesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeAffectedEntities(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesRequest) operation.

        This is a convenience which creates an instance of the DescribeAffectedEntitiesRequest.Builder avoiding the need to create one manually via DescribeAffectedEntitiesRequest.builder()

        Parameters:
        describeAffectedEntitiesRequest - A Consumer that will call methods on DescribeAffectedEntitiesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeAffectedEntitiesForOrganization

        default DescribeAffectedEntitiesForOrganizationResponse describeAffectedEntitiesForOrganization​(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)
                                                                                         throws InvalidPaginationTokenException,
                                                                                                UnsupportedLocaleException,
                                                                                                AwsServiceException,
                                                                                                SdkClientException,
                                                                                                HealthException

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

        At least one event Amazon Resource Name (ARN) and account ID are required.

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

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        • This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

        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.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeAffectedEntitiesForOrganizationPaginator

        default DescribeAffectedEntitiesForOrganizationIterable describeAffectedEntitiesForOrganizationPaginator​(DescribeAffectedEntitiesForOrganizationRequest describeAffectedEntitiesForOrganizationRequest)
                                                                                                  throws InvalidPaginationTokenException,
                                                                                                         UnsupportedLocaleException,
                                                                                                         AwsServiceException,
                                                                                                         SdkClientException,
                                                                                                         HealthException

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

        At least one event Amazon Resource Name (ARN) and account ID are required.

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

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        • This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.


        This is a variant of describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationIterable responses = client.describeAffectedEntitiesForOrganizationPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationIterable responses = client
             .describeAffectedEntitiesForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationIterable responses = client.describeAffectedEntitiesForOrganizationPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest) operation.

        Parameters:
        describeAffectedEntitiesForOrganizationRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeAffectedEntitiesForOrganizationPaginator

        default DescribeAffectedEntitiesForOrganizationIterable describeAffectedEntitiesForOrganizationPaginator​(Consumer<DescribeAffectedEntitiesForOrganizationRequest.Builder> describeAffectedEntitiesForOrganizationRequest)
                                                                                                  throws InvalidPaginationTokenException,
                                                                                                         UnsupportedLocaleException,
                                                                                                         AwsServiceException,
                                                                                                         SdkClientException,
                                                                                                         HealthException

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

        At least one event Amazon Resource Name (ARN) and account ID are required.

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

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        • This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.


        This is a variant of describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationIterable responses = client.describeAffectedEntitiesForOrganizationPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationIterable responses = client
             .describeAffectedEntitiesForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeAffectedEntitiesForOrganizationIterable responses = client.describeAffectedEntitiesForOrganizationPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeAffectedEntitiesForOrganization(software.amazon.awssdk.services.health.model.DescribeAffectedEntitiesForOrganizationRequest) operation.

        This is a convenience which creates an instance of the DescribeAffectedEntitiesForOrganizationRequest.Builder avoiding the need to create one manually via DescribeAffectedEntitiesForOrganizationRequest.builder()

        Parameters:
        describeAffectedEntitiesForOrganizationRequest - A Consumer that will call methods on DescribeAffectedEntitiesForOrganizationRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventAggregatesPaginator

        default DescribeEventAggregatesIterable describeEventAggregatesPaginator​(DescribeEventAggregatesRequest describeEventAggregatesRequest)
                                                                  throws InvalidPaginationTokenException,
                                                                         AwsServiceException,
                                                                         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.

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client
             .describeEventAggregatesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest) operation.

        Parameters:
        describeEventAggregatesRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventAggregatesPaginator

        default DescribeEventAggregatesIterable describeEventAggregatesPaginator​(Consumer<DescribeEventAggregatesRequest.Builder> describeEventAggregatesRequest)
                                                                  throws InvalidPaginationTokenException,
                                                                         AwsServiceException,
                                                                         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.

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client
             .describeEventAggregatesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventAggregatesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventAggregatesIterable responses = client.describeEventAggregatesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventAggregates(software.amazon.awssdk.services.health.model.DescribeEventAggregatesRequest) operation.

        This is a convenience which creates an instance of the DescribeEventAggregatesRequest.Builder avoiding the need to create one manually via DescribeEventAggregatesRequest.builder()

        Parameters:
        describeEventAggregatesRequest - A Consumer that will call methods on DescribeEventAggregatesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventDetails

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

        Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services 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 the entities, use the DescribeAffectedEntities operation.

        If a specified event can't be retrieved, an error message is returned for that event.

        This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

        Parameters:
        describeEventDetailsRequest -
        Returns:
        Result of the DescribeEventDetails operation returned by the service.
        Throws:
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventDetailsForOrganization

        default DescribeEventDetailsForOrganizationResponse describeEventDetailsForOrganization​(DescribeEventDetailsForOrganizationRequest describeEventDetailsForOrganizationRequest)
                                                                                 throws UnsupportedLocaleException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        HealthException

        Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

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

        When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

        • To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.

        • To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

        For more information, see Event.

        This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

        Parameters:
        describeEventDetailsForOrganizationRequest -
        Returns:
        Result of the DescribeEventDetailsForOrganization operation returned by the service.
        Throws:
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventDetailsForOrganization

        default DescribeEventDetailsForOrganizationResponse describeEventDetailsForOrganization​(Consumer<DescribeEventDetailsForOrganizationRequest.Builder> describeEventDetailsForOrganizationRequest)
                                                                                 throws UnsupportedLocaleException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        HealthException

        Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

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

        When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

        • To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.

        • To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

        For more information, see Event.

        This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.


        This is a convenience which creates an instance of the DescribeEventDetailsForOrganizationRequest.Builder avoiding the need to create one manually via DescribeEventDetailsForOrganizationRequest.builder()

        Parameters:
        describeEventDetailsForOrganizationRequest - A Consumer that will call methods on DescribeEventDetailsForOrganizationRequest.Builder to create a request.
        Returns:
        Result of the DescribeEventDetailsForOrganization operation returned by the service.
        Throws:
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventTypesPaginator

        default DescribeEventTypesIterable describeEventTypesPaginator()
                                                        throws InvalidPaginationTokenException,
                                                               UnsupportedLocaleException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               HealthException

        Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.

        If you don't specify a filter criteria, the API operation returns all event types, in no particular order.

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client
             .describeEventTypesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation.

        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        describeEventTypesPaginator(DescribeEventTypesRequest), AWS API Documentation

      • describeEventTypesPaginator

        default DescribeEventTypesIterable describeEventTypesPaginator​(DescribeEventTypesRequest describeEventTypesRequest)
                                                        throws InvalidPaginationTokenException,
                                                               UnsupportedLocaleException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               HealthException

        Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.

        If you don't specify a filter criteria, the API operation returns all event types, in no particular order.

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client
             .describeEventTypesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation.

        Parameters:
        describeEventTypesRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventTypesPaginator

        default DescribeEventTypesIterable describeEventTypesPaginator​(Consumer<DescribeEventTypesRequest.Builder> describeEventTypesRequest)
                                                        throws InvalidPaginationTokenException,
                                                               UnsupportedLocaleException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               HealthException

        Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.

        If you don't specify a filter criteria, the API operation returns all event types, in no particular order.

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client
             .describeEventTypesPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventTypesResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventTypesIterable responses = client.describeEventTypesPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventTypes(software.amazon.awssdk.services.health.model.DescribeEventTypesRequest) operation.

        This is a convenience which creates an instance of the DescribeEventTypesRequest.Builder avoiding the need to create one manually via DescribeEventTypesRequest.builder()

        Parameters:
        describeEventTypesRequest - A Consumer that will call methods on DescribeEventTypesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEvents

        default DescribeEventsResponse describeEvents​(DescribeEventsRequest describeEventsRequest)
                                       throws InvalidPaginationTokenException,
                                              UnsupportedLocaleException,
                                              AwsServiceException,
                                              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 event.

        • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        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.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEvents

        default DescribeEventsResponse describeEvents​(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
                                       throws InvalidPaginationTokenException,
                                              UnsupportedLocaleException,
                                              AwsServiceException,
                                              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 event.

        • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

        Parameters:
        describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request.
        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.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEvents

        default DescribeEventsResponse describeEvents()
                                       throws InvalidPaginationTokenException,
                                              UnsupportedLocaleException,
                                              AwsServiceException,
                                              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 event.

        • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

        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.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        describeEvents(DescribeEventsRequest), AWS API Documentation

      • describeEventsPaginator

        default DescribeEventsIterable describeEventsPaginator()
                                                throws InvalidPaginationTokenException,
                                                       UnsupportedLocaleException,
                                                       AwsServiceException,
                                                       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 event.

        • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation.

        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        describeEventsPaginator(DescribeEventsRequest), AWS API Documentation

      • describeEventsPaginator

        default DescribeEventsIterable describeEventsPaginator​(DescribeEventsRequest describeEventsRequest)
                                                throws InvalidPaginationTokenException,
                                                       UnsupportedLocaleException,
                                                       AwsServiceException,
                                                       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 event.

        • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation.

        Parameters:
        describeEventsRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventsPaginator

        default DescribeEventsIterable describeEventsPaginator​(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
                                                throws InvalidPaginationTokenException,
                                                       UnsupportedLocaleException,
                                                       AwsServiceException,
                                                       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 event.

        • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

        • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.health.model.DescribeEventsRequest) operation.

        This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

        Parameters:
        describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventsForOrganizationPaginator

        default DescribeEventsForOrganizationIterable describeEventsForOrganizationPaginator​(DescribeEventsForOrganizationRequest describeEventsForOrganizationRequest)
                                                                              throws InvalidPaginationTokenException,
                                                                                     UnsupportedLocaleException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     HealthException

        Returns information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

        If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.

        For more information about the different types of Health events, see Event.

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

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationIterable responses = client.describeEventsForOrganizationPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationIterable responses = client
             .describeEventsForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationIterable responses = client.describeEventsForOrganizationPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest) operation.

        Parameters:
        describeEventsForOrganizationRequest -
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation

      • describeEventsForOrganizationPaginator

        default DescribeEventsForOrganizationIterable describeEventsForOrganizationPaginator​(Consumer<DescribeEventsForOrganizationRequest.Builder> describeEventsForOrganizationRequest)
                                                                              throws InvalidPaginationTokenException,
                                                                                     UnsupportedLocaleException,
                                                                                     AwsServiceException,
                                                                                     SdkClientException,
                                                                                     HealthException

        Returns information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

        If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.

        For more information about the different types of Health events, see Event.

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

        This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.


        This is a variant of describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationIterable responses = client.describeEventsForOrganizationPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationIterable responses = client
             .describeEventsForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.health.paginators.DescribeEventsForOrganizationIterable responses = client.describeEventsForOrganizationPaginator(request);
 responses.iterator().forEachRemaining(....);

        Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeEventsForOrganization(software.amazon.awssdk.services.health.model.DescribeEventsForOrganizationRequest) operation.

        This is a convenience which creates an instance of the DescribeEventsForOrganizationRequest.Builder avoiding the need to create one manually via DescribeEventsForOrganizationRequest.builder()

        Parameters:
        describeEventsForOrganizationRequest - A Consumer that will call methods on DescribeEventsForOrganizationRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        InvalidPaginationTokenException - The specified pagination token (nextToken) is not valid.
        UnsupportedLocaleException - The specified locale is not supported.
        SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation