paws.management (version 0.1.8)

health: AWS Health APIs and Notifications

Description

AWS Health

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

• DescribeEvents: Summary information about events.

• DescribeEventDetails: Detailed information about one or more events.

• DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.

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

• DescribeEventTypes: Information about the kinds of events that AWS Health tracks.

• DescribeEventAggregates: A count of the number of events that meet specified criteria.

• DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.

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

• DescribeEventsForOrganization: Summary information about events across the organization.

• DescribeAffectedAccountsForOrganization: List of accounts in your organization impacted by an event.

• DescribeEventDetailsForOrganization: Detailed information about events in your organization.

• DescribeAffectedEntitiesForOrganization: Information about AWS resources in your organization that are affected by events.

You can use the following operations to enable or disable AWS Health from working with AWS Organizations.

• EnableHealthServiceAccessForOrganization: Enables AWS Health to work with AWS Organizations.

• DisableHealthServiceAccessForOrganization: Disables AWS Health from working with AWS Organizations.

• DescribeHealthServiceStatusForOrganization: Status information about enabling or disabling AWS Health from working with AWS Organizations.

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

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

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

• https://health.us-east-1.amazonaws.com

Usage

health(config = list())

Arguments

config

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

Service syntax

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, meeting the specified filter criteria
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	Calling this operation disables Health from working with AWS Organizations

Examples

# NOT RUN {
svc <- health()
svc$describe_affected_accounts_for_organization(
  Foo = 123
)
# }
# NOT RUN {
# }