[ aws . ecs ]

list-account-settings

Description

Lists the account settings for a specified principal.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-account-settings is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: settings

Synopsis

  list-account-settings
[--name <value>]
[--value <value>]
[--principal-arn <value>]
[--effective-settings | --no-effective-settings]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the account setting you want to list the settings for.

Possible values:

• serviceLongArnFormat

• taskLongArnFormat

• containerInstanceLongArnFormat

• awsvpcTrunking

• containerInsights

--value (string)

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

--principal-arn (string)

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed 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.

--effective-settings | --no-effective-settings (boolean)

Specifies whether to return the effective settings. If true , the account settings for the root user or the default setting for the principalArn are returned. If false , the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To view the account settings for an account

The following list-account-settings example displays the effective account settings for an account.

aws ecs list-account-settings --effective-settings

Output:

{
    "settings": [
        {
            "name": "containerInstanceLongArnFormat",
            "value": "enabled",
            "principalArn": "arn:aws:iam::123456789012:root"
        },
        {
            "name": "serviceLongArnFormat",
            "value": "enabled",
            "principalArn": "arn:aws:iam::123456789012:root"
        },
        {
            "name": "taskLongArnFormat",
            "value": "enabled",
            "principalArn": "arn:aws:iam::123456789012:root"
        }
    ]
}

Example 2: To view the account settings for a specific IAM user or IAM role

The following list-account-settings example displays the account settings for the specified IAM user or IAM role.

aws ecs list-account-settings --principal-arn arn:aws:iam::123456789012:user/MyUser

Output:

{
    "settings": [
        {
            "name": "serviceLongArnFormat",
            "value": "enabled",
            "principalArn": "arn:aws:iam::123456789012:user/MyUser"
        }
    ]
}

For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon ECS Developer Guide.

Output

settings -> (list)

The account settings for the resource.

(structure)

The current account setting for a resource.

name -> (string)

The Amazon ECS resource name.

value -> (string)

Whether the account setting is enabled or disabled for the specified resource.

principalArn -> (string)

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

nextToken -> (string)

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.