# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::Health module Types # Information about an entity that is affected by a Health event. # # @!attribute [rw] entity_arn # The unique identifier for the entity. Format: # `arn:aws:health:entity-region:aws-account:entity/entity-id `. # Example: # `arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K` # @return [String] # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] entity_value # The ID of the affected entity. # @return [String] # # @!attribute [rw] entity_url # The URL of the affected entity. # @return [String] # # @!attribute [rw] aws_account_id # The 12-digit AWS account number that contains the affected entity. # @return [String] # # @!attribute [rw] last_updated_time # The most recent time that the entity was updated. # @return [Time] # # @!attribute [rw] status_code # The most recent status of the entity affected by the event. The # possible values are `IMPAIRED`, `UNIMPAIRED`, and `UNKNOWN`. # @return [String] # # @!attribute [rw] tags # A map of entity tags attached to the affected entity. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/AffectedEntity AWS API Documentation # class AffectedEntity < Struct.new( :entity_arn, :event_arn, :entity_value, :entity_url, :aws_account_id, :last_updated_time, :status_code, :tags) include Aws::Structure end # EnableHealthServiceAccessForOrganization is already in progress. Wait # for the action to complete before trying again. To get the current # status, use the DescribeHealthServiceStatusForOrganization operation. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/ConcurrentModificationException AWS API Documentation # class ConcurrentModificationException < Struct.new( :message) include Aws::Structure end # A range of dates and times that is used by the EventFilter and # EntityFilter objects. If `from` is set and `to` is set: match items # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) is # between `from` and `to` inclusive. If `from` is set and `to` is not # set: match items where the timestamp value is equal to or after # `from`. If `from` is not set and `to` is set: match items where the # timestamp value is equal to or before `to`. # # @note When making an API call, you may pass DateTimeRange # data as a hash: # # { # from: Time.now, # to: Time.now, # } # # @!attribute [rw] from # The starting date and time of a time range. # @return [Time] # # @!attribute [rw] to # The ending date and time of a time range. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DateTimeRange AWS API Documentation # class DateTimeRange < Struct.new( :from, :to) include Aws::Structure end # @note When making an API call, you may pass DescribeAffectedAccountsForOrganizationRequest # data as a hash: # # { # event_arn: "eventArn", # required # next_token: "nextToken", # max_results: 1, # } # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganizationRequest AWS API Documentation # class DescribeAffectedAccountsForOrganizationRequest < Struct.new( :event_arn, :next_token, :max_results) include Aws::Structure end # @!attribute [rw] affected_accounts # A JSON set of elements of the affected accounts. # @return [Array] # # @!attribute [rw] event_scope_code # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganizationResponse AWS API Documentation # class DescribeAffectedAccountsForOrganizationResponse < Struct.new( :affected_accounts, :event_scope_code, :next_token) include Aws::Structure end # @note When making an API call, you may pass DescribeAffectedEntitiesForOrganizationRequest # data as a hash: # # { # organization_entity_filters: [ # required # { # event_arn: "eventArn", # required # aws_account_id: "accountId", # }, # ], # locale: "locale", # next_token: "nextToken", # max_results: 1, # } # # @!attribute [rw] organization_entity_filters # A JSON set of elements including the `awsAccountId` and the # `eventArn`. # @return [Array] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganizationRequest AWS API Documentation # class DescribeAffectedEntitiesForOrganizationRequest < Struct.new( :organization_entity_filters, :locale, :next_token, :max_results) include Aws::Structure end # @!attribute [rw] entities # A JSON set of elements including the `awsAccountId` and its # `entityArn`, `entityValue` and its `entityArn`, `lastUpdatedTime`, # `statusCode`, and `tags`. # @return [Array] # # @!attribute [rw] failed_set # A JSON set of elements of the failed response, including the # `awsAccountId`, `errorMessage`, `errorName`, and `eventArn`. # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganizationResponse AWS API Documentation # class DescribeAffectedEntitiesForOrganizationResponse < Struct.new( :entities, :failed_set, :next_token) include Aws::Structure end # @note When making an API call, you may pass DescribeAffectedEntitiesRequest # data as a hash: # # { # 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, # } # # @!attribute [rw] filter # Values to narrow the results returned. At least one event ARN is # required. # @return [Types::EntityFilter] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesRequest AWS API Documentation # class DescribeAffectedEntitiesRequest < Struct.new( :filter, :locale, :next_token, :max_results) include Aws::Structure end # @!attribute [rw] entities # The entities that match the filter criteria. # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesResponse AWS API Documentation # class DescribeAffectedEntitiesResponse < Struct.new( :entities, :next_token) include Aws::Structure end # @note When making an API call, you may pass DescribeEntityAggregatesRequest # data as a hash: # # { # event_arns: ["eventArn"], # } # # @!attribute [rw] event_arns # 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"` # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregatesRequest AWS API Documentation # class DescribeEntityAggregatesRequest < Struct.new( :event_arns) include Aws::Structure end # @!attribute [rw] entity_aggregates # The number of entities that are affected by each of the specified # events. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregatesResponse AWS API Documentation # class DescribeEntityAggregatesResponse < Struct.new( :entity_aggregates) include Aws::Structure end # @note When making an API call, you may pass DescribeEventAggregatesRequest # data as a hash: # # { # 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", # } # # @!attribute [rw] filter # Values to narrow the results returned. # @return [Types::EventFilter] # # @!attribute [rw] aggregate_field # The only currently supported value is `eventTypeCategory`. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventAggregatesRequest AWS API Documentation # class DescribeEventAggregatesRequest < Struct.new( :filter, :aggregate_field, :max_results, :next_token) include Aws::Structure end # @!attribute [rw] event_aggregates # The number of events in each category that meet the optional filter # criteria. # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventAggregatesResponse AWS API Documentation # class DescribeEventAggregatesResponse < Struct.new( :event_aggregates, :next_token) include Aws::Structure end # @note When making an API call, you may pass DescribeEventDetailsForOrganizationRequest # data as a hash: # # { # organization_event_detail_filters: [ # required # { # event_arn: "eventArn", # required # aws_account_id: "accountId", # }, # ], # locale: "locale", # } # # @!attribute [rw] organization_event_detail_filters # A set of JSON elements that includes the `awsAccountId` and the # `eventArn`. # @return [Array] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganizationRequest AWS API Documentation # class DescribeEventDetailsForOrganizationRequest < Struct.new( :organization_event_detail_filters, :locale) include Aws::Structure end # @!attribute [rw] successful_set # Information about the events that could be retrieved. # @return [Array] # # @!attribute [rw] failed_set # Error messages for any events that could not be retrieved. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganizationResponse AWS API Documentation # class DescribeEventDetailsForOrganizationResponse < Struct.new( :successful_set, :failed_set) include Aws::Structure end # @note When making an API call, you may pass DescribeEventDetailsRequest # data as a hash: # # { # event_arns: ["eventArn"], # required # locale: "locale", # } # # @!attribute [rw] event_arns # 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"` # @return [Array] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsRequest AWS API Documentation # class DescribeEventDetailsRequest < Struct.new( :event_arns, :locale) include Aws::Structure end # @!attribute [rw] successful_set # Information about the events that could be retrieved. # @return [Array] # # @!attribute [rw] failed_set # Error messages for any events that could not be retrieved. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsResponse AWS API Documentation # class DescribeEventDetailsResponse < Struct.new( :successful_set, :failed_set) include Aws::Structure end # @note When making an API call, you may pass DescribeEventTypesRequest # data as a hash: # # { # filter: { # event_type_codes: ["eventTypeCode"], # services: ["service"], # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation # }, # locale: "locale", # next_token: "nextToken", # max_results: 1, # } # # @!attribute [rw] filter # Values to narrow the results returned. # @return [Types::EventTypeFilter] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventTypesRequest AWS API Documentation # class DescribeEventTypesRequest < Struct.new( :filter, :locale, :next_token, :max_results) include Aws::Structure end # @!attribute [rw] event_types # A list of event types that match the filter criteria. Event types # have a category (`issue`, `accountNotification`, or # `scheduledChange`), a service (for example, `EC2`, `RDS`, # `DATAPIPELINE`, `BILLING`), and a code (in the format # `AWS_SERVICE_DESCRIPTION `; for example, # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`). # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventTypesResponse AWS API Documentation # class DescribeEventTypesResponse < Struct.new( :event_types, :next_token) include Aws::Structure end # @note When making an API call, you may pass DescribeEventsForOrganizationRequest # data as a hash: # # { # 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", # } # # @!attribute [rw] filter # Values to narrow the results returned. # @return [Types::OrganizationEventFilter] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganizationRequest AWS API Documentation # class DescribeEventsForOrganizationRequest < Struct.new( :filter, :next_token, :max_results, :locale) include Aws::Structure end # @!attribute [rw] events # The events that match the specified filter criteria. # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganizationResponse AWS API Documentation # class DescribeEventsForOrganizationResponse < Struct.new( :events, :next_token) include Aws::Structure end # @note When making an API call, you may pass DescribeEventsRequest # data as a hash: # # { # 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", # } # # @!attribute [rw] filter # Values to narrow the results returned. # @return [Types::EventFilter] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of items to return in one batch, between 10 and # 100, inclusive. # @return [Integer] # # @!attribute [rw] locale # The locale (language) to return information in. English (en) is the # default and the only supported value at this time. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsRequest AWS API Documentation # class DescribeEventsRequest < Struct.new( :filter, :next_token, :max_results, :locale) include Aws::Structure end # @!attribute [rw] events # The events that match the specified filter criteria. # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsResponse AWS API Documentation # class DescribeEventsResponse < Struct.new( :events, :next_token) include Aws::Structure end # @!attribute [rw] health_service_access_status_for_organization # Information about the status of enabling or disabling AWS Health # Organizational View in your organization. # # Valid values are `ENABLED | DISABLED | PENDING`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeHealthServiceStatusForOrganizationResponse AWS API Documentation # class DescribeHealthServiceStatusForOrganizationResponse < Struct.new( :health_service_access_status_for_organization) include Aws::Structure end # The number of entities that are affected by one or more events. # Returned by the DescribeEntityAggregates operation. # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] count # The number entities that match the criteria for the specified # events. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EntityAggregate AWS API Documentation # class EntityAggregate < Struct.new( :event_arn, :count) include Aws::Structure end # The values to use to filter results from the DescribeAffectedEntities # operation. # # @note When making an API call, you may pass EntityFilter # data as a hash: # # { # 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 # } # # @!attribute [rw] event_arns # 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"` # @return [Array] # # @!attribute [rw] entity_arns # A list of entity ARNs (unique identifiers). # @return [Array] # # @!attribute [rw] entity_values # A list of IDs for affected entities. # @return [Array] # # @!attribute [rw] last_updated_times # A list of the most recent dates and times that the entity was # updated. # @return [Array] # # @!attribute [rw] tags # A map of entity tags attached to the affected entity. # @return [Array>] # # @!attribute [rw] status_codes # A list of entity status codes (`IMPAIRED`, `UNIMPAIRED`, or # `UNKNOWN`). # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EntityFilter AWS API Documentation # class EntityFilter < Struct.new( :event_arns, :entity_arns, :entity_values, :last_updated_times, :tags, :status_codes) include Aws::Structure end # Summary information about an AWS Health event. # # @!attribute [rw] arn # 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` # @return [String] # # @!attribute [rw] service # The AWS service that is affected by the event. For example, `EC2`, # `RDS`. # @return [String] # # @!attribute [rw] event_type_code # The unique identifier for the event type. The format is # `AWS_SERVICE_DESCRIPTION `; for example, # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`. # @return [String] # # @!attribute [rw] event_type_category # The category of the event. Possible values are `issue`, # `scheduledChange`, and `accountNotification`. # @return [String] # # @!attribute [rw] region # The AWS region name of the event. # @return [String] # # @!attribute [rw] availability_zone # The AWS Availability Zone of the event. For example, us-east-1a. # @return [String] # # @!attribute [rw] start_time # The date and time that the event began. # @return [Time] # # @!attribute [rw] end_time # The date and time that the event ended. # @return [Time] # # @!attribute [rw] last_updated_time # The most recent date and time that the event was updated. # @return [Time] # # @!attribute [rw] status_code # The most recent status of the event. Possible values are `open`, # `closed`, and `upcoming`. # @return [String] # # @!attribute [rw] event_scope_code # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/Event AWS API Documentation # class Event < Struct.new( :arn, :service, :event_type_code, :event_type_category, :region, :availability_zone, :start_time, :end_time, :last_updated_time, :status_code, :event_scope_code) include Aws::Structure end # The values used to filter results from the # DescribeEventDetailsForOrganization and # DescribeAffectedEntitiesForOrganization operations. # # @note When making an API call, you may pass EventAccountFilter # data as a hash: # # { # event_arn: "eventArn", # required # aws_account_id: "accountId", # } # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] aws_account_id # The 12-digit AWS account numbers that contains the affected # entities. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventAccountFilter AWS API Documentation # class EventAccountFilter < Struct.new( :event_arn, :aws_account_id) include Aws::Structure end # The number of events of each issue type. Returned by the # DescribeEventAggregates operation. # # @!attribute [rw] aggregate_value # The issue type for the associated count. # @return [String] # # @!attribute [rw] count # The number of events of the associated issue type. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventAggregate AWS API Documentation # class EventAggregate < Struct.new( :aggregate_value, :count) include Aws::Structure end # The detailed description of the event. Included in the information # returned by the DescribeEventDetails operation. # # @!attribute [rw] latest_description # The most recent description of the event. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventDescription AWS API Documentation # class EventDescription < Struct.new( :latest_description) include Aws::Structure end # Detailed information about an event. A combination of an Event object, # an EventDescription object, and additional metadata about the event. # Returned by the DescribeEventDetails operation. # # @!attribute [rw] event # Summary information about the event. # @return [Types::Event] # # @!attribute [rw] event_description # The most recent description of the event. # @return [Types::EventDescription] # # @!attribute [rw] event_metadata # Additional metadata about the event. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventDetails AWS API Documentation # class EventDetails < Struct.new( :event, :event_description, :event_metadata) include Aws::Structure end # Error information returned when a DescribeEventDetails operation # cannot find a specified event. # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] error_name # The name of the error. # @return [String] # # @!attribute [rw] error_message # A message that describes the error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventDetailsErrorItem AWS API Documentation # class EventDetailsErrorItem < Struct.new( :event_arn, :error_name, :error_message) include Aws::Structure end # The values to use to filter results from the DescribeEvents and # DescribeEventAggregates operations. # # @note When making an API call, you may pass EventFilter # data as a hash: # # { # 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 # } # # @!attribute [rw] event_arns # 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"` # @return [Array] # # @!attribute [rw] event_type_codes # A list of unique identifiers for event types. For example, # `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".` # @return [Array] # # @!attribute [rw] services # The AWS services associated with the event. For example, `EC2`, # `RDS`. # @return [Array] # # @!attribute [rw] regions # A list of AWS regions. # @return [Array] # # @!attribute [rw] availability_zones # A list of AWS availability zones. # @return [Array] # # @!attribute [rw] start_times # A list of dates and times that the event began. # @return [Array] # # @!attribute [rw] end_times # A list of dates and times that the event ended. # @return [Array] # # @!attribute [rw] last_updated_times # A list of dates and times that the event was last updated. # @return [Array] # # @!attribute [rw] entity_arns # A list of entity ARNs (unique identifiers). # @return [Array] # # @!attribute [rw] entity_values # A list of entity identifiers, such as EC2 instance IDs # (`i-34ab692e`) or EBS volumes (`vol-426ab23e`). # @return [Array] # # @!attribute [rw] event_type_categories # A list of event type category codes (`issue`, `scheduledChange`, or # `accountNotification`). # @return [Array] # # @!attribute [rw] tags # A map of entity tags attached to the affected entity. # @return [Array>] # # @!attribute [rw] event_status_codes # A list of event status codes. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventFilter AWS API Documentation # class EventFilter < Struct.new( :event_arns, :event_type_codes, :services, :regions, :availability_zones, :start_times, :end_times, :last_updated_times, :entity_arns, :entity_values, :event_type_categories, :tags, :event_status_codes) include Aws::Structure end # Metadata about a type of event that is reported by AWS Health. Data # consists of the category (for example, `issue`), the service (for # example, `EC2`), and the event type code (for example, # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`). # # @!attribute [rw] service # The AWS service that is affected by the event. For example, `EC2`, # `RDS`. # @return [String] # # @!attribute [rw] code # The unique identifier for the event type. The format is # `AWS_SERVICE_DESCRIPTION `; for example, # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`. # @return [String] # # @!attribute [rw] category # A list of event type category codes (`issue`, `scheduledChange`, or # `accountNotification`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventType AWS API Documentation # class EventType < Struct.new( :service, :code, :category) include Aws::Structure end # The values to use to filter results from the DescribeEventTypes # operation. # # @note When making an API call, you may pass EventTypeFilter # data as a hash: # # { # event_type_codes: ["eventTypeCode"], # services: ["service"], # event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation # } # # @!attribute [rw] event_type_codes # A list of event type codes. # @return [Array] # # @!attribute [rw] services # The AWS services associated with the event. For example, `EC2`, # `RDS`. # @return [Array] # # @!attribute [rw] event_type_categories # A list of event type category codes (`issue`, `scheduledChange`, or # `accountNotification`). # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventTypeFilter AWS API Documentation # class EventTypeFilter < Struct.new( :event_type_codes, :services, :event_type_categories) include Aws::Structure end # The specified pagination token (`nextToken`) is not valid. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/InvalidPaginationToken AWS API Documentation # class InvalidPaginationToken < Struct.new( :message) include Aws::Structure end # Error information returned when a # DescribeAffectedEntitiesForOrganization operation cannot find or # process a specific entity. # # @!attribute [rw] aws_account_id # The 12-digit AWS account numbers that contains the affected # entities. # @return [String] # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] error_name # The name of the error. # @return [String] # # @!attribute [rw] error_message # The unique identifier for the event type. The format is # `AWS_SERVICE_DESCRIPTION`. For example, # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationAffectedEntitiesErrorItem AWS API Documentation # class OrganizationAffectedEntitiesErrorItem < Struct.new( :aws_account_id, :event_arn, :error_name, :error_message) include Aws::Structure end # Summary information about an event, returned by the # DescribeEventsForOrganization operation. # # @!attribute [rw] arn # 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` # @return [String] # # @!attribute [rw] service # The AWS service that is affected by the event. For example, EC2, # RDS. # @return [String] # # @!attribute [rw] event_type_code # The unique identifier for the event type. The format is # `AWS_SERVICE_DESCRIPTION`. For example, # `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`. # @return [String] # # @!attribute [rw] event_type_category # The category of the event type. # @return [String] # # @!attribute [rw] event_scope_code # @return [String] # # @!attribute [rw] region # The AWS Region name of the event. # @return [String] # # @!attribute [rw] start_time # The date and time that the event began. # @return [Time] # # @!attribute [rw] end_time # The date and time that the event ended. # @return [Time] # # @!attribute [rw] last_updated_time # The most recent date and time that the event was updated. # @return [Time] # # @!attribute [rw] status_code # The most recent status of the event. Possible values are `open`, # `closed`, and `upcoming`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEvent AWS API Documentation # class OrganizationEvent < Struct.new( :arn, :service, :event_type_code, :event_type_category, :event_scope_code, :region, :start_time, :end_time, :last_updated_time, :status_code) include Aws::Structure end # Detailed information about an event. A combination of an Event object, # an EventDescription object, and additional metadata about the event. # Returned by the DescribeEventDetailsForOrganization operation. # # @!attribute [rw] aws_account_id # The 12-digit AWS account numbers that contains the affected # entities. # @return [String] # # @!attribute [rw] event # Summary information about an AWS Health event. # @return [Types::Event] # # @!attribute [rw] event_description # The detailed description of the event. Included in the information # returned by the DescribeEventDetails operation. # @return [Types::EventDescription] # # @!attribute [rw] event_metadata # Additional metadata about the event. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetails AWS API Documentation # class OrganizationEventDetails < Struct.new( :aws_account_id, :event, :event_description, :event_metadata) include Aws::Structure end # Error information returned when a DescribeEventDetailsForOrganization # operation cannot find a specified event. # # @!attribute [rw] aws_account_id # Error information returned when a # DescribeEventDetailsForOrganization operation cannot find a # specified event. # @return [String] # # @!attribute [rw] event_arn # 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` # @return [String] # # @!attribute [rw] error_name # The name of the error. # @return [String] # # @!attribute [rw] error_message # A message that describes the error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetailsErrorItem AWS API Documentation # class OrganizationEventDetailsErrorItem < Struct.new( :aws_account_id, :event_arn, :error_name, :error_message) include Aws::Structure end # The values to filter results from the DescribeEventsForOrganization # operation. # # @note When making an API call, you may pass OrganizationEventFilter # data as a hash: # # { # 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 # } # # @!attribute [rw] event_type_codes # A list of unique identifiers for event types. For example, # `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".` # @return [Array] # # @!attribute [rw] aws_account_ids # A list of 12-digit AWS account numbers that contains the affected # entities. # @return [Array] # # @!attribute [rw] services # The AWS services associated with the event. For example, `EC2`, # `RDS`. # @return [Array] # # @!attribute [rw] regions # A list of AWS Regions. # @return [Array] # # @!attribute [rw] start_time # A range of dates and times that is used by the EventFilter and # EntityFilter objects. If `from` is set and `to` is set: match items # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) # is between `from` and `to` inclusive. If `from` is set and `to` is # not set: match items where the timestamp value is equal to or after # `from`. If `from` is not set and `to` is set: match items where the # timestamp value is equal to or before `to`. # @return [Types::DateTimeRange] # # @!attribute [rw] end_time # A range of dates and times that is used by the EventFilter and # EntityFilter objects. If `from` is set and `to` is set: match items # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) # is between `from` and `to` inclusive. If `from` is set and `to` is # not set: match items where the timestamp value is equal to or after # `from`. If `from` is not set and `to` is set: match items where the # timestamp value is equal to or before `to`. # @return [Types::DateTimeRange] # # @!attribute [rw] last_updated_time # A range of dates and times that is used by the EventFilter and # EntityFilter objects. If `from` is set and `to` is set: match items # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) # is between `from` and `to` inclusive. If `from` is set and `to` is # not set: match items where the timestamp value is equal to or after # `from`. If `from` is not set and `to` is set: match items where the # timestamp value is equal to or before `to`. # @return [Types::DateTimeRange] # # @!attribute [rw] entity_arns # REPLACEME # @return [Array] # # @!attribute [rw] entity_values # A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) # or EBS volumes (vol-426ab23e). # @return [Array] # # @!attribute [rw] event_type_categories # REPLACEME # @return [Array] # # @!attribute [rw] event_status_codes # A list of event status codes. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventFilter AWS API Documentation # class OrganizationEventFilter < Struct.new( :event_type_codes, :aws_account_ids, :services, :regions, :start_time, :end_time, :last_updated_time, :entity_arns, :entity_values, :event_type_categories, :event_status_codes) include Aws::Structure end # The specified locale is not supported. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/UnsupportedLocale AWS API Documentation # class UnsupportedLocale < Struct.new( :message) include Aws::Structure end end end