ECS / Client / put_account_setting_default

put_account_setting_default

ECS.Client.put_account_setting_default(**kwargs)

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

See also: AWS API Documentation

Request Syntax

response = client.put_account_setting_default(
    name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat'|'awsvpcTrunking'|'containerInsights',
    value='string'
)

Parameters:

• name (string) –

  [REQUIRED]

  The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.

  Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can set the name to fargateVCPULimit to opt in or opt out of the vCPU-based quotas. For information about the opt in timeline, see Fargate vCPU-based quotas timeline in the Amazon ECS Developer Guide .

• value (string) –

  [REQUIRED]

  The account setting value for the specified principal ARN. Accepted values are enabled and disabled .

Return type:

dict

Returns:

Response Syntax

{
    'setting': {
        'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat'|'awsvpcTrunking'|'containerInsights',
        'value': 'string',
        'principalArn': 'string'
    }
}

Response Structure

• (dict) –

  • setting (dict) –

    The current setting for a resource.

    • name (string) –

      The Amazon ECS resource name.

    • value (string) –

      Determines whether the account setting is on or off for the specified resource.

    • principalArn (string) –

      The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.

Exceptions

• ECS.Client.exceptions.ServerException

• ECS.Client.exceptions.ClientException

• ECS.Client.exceptions.InvalidParameterException

Examples

This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.

response = client.put_account_setting_default(
    name='serviceLongArnFormat',
    value='enabled',
)

print(response)

Expected Output:

{
    'setting': {
        'name': 'serviceLongArnFormat',
        'value': 'enabled',
        'principalArn': 'arn:aws:iam::<aws_account_id>:root',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}