@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSHealth extends Object implements AWSHealth
AWSHealth. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
DescribeAffectedAccountsForOrganizationResult |
describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest request)
Returns a list of accounts in the organization from Organizations that are affected by the provided event.
|
DescribeAffectedEntitiesResult |
describeAffectedEntities(DescribeAffectedEntitiesRequest request)
Returns a list of entities that have been affected by the specified events, based on the specified filter
criteria.
|
DescribeAffectedEntitiesForOrganizationResult |
describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest request)
Returns a list of entities that have been affected by one or more events for one or more accounts in your
organization in Organizations, based on the filter criteria.
|
DescribeEntityAggregatesResult |
describeEntityAggregates(DescribeEntityAggregatesRequest request)
Returns the number of entities that are affected by each of the specified events.
|
DescribeEventAggregatesResult |
describeEventAggregates(DescribeEventAggregatesRequest request)
Returns the number of events of each event type (issue, scheduled change, and account notification).
|
DescribeEventDetailsResult |
describeEventDetails(DescribeEventDetailsRequest request)
Returns detailed information about one or more specified events.
|
DescribeEventDetailsForOrganizationResult |
describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest request)
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in
your organization.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns information about events that meet the specified filter criteria.
|
DescribeEventsForOrganizationResult |
describeEventsForOrganization(DescribeEventsForOrganizationRequest request)
Returns information about events across your organization in Organizations.
|
DescribeEventTypesResult |
describeEventTypes(DescribeEventTypesRequest request)
Returns the event types that meet the specified filter criteria.
|
DescribeHealthServiceStatusForOrganizationResult |
describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest request)
This operation provides status information on enabling or disabling Health to work with your organization.
|
DisableHealthServiceAccessForOrganizationResult |
disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest request)
Disables Health from working with Organizations.
|
EnableHealthServiceAccessForOrganizationResult |
enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest request)
Enables Health to work with Organizations.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("health.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSHealth.setEndpoint(String), sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
public void setEndpoint(String endpoint)
AWSHealth
Callers can pass in just the endpoint (ex: "health.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "health.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AWSHealthendpoint - The endpoint (ex: "health.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"health.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AWSHealthAWSHealth.setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AWSHealthregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public DescribeAffectedAccountsForOrganizationResult describeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest request)
AWSHealthReturns 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.
describeAffectedAccountsForOrganization in interface AWSHealthpublic DescribeAffectedEntitiesResult describeAffectedEntities(DescribeAffectedEntitiesRequest request)
AWSHealthReturns 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 Services 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.
describeAffectedEntities in interface AWSHealthpublic DescribeAffectedEntitiesForOrganizationResult describeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest request)
AWSHealthReturns 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 Services 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.
describeAffectedEntitiesForOrganization in interface AWSHealthpublic DescribeEntityAggregatesResult describeEntityAggregates(DescribeEntityAggregatesRequest request)
AWSHealthReturns the number of entities that are affected by each of the specified events.
describeEntityAggregates in interface AWSHealthpublic DescribeEventAggregatesResult describeEventAggregates(DescribeEventAggregatesRequest request)
AWSHealthReturns 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.
describeEventAggregates in interface AWSHealthpublic DescribeEventDetailsResult describeEventDetails(DescribeEventDetailsRequest request)
AWSHealthReturns 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.
describeEventDetails in interface AWSHealthpublic DescribeEventDetailsForOrganizationResult describeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest request)
AWSHealthReturns 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.
describeEventDetailsForOrganization in interface AWSHealthpublic DescribeEventTypesResult describeEventTypes(DescribeEventTypesRequest request)
AWSHealthReturns 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 Services 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.
describeEventTypes in interface AWSHealthpublic DescribeEventsResult describeEvents(DescribeEventsRequest request)
AWSHealthReturns 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.
describeEvents in interface AWSHealthpublic DescribeEventsForOrganizationResult describeEventsForOrganization(DescribeEventsForOrganizationRequest request)
AWSHealth
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.
describeEventsForOrganization in interface AWSHealthpublic DescribeHealthServiceStatusForOrganizationResult describeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest request)
AWSHealthThis operation provides status information on enabling or disabling 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 management account.
describeHealthServiceStatusForOrganization in interface AWSHealthpublic DisableHealthServiceAccessForOrganizationResult disableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest request)
AWSHealthDisables Health from working with Organizations. To call this operation, you must sign in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. For more information, see Aggregating Health events in the Health User Guide.
This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.
disableHealthServiceAccessForOrganization in interface AWSHealthpublic EnableHealthServiceAccessForOrganizationResult enableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest request)
AWSHealthEnables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.
This operation also creates a service-linked role for the management account in the organization.
To call this operation, you must meet the following requirements:
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.
You must have permission to call this operation from the organization's management account. For example IAM policies, see Health identity-based policy examples.
If you don't have the required support plan, you can instead use the Health console to enable the organizational view feature. For more information, see Aggregating Health events in the Health User Guide.
enableHealthServiceAccessForOrganization in interface AWSHealthpublic void shutdown()
AWSHealthpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSHealthResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSHealthrequest - The originally executed request.