ecs_list_account_settings: Lists the account settings for a specified principal

Description

Lists the account settings for a specified principal.

Usage

ecs_list_account_settings(name, value, principalArn, effectiveSettings,
  nextToken, maxResults)

Value

A list with the following syntax:

list(
  settings = list(
    list(
      name = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights",
      value = "string",
      principalArn = "string"
    )
  ),
  nextToken = "string"
)

Arguments

name

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

value

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

principalArn

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.

effectiveSettings

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.

nextToken

The nextToken value returned from a list_account_settings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

The maximum number of account setting results returned by list_account_settings in paginated output. When this parameter is used, list_account_settings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another list_account_settings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then list_account_settings returns up to 10 results and a nextToken value if applicable.

Request syntax

svc$list_account_settings(
  name = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights",
  value = "string",
  principalArn = "string",
  effectiveSettings = TRUE|FALSE,
  nextToken = "string",
  maxResults = 123
)

Examples

Run this code

if (FALSE) {
# This example displays the effective account settings for your account.
svc$list_account_settings(
  effectiveSettings = TRUE
)

# This example displays the effective account settings for the specified
# user or role.
svc$list_account_settings(
  effectiveSettings = TRUE,
  principalArn = "arn:aws:iam:::user/principalName"
)
}