You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Health::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Health::Client

show all

Defined in:: (unknown)

Overview

An API client for AWS Health APIs and Notifications. To construct a client, you need to configure a :region and :credentials.

health = Aws::Health::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Health::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::Health::Client constructor
Constructs an API client.

API Operations collapse

#describe_affected_accounts_for_organization(options = {}) ⇒ Types::DescribeAffectedAccountsForOrganizationResponse
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
#describe_affected_entities(options = {}) ⇒ 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(options = {}) ⇒ 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(options = {}) ⇒ Types::DescribeEntityAggregatesResponse
Returns the number of entities that are affected by each of the specified events.
#describe_event_aggregates(options = {}) ⇒ Types::DescribeEventAggregatesResponse
Returns the number of events of each event type (issue, scheduled change, and account notification).
#describe_event_details(options = {}) ⇒ Types::DescribeEventDetailsResponse
Returns detailed information about one or more specified events.
#describe_event_details_for_organization(options = {}) ⇒ Types::DescribeEventDetailsForOrganizationResponse
Returns detailed information about one or more specified events for one or more accounts in your organization.
#describe_event_types(options = {}) ⇒ Types::DescribeEventTypesResponse
Returns the event types that meet the specified filter criteria.
#describe_events(options = {}) ⇒ Types::DescribeEventsResponse
Returns information about events that meet the specified filter criteria.
#describe_events_for_organization(options = {}) ⇒ Types::DescribeEventsForOrganizationResponse
Returns information about events across your organization in AWS Organizations.
#describe_health_service_status_for_organization(options = {}) ⇒ Types::DescribeHealthServiceStatusForOrganizationResponse
This operation provides status information on enabling or disabling AWS Health to work with your organization.
#disable_health_service_access_for_organization(options = {}) ⇒ Struct
Disables AWS Health from working with AWS Organizations.
#enable_health_service_access_for_organization(options = {}) ⇒ Struct
Calling this operation enables AWS Health to work with AWS Organizations.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::Health::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#describe_affected_accounts_for_organization(options = {}) ⇒ `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.

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

Examples:

Request syntax with placeholder values


resp = client.describe_affected_accounts_for_organization({
  event_arn: "eventArn", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.affected_accounts #=> Array
resp.affected_accounts[0] #=> String
resp.event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
resp.next_token #=> String

Options Hash (options):

:event_arn (required, String) —
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID. Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.

Returns:

(Types::DescribeAffectedAccountsForOrganizationResponse) —
Returns a response object which responds to the following methods:
- #affected_accounts => Array<String>
- #event_scope_code => String
- #next_token => String

See Also:

AWS API Documentation

#describe_affected_entities(options = {}) ⇒ `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.

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

Examples:

Request syntax with placeholder values


resp = client.describe_affected_entities({
  filter: { # required
    event_arns: ["eventArn"], # required
    entity_arns: ["entityArn"],
    entity_values: ["entityValue"],
    last_updated_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    tags: [
      {
        "tagKey" => "tagValue",
      },
    ],
    status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
  },
  locale: "locale",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.entities #=> Array
resp.entities[0].entity_arn #=> String
resp.entities[0].event_arn #=> String
resp.entities[0].entity_value #=> String
resp.entities[0].entity_url #=> String
resp.entities[0].aws_account_id #=> String
resp.entities[0].last_updated_time #=> Time
resp.entities[0].status_code #=> String, one of "IMPAIRED", "UNIMPAIRED", "UNKNOWN"
resp.entities[0].tags #=> Hash
resp.entities[0].tags["tagKey"] #=> String
resp.next_token #=> String

Options Hash (options):

:filter (required, Types::EntityFilter) —
Values to narrow the results returned. At least one event ARN is required.
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.

Returns:

(Types::DescribeAffectedEntitiesResponse) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::AffectedEntity>
- #next_token => String

See Also:

AWS API Documentation

#describe_affected_entities_for_organization(options = {}) ⇒ `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.

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

Examples:

Request syntax with placeholder values


resp = client.describe_affected_entities_for_organization({
  organization_entity_filters: [ # required
    {
      event_arn: "eventArn", # required
      aws_account_id: "accountId",
    },
  ],
  locale: "locale",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.entities #=> Array
resp.entities[0].entity_arn #=> String
resp.entities[0].event_arn #=> String
resp.entities[0].entity_value #=> String
resp.entities[0].entity_url #=> String
resp.entities[0].aws_account_id #=> String
resp.entities[0].last_updated_time #=> Time
resp.entities[0].status_code #=> String, one of "IMPAIRED", "UNIMPAIRED", "UNKNOWN"
resp.entities[0].tags #=> Hash
resp.entities[0].tags["tagKey"] #=> String
resp.failed_set #=> Array
resp.failed_set[0].aws_account_id #=> String
resp.failed_set[0].event_arn #=> String
resp.failed_set[0].error_name #=> String
resp.failed_set[0].error_message #=> String
resp.next_token #=> String

Options Hash (options):

:organization_entity_filters (required, Array<Types::EventAccountFilter>) —
A JSON set of elements including the awsAccountId and the eventArn.
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.

Returns:

(Types::DescribeAffectedEntitiesForOrganizationResponse) —
Returns a response object which responds to the following methods:
- #entities => Array<Types::AffectedEntity>
- #failed_set => Array<Types::OrganizationAffectedEntitiesErrorItem>
- #next_token => String

See Also:

AWS API Documentation

#describe_entity_aggregates(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_entity_aggregates({
  event_arns: ["eventArn"],
})

Response structure


resp.entity_aggregates #=> Array
resp.entity_aggregates[0].event_arn #=> String
resp.entity_aggregates[0].count #=> Integer

Options Hash (options):

:event_arns (Array<String>) —
A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Returns:

(Types::DescribeEntityAggregatesResponse) —
Returns a response object which responds to the following methods:
- #entity_aggregates => Array<Types::EntityAggregate>

See Also:

AWS API Documentation

#describe_event_aggregates(options = {}) ⇒ `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.

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

Examples:

Request syntax with placeholder values


resp = client.describe_event_aggregates({
  filter: {
    event_arns: ["eventArn"],
    event_type_codes: ["eventType"],
    services: ["service"],
    regions: ["region"],
    availability_zones: ["availabilityZone"],
    start_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    end_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    last_updated_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    entity_arns: ["entityArn"],
    entity_values: ["entityValue"],
    event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
    tags: [
      {
        "tagKey" => "tagValue",
      },
    ],
    event_status_codes: ["open"], # accepts open, closed, upcoming
  },
  aggregate_field: "eventTypeCategory", # required, accepts eventTypeCategory
  max_results: 1,
  next_token: "nextToken",
})

Response structure


resp.event_aggregates #=> Array
resp.event_aggregates[0].aggregate_value #=> String
resp.event_aggregates[0].count #=> Integer
resp.next_token #=> String

Options Hash (options):

:filter (Types::EventFilter) —
Values to narrow the results returned.
:aggregate_field (required, String) —
The only currently supported value is eventTypeCategory.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

(Types::DescribeEventAggregatesResponse) —
Returns a response object which responds to the following methods:
- #event_aggregates => Array<Types::EventAggregate>
- #next_token => String

See Also:

AWS API Documentation

#describe_event_details(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_event_details({
  event_arns: ["eventArn"], # required
  locale: "locale",
})

Response structure


resp.successful_set #=> Array
resp.successful_set[0].event.arn #=> String
resp.successful_set[0].event.service #=> String
resp.successful_set[0].event.event_type_code #=> String
resp.successful_set[0].event.event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
resp.successful_set[0].event.region #=> String
resp.successful_set[0].event.availability_zone #=> String
resp.successful_set[0].event.start_time #=> Time
resp.successful_set[0].event.end_time #=> Time
resp.successful_set[0].event.last_updated_time #=> Time
resp.successful_set[0].event.status_code #=> String, one of "open", "closed", "upcoming"
resp.successful_set[0].event.event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
resp.successful_set[0].event_description.latest_description #=> String
resp.successful_set[0].event_metadata #=> Hash
resp.successful_set[0].event_metadata["metadataKey"] #=> String
resp.failed_set #=> Array
resp.failed_set[0].event_arn #=> String
resp.failed_set[0].error_name #=> String
resp.failed_set[0].error_message #=> String

Options Hash (options):

:event_arns (required, Array<String>) —
A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Returns:

(Types::DescribeEventDetailsResponse) —
Returns a response object which responds to the following methods:
- #successful_set => Array<Types::EventDetails>
- #failed_set => Array<Types::EventDetailsErrorItem>

See Also:

AWS API Documentation

#describe_event_details_for_organization(options = {}) ⇒ `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.

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.

Examples:

Request syntax with placeholder values


resp = client.describe_event_details_for_organization({
  organization_event_detail_filters: [ # required
    {
      event_arn: "eventArn", # required
      aws_account_id: "accountId",
    },
  ],
  locale: "locale",
})

Response structure


resp.successful_set #=> Array
resp.successful_set[0].aws_account_id #=> String
resp.successful_set[0].event.arn #=> String
resp.successful_set[0].event.service #=> String
resp.successful_set[0].event.event_type_code #=> String
resp.successful_set[0].event.event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
resp.successful_set[0].event.region #=> String
resp.successful_set[0].event.availability_zone #=> String
resp.successful_set[0].event.start_time #=> Time
resp.successful_set[0].event.end_time #=> Time
resp.successful_set[0].event.last_updated_time #=> Time
resp.successful_set[0].event.status_code #=> String, one of "open", "closed", "upcoming"
resp.successful_set[0].event.event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
resp.successful_set[0].event_description.latest_description #=> String
resp.successful_set[0].event_metadata #=> Hash
resp.successful_set[0].event_metadata["metadataKey"] #=> String
resp.failed_set #=> Array
resp.failed_set[0].aws_account_id #=> String
resp.failed_set[0].event_arn #=> String
resp.failed_set[0].error_name #=> String
resp.failed_set[0].error_message #=> String

Options Hash (options):

:organization_event_detail_filters (required, Array<Types::EventAccountFilter>) —
A set of JSON elements that includes the awsAccountId and the eventArn.
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Returns:

(Types::DescribeEventDetailsForOrganizationResponse) —
Returns a response object which responds to the following methods:
- #successful_set => Array<Types::OrganizationEventDetails>
- #failed_set => Array<Types::OrganizationEventDetailsErrorItem>

See Also:

AWS API Documentation

#describe_event_types(options = {}) ⇒ `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.

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

Examples:

Request syntax with placeholder values


resp = client.describe_event_types({
  filter: {
    event_type_codes: ["eventTypeCode"],
    services: ["service"],
    event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
  },
  locale: "locale",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.event_types #=> Array
resp.event_types[0].service #=> String
resp.event_types[0].code #=> String
resp.event_types[0].category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
resp.next_token #=> String

Options Hash (options):

:filter (Types::EventTypeFilter) —
Values to narrow the results returned.
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.

Returns:

(Types::DescribeEventTypesResponse) —
Returns a response object which responds to the following methods:
- #event_types => Array<Types::EventType>
- #next_token => String

See Also:

AWS API Documentation

#describe_events(options = {}) ⇒ `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.

When you call the 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.

Examples:

Request syntax with placeholder values


resp = client.describe_events({
  filter: {
    event_arns: ["eventArn"],
    event_type_codes: ["eventType"],
    services: ["service"],
    regions: ["region"],
    availability_zones: ["availabilityZone"],
    start_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    end_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    last_updated_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    entity_arns: ["entityArn"],
    entity_values: ["entityValue"],
    event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
    tags: [
      {
        "tagKey" => "tagValue",
      },
    ],
    event_status_codes: ["open"], # accepts open, closed, upcoming
  },
  next_token: "nextToken",
  max_results: 1,
  locale: "locale",
})

Response structure


resp.events #=> Array
resp.events[0].arn #=> String
resp.events[0].service #=> String
resp.events[0].event_type_code #=> String
resp.events[0].event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
resp.events[0].region #=> String
resp.events[0].availability_zone #=> String
resp.events[0].start_time #=> Time
resp.events[0].end_time #=> Time
resp.events[0].last_updated_time #=> Time
resp.events[0].status_code #=> String, one of "open", "closed", "upcoming"
resp.events[0].event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
resp.next_token #=> String

Options Hash (options):

:filter (Types::EventFilter) —
Values to narrow the results returned.
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Returns:

(Types::DescribeEventsResponse) —
Returns a response object which responds to the following methods:
- #events => Array<Types::Event>
- #next_token => String

See Also:

AWS API Documentation

#describe_events_for_organization(options = {}) ⇒ `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.

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

Examples:

Request syntax with placeholder values


resp = client.describe_events_for_organization({
  filter: {
    event_type_codes: ["eventType"],
    aws_account_ids: ["accountId"],
    services: ["service"],
    regions: ["region"],
    start_time: {
      from: Time.now,
      to: Time.now,
    },
    end_time: {
      from: Time.now,
      to: Time.now,
    },
    last_updated_time: {
      from: Time.now,
      to: Time.now,
    },
    entity_arns: ["entityArn"],
    entity_values: ["entityValue"],
    event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
    event_status_codes: ["open"], # accepts open, closed, upcoming
  },
  next_token: "nextToken",
  max_results: 1,
  locale: "locale",
})

Response structure


resp.events #=> Array
resp.events[0].arn #=> String
resp.events[0].service #=> String
resp.events[0].event_type_code #=> String
resp.events[0].event_type_category #=> String, one of "issue", "accountNotification", "scheduledChange", "investigation"
resp.events[0].event_scope_code #=> String, one of "PUBLIC", "ACCOUNT_SPECIFIC", "NONE"
resp.events[0].region #=> String
resp.events[0].start_time #=> Time
resp.events[0].end_time #=> Time
resp.events[0].last_updated_time #=> Time
resp.events[0].status_code #=> String, one of "open", "closed", "upcoming"
resp.next_token #=> String

Options Hash (options):

:filter (Types::OrganizationEventFilter) —
Values to narrow the results returned.
:next_token (String) —
If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return in one batch, between 10 and 100, inclusive.
:locale (String) —
The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Returns:

(Types::DescribeEventsForOrganizationResponse) —
Returns a response object which responds to the following methods:
- #events => Array<Types::OrganizationEvent>
- #next_token => String

See Also:

AWS API Documentation

#describe_health_service_status_for_organization(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.describe_health_service_status_for_organization()

Response structure


resp.health_service_access_status_for_organization #=> String

Returns:

(Types::DescribeHealthServiceStatusForOrganizationResponse) —
Returns a response object which responds to the following methods:
- #health_service_access_status_for_organization => String

See Also:

AWS API Documentation

#disable_health_service_access_for_organization(options = {}) ⇒ `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.

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account.

Examples:

Request syntax with placeholder values


resp = client.disable_health_service_access_for_organization()

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#enable_health_service_access_for_organization(options = {}) ⇒ `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.

Examples:

Request syntax with placeholder values


resp = client.enable_health_service_access_for_organization()

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::Health::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::Health::Client

Instance Method Details

#describe_affected_accounts_for_organization(options = {}) ⇒ Types::DescribeAffectedAccountsForOrganizationResponse

#describe_affected_entities(options = {}) ⇒ Types::DescribeAffectedEntitiesResponse

#describe_affected_entities_for_organization(options = {}) ⇒ Types::DescribeAffectedEntitiesForOrganizationResponse

#describe_entity_aggregates(options = {}) ⇒ Types::DescribeEntityAggregatesResponse

#describe_event_aggregates(options = {}) ⇒ Types::DescribeEventAggregatesResponse

#describe_event_details(options = {}) ⇒ Types::DescribeEventDetailsResponse

#describe_event_details_for_organization(options = {}) ⇒ Types::DescribeEventDetailsForOrganizationResponse

#describe_event_types(options = {}) ⇒ Types::DescribeEventTypesResponse

#describe_events(options = {}) ⇒ Types::DescribeEventsResponse

#describe_events_for_organization(options = {}) ⇒ Types::DescribeEventsForOrganizationResponse

#describe_health_service_status_for_organization(options = {}) ⇒ Types::DescribeHealthServiceStatusForOrganizationResponse

#disable_health_service_access_for_organization(options = {}) ⇒ Struct

#enable_health_service_access_for_organization(options = {}) ⇒ Struct

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::Health::Client`

#describe_affected_accounts_for_organization(options = {}) ⇒ `Types::DescribeAffectedAccountsForOrganizationResponse`

#describe_affected_entities(options = {}) ⇒ `Types::DescribeAffectedEntitiesResponse`

#describe_affected_entities_for_organization(options = {}) ⇒ `Types::DescribeAffectedEntitiesForOrganizationResponse`

#describe_entity_aggregates(options = {}) ⇒ `Types::DescribeEntityAggregatesResponse`

#describe_event_aggregates(options = {}) ⇒ `Types::DescribeEventAggregatesResponse`

#describe_event_details(options = {}) ⇒ `Types::DescribeEventDetailsResponse`

#describe_event_details_for_organization(options = {}) ⇒ `Types::DescribeEventDetailsForOrganizationResponse`

#describe_event_types(options = {}) ⇒ `Types::DescribeEventTypesResponse`

#describe_events(options = {}) ⇒ `Types::DescribeEventsResponse`

#describe_events_for_organization(options = {}) ⇒ `Types::DescribeEventsForOrganizationResponse`

#describe_health_service_status_for_organization(options = {}) ⇒ `Types::DescribeHealthServiceStatusForOrganizationResponse`

#disable_health_service_access_for_organization(options = {}) ⇒ `Struct`

#enable_health_service_access_for_organization(options = {}) ⇒ `Struct`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`