Class: Aws::Health::Types::DescribeAffectedAccountsForOrganizationResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-health/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#affected_accounts ⇒ Array<String>

A JSON set of elements of the affected accounts.

Returns:

  • (Array<String>) 


221
222
223
224
225
226
227
 
# File 'lib/aws-sdk-health/types.rb', line 221

class DescribeAffectedAccountsForOrganizationResponse < Struct.new(
  :affected_accounts,
  :event_scope_code,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#event_scope_code ⇒ String

This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.

  • If the ‘eventScopeCode` value is `PUBLIC`, then the `affectedAccounts` value is always empty.

  • If the ‘eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the `affectedAccounts` value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

  • If the ‘eventScopeCode` value is `NONE`, then the `eventArn` that you specified in the request is invalid or doesn’t exist.

Returns:

  • (String) 


221
222
223
224
225
226
227
 
# File 'lib/aws-sdk-health/types.rb', line 221

class DescribeAffectedAccountsForOrganizationResponse < Struct.new(
  :affected_accounts,
  :event_scope_code,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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:

  • (String) 


221
222
223
224
225
226
227
 
# File 'lib/aws-sdk-health/types.rb', line 221

class DescribeAffectedAccountsForOrganizationResponse < Struct.new(
  :affected_accounts,
  :event_scope_code,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end