AmazonECSClient.PutAccountSetting Method (PutAccountSettingRequest)

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to PutAccountSettingAsync.

Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public virtual PutAccountSettingResponse PutAccountSetting(
         PutAccountSettingRequest request
)

Parameters

request: Type: Amazon.ECS.Model.PutAccountSettingRequest

Container for the necessary parameters to execute the PutAccountSetting service method.

Return Value

Type: PutAccountSettingResponse

The response from the PutAccountSetting service method, as returned by ECS.

Exceptions

Exception	Condition
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.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.

Examples

This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.

To modify your account settings


var client = new AmazonECSClient();
var response = client.PutAccountSetting(new PutAccountSettingRequest 
{
    Name = "serviceLongArnFormat",
    Value = "enabled"
});

Setting setting = response.Setting;

This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.

To modify the account settings for a specific IAM user or IAM role


var client = new AmazonECSClient();
var response = client.PutAccountSetting(new PutAccountSettingRequest 
{
    Name = "containerInstanceLongArnFormat",
    Value = "enabled",
    PrincipalArn = "arn:aws:iam::<aws_account_id>:user/principalName"
});

Setting setting = response.Setting;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.PutAccountSetting (PutAccountSettingRequest)

Method