Scope
Describes the scope of a recommendation preference.
Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the AWS Compute Optimizer User Guide.
Note
You cannot create recommendation preferences for Auto Scaling groups at the
organization and account levels. You can create recommendation preferences for
Auto Scaling groups only at the resource level by specifying a scope name
of ResourceArn
and a scope value of the Auto Scaling group Amazon
Resource Name (ARN). This will configure the preference for all instances that are
part of the specified Auto Scaling group. You also cannot create recommendation
preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for
standalone instances.
Contents
- name
-
The name of the scope.
The following scopes are possible:
-
Organization
- Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization. -
AccountId
- Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account. -
ResourceArn
- Specifies that the recommendation preference applies at the individual resource level.
Type: String
Valid Values:
Organization | AccountId | ResourceArn
Required: No
-
- value
-
The value of the scope.
If you specified the
name
of the scope as:-
Organization
- Thevalue
must beALL_ACCOUNTS
. -
AccountId
- Thevalue
must be a 12-digit AWS account ID. -
ResourceArn
- Thevalue
must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
Type: String
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: