Class: Aws::Health::Types::DescribeAffectedEntitiesForOrganizationRequest

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

Overview

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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#localeString

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Returns:

  • (String)


258
259
260
261
262
263
264
265
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 258

class DescribeAffectedEntitiesForOrganizationRequest < Struct.new(
  :organization_entity_filters,
  :locale,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to return in one batch, between 10 and 100, inclusive.

Returns:

  • (Integer)


258
259
260
261
262
263
264
265
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 258

class DescribeAffectedEntitiesForOrganizationRequest < Struct.new(
  :organization_entity_filters,
  :locale,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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)


258
259
260
261
262
263
264
265
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 258

class DescribeAffectedEntitiesForOrganizationRequest < Struct.new(
  :organization_entity_filters,
  :locale,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#organization_entity_filtersArray<Types::EventAccountFilter>

A JSON set of elements including the awsAccountId and the eventArn.

Returns:



258
259
260
261
262
263
264
265
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 258

class DescribeAffectedEntitiesForOrganizationRequest < Struct.new(
  :organization_entity_filters,
  :locale,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end