Class: Aws::Health::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Health::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-health/lib/aws-sdk-health/client.rb
Overview
An API client for Health. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Health::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#describe_affected_accounts_for_organization(params = {}) ⇒ Types::DescribeAffectedAccountsForOrganizationResponse
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
-
#describe_affected_entities(params = {}) ⇒ Types::DescribeAffectedEntitiesResponse
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
-
#describe_affected_entities_for_organization(params = {}) ⇒ Types::DescribeAffectedEntitiesForOrganizationResponse
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria.
-
#describe_entity_aggregates(params = {}) ⇒ Types::DescribeEntityAggregatesResponse
Returns the number of entities that are affected by each of the specified events.
-
#describe_event_aggregates(params = {}) ⇒ Types::DescribeEventAggregatesResponse
Returns the number of events of each event type (issue, scheduled change, and account notification).
-
#describe_event_details(params = {}) ⇒ Types::DescribeEventDetailsResponse
Returns detailed information about one or more specified events.
-
#describe_event_details_for_organization(params = {}) ⇒ Types::DescribeEventDetailsForOrganizationResponse
Returns detailed information about one or more specified events for one or more accounts in your organization.
-
#describe_event_types(params = {}) ⇒ Types::DescribeEventTypesResponse
Returns the event types that meet the specified filter criteria.
-
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Returns information about events that meet the specified filter criteria.
-
#describe_events_for_organization(params = {}) ⇒ Types::DescribeEventsForOrganizationResponse
Returns information about events across your organization in AWS Organizations.
-
#describe_health_service_status_for_organization(params = {}) ⇒ Types::DescribeHealthServiceStatusForOrganizationResponse
This operation provides status information on enabling or disabling AWS Health to work with your organization.
-
#disable_health_service_access_for_organization(params = {}) ⇒ Struct
Disables AWS Health from working with AWS Organizations.
-
#enable_health_service_access_for_organization(params = {}) ⇒ Struct
Calling this operation enables AWS Health to work with AWS Organizations.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#describe_affected_accounts_for_organization(params = {}) ⇒ Types::DescribeAffectedAccountsForOrganizationResponse
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
nextToken
parameter
in the next request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
403 404 405 406 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 403 def describe_affected_accounts_for_organization(params = {}, = {}) req = build_request(:describe_affected_accounts_for_organization, params) req.send_request() end |
#describe_affected_entities(params = {}) ⇒ Types::DescribeAffectedEntitiesResponse
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required. Results are sorted by the
lastUpdatedTime
of the entity, starting with the most recent.
nextToken
parameter
in the next request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
492 493 494 495 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 492 def describe_affected_entities(params = {}, = {}) req = build_request(:describe_affected_entities, params) req.send_request() end |
#describe_affected_entities_for_organization(params = {}) ⇒ Types::DescribeAffectedEntitiesForOrganizationResponse
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.
At least one event Amazon Resource Name (ARN) and account ID are
required. Results are sorted by the lastUpdatedTime
of the entity,
starting with the most recent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
nextToken
parameter
in the next request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
585 586 587 588 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 585 def describe_affected_entities_for_organization(params = {}, = {}) req = build_request(:describe_affected_entities_for_organization, params) req.send_request() end |
#describe_entity_aggregates(params = {}) ⇒ Types::DescribeEntityAggregatesResponse
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
619 620 621 622 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 619 def describe_entity_aggregates(params = {}, = {}) req = build_request(:describe_entity_aggregates, params) req.send_request() end |
#describe_event_aggregates(params = {}) ⇒ Types::DescribeEventAggregatesResponse
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.
nextToken
parameter
in the next request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
710 711 712 713 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 710 def describe_event_aggregates(params = {}, = {}) req = build_request(:describe_event_aggregates, params) req.send_request() end |
#describe_event_details(params = {}) ⇒ Types::DescribeEventDetailsResponse
Returns detailed information about one or more specified events. Information includes standard event data (Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
777 778 779 780 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 777 def describe_event_details(params = {}, = {}) req = build_request(:describe_event_details, params) req.send_request() end |
#describe_event_details_for_organization(params = {}) ⇒ Types::DescribeEventDetailsForOrganizationResponse
Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
When you call the DescribeEventDetailsForOrganization
operation, you
specify the organizationEventDetailFilters
object in the request.
Depending on the AWS Health event type, note the following
differences:
If the event is public, the
awsAccountId
parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization.If the event is specific to an account, then you must specify the
awsAccountId
parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization.
For more information, see Event.
872 873 874 875 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 872 def describe_event_details_for_organization(params = {}, = {}) req = build_request(:describe_event_details_for_organization, params) req.send_request() end |
#describe_event_types(params = {}) ⇒ Types::DescribeEventTypesResponse
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
nextToken
parameter
in the next request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
936 937 938 939 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 936 def describe_event_types(params = {}, = {}) req = build_request(:describe_event_types, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
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.
DescribeEvents
operation and specify an entity
for the entityValues
parameter, AWS 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, AWS 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 1058 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_events_for_organization(params = {}) ⇒ Types::DescribeEventsForOrganizationResponse
Returns information about events across your organization in AWS
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 AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master AWS account.
nextToken
parameter
in the next request to return more results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 1175 def describe_events_for_organization(params = {}, = {}) req = build_request(:describe_events_for_organization, params) req.send_request() end |
#describe_health_service_status_for_organization(params = {}) ⇒ Types::DescribeHealthServiceStatusForOrganizationResponse
This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 1197 def describe_health_service_status_for_organization(params = {}, = {}) req = build_request(:describe_health_service_status_for_organization, params) req.send_request() end |
#disable_health_service_access_for_organization(params = {}) ⇒ Struct
Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master AWS account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
This operation doesn't remove the service-linked role (SLR) from the AWS master account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 1236 def disable_health_service_access_for_organization(params = {}, = {}) req = build_request(:disable_health_service_access_for_organization, params) req.send_request() end |
#enable_health_service_access_for_organization(params = {}) ⇒ Struct
Calling this operation enables AWS Health to work with AWS Organizations. This applies a service-linked role (SLR) to the master account in the organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
For more information, see Aggregating AWS Health events in the AWS Health User Guide.
1260 1261 1262 1263 |
# File 'gems/aws-sdk-health/lib/aws-sdk-health/client.rb', line 1260 def enable_health_service_access_for_organization(params = {}, = {}) req = build_request(:enable_health_service_access_for_organization, params) req.send_request() end |