PutAccountSetting
Modifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat
, taskLongArnFormat
, or
containerInstanceLongArnFormat
are specified, the Amazon Resource Name
(ARN) and resource ID format of the resource type for a specified user, role, or
the root user for an account is affected. The opt-in and opt-out account setting must be
set for each Amazon ECS resource separately. The ARN and resource ID format of a resource
is defined by the opt-in status of the user or role that created the resource. You
must turn on this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking
is specified, the elastic network interface (ENI)
limit for any new container instances that support the feature is changed. If
awsvpcTrunking
is enabled, any new container instances that support the
feature are launched have the increased ENI limits available to them. For more
information, see Elastic Network
Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights
is specified, the default setting indicating
whether CloudWatch Container Insights is enabled for your clusters is changed. If
containerInsights
is enabled, any new clusters that are created will
have Container Insights enabled unless you disable it during cluster creation. For more
information, see CloudWatch
Container Insights in the Amazon Elastic Container Service Developer Guide.
Request Syntax
{
"name": "string
",
"principalArn": "string
",
"value": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- name
-
The Amazon ECS resource name for which to modify the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. IftaskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. IfcontainerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected. IfawsvpcTrunking
is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. IfcontainerInsights
is specified, the default setting for CloudWatch Container Insights for your clusters is affected.Type: String
Valid Values:
serviceLongArnFormat | taskLongArnFormat | containerInstanceLongArnFormat | awsvpcTrunking | containerInsights
Required: Yes
- principalArn
-
The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
Note Federated users assume the account setting of the root user and can't have explicit account settings set for them.
Type: String
Required: No
- value
-
The account setting value for the specified principal ARN. Accepted values are
enabled
anddisabled
.Type: String
Required: Yes
Response Syntax
{
"setting": {
"name": "string",
"principalArn": "string",
"value": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource,. Or, it might be specifying an identifier that isn't valid.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: