Class: Aws::Health::Types::DescribeAffectedAccountsForOrganizationRequest

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 DescribeAffectedAccountsForOrganizationRequest data as a hash:

{
  event_arn: "eventArn", # required
  next_token: "nextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_arnString

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

Returns:

  • (String)


170
171
172
173
174
175
176
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 170

class DescribeAffectedAccountsForOrganizationRequest < Struct.new(
  :event_arn,
  :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)


170
171
172
173
174
175
176
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 170

class DescribeAffectedAccountsForOrganizationRequest < Struct.new(
  :event_arn,
  :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)


170
171
172
173
174
175
176
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 170

class DescribeAffectedAccountsForOrganizationRequest < Struct.new(
  :event_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end