health: AWS Health APIs and Notifications

Description Usage Arguments Value Service syntax Operations Examples

View source: R/health_service.R

Description

AWS Health

The AWS Health API provides programmatic access to the AWS Health information that appears in the AWS Personal Health Dashboard. You can use the API operations to get information about AWS Health events that affect your AWS services and resources.

You must have a Business or Enterprise support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise support plan, you receive a SubscriptionRequiredException error.

AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this endpoint to call the AWS Health API operations.

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

If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS 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 AWS Health events in the AWS Health User Guide.

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

Usage

1
health(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- health(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

describe_affected_accounts_for_organization Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event
describe_affected_entities Returns a list of entities that have been affected by the specified events, based on the specified filter criteria
describe_affected_entities_for_organization 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 Returns the number of entities that are affected by each of the specified events
describe_event_aggregates Returns the number of events of each event type (issue, scheduled change, and account notification)
describe_event_details Returns detailed information about one or more specified events
describe_event_details_for_organization Returns detailed information about one or more specified events for one or more accounts in your organization
describe_events Returns information about events that meet the specified filter criteria
describe_events_for_organization Returns information about events across your organization in AWS Organizations
describe_event_types Returns the event types that meet the specified filter criteria
describe_health_service_status_for_organization This operation provides status information on enabling or disabling AWS Health to work with your organization
disable_health_service_access_for_organization Disables AWS Health from working with AWS Organizations
enable_health_service_access_for_organization Calling this operation enables AWS Health to work with AWS Organizations

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- health()
svc$describe_affected_accounts_for_organization(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.