Class: Aws::MigrationHubConfig::Types::DescribeHomeRegionControlsRequest

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

Overview

Note:

When making an API call, you may pass DescribeHomeRegionControlsRequest data as a hash:

{
  control_id: "ControlId",
  home_region: "HomeRegion",
  target: {
    type: "ACCOUNT", # required, accepts ACCOUNT
    id: "TargetId",
  },
  max_results: 1,
  next_token: "Token",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#control_idString

The ControlID is a unique identifier string of your HomeRegionControl object.

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/types.rb', line 116

class DescribeHomeRegionControlsRequest < Struct.new(
  :control_id,
  :home_region,
  :target,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#home_regionString

The name of the home region you'd like to view.

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/types.rb', line 116

class DescribeHomeRegionControlsRequest < Struct.new(
  :control_id,
  :home_region,
  :target,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of filtering results to display per page.

Returns:

  • (Integer)


116
117
118
119
120
121
122
123
124
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/types.rb', line 116

class DescribeHomeRegionControlsRequest < Struct.new(
  :control_id,
  :home_region,
  :target,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If a NextToken was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in NextToken.

Returns:

  • (String)


116
117
118
119
120
121
122
123
124
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/types.rb', line 116

class DescribeHomeRegionControlsRequest < Struct.new(
  :control_id,
  :home_region,
  :target,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#targetTypes::Target

The target parameter specifies the identifier to which the home region is applied, which is always of type ACCOUNT. It applies the home region to the current ACCOUNT.

Returns:



116
117
118
119
120
121
122
123
124
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/types.rb', line 116

class DescribeHomeRegionControlsRequest < Struct.new(
  :control_id,
  :home_region,
  :target,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end