List Account Settings
ecs_list_account_settings | R Documentation |
Lists the account settings for a specified principal¶
Description¶
Lists the account settings for a specified principal.
Usage¶
Arguments¶
name
The name of the account setting you want to list the settings for.
value
The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
principalArn
The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
effectiveSettings
Determines whether to return the effective settings. If
true
, the account settings for the root user or the default setting for theprincipalArn
are returned. Iffalse
, the account settings for theprincipalArn
are returned if they're set. Otherwise, no account settings are returned.nextToken
The
nextToken
value returned from alist_account_settings
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it's possible the number of results to be fewer thanmaxResults
.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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherlist_account_settings
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter isn't used, thenlist_account_settings
returns up to 10 results and anextToken
value if applicable.
Value¶
A list with the following syntax:
list(
settings = list(
list(
name = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights"|"fargateFIPSMode"|"tagResourceAuthorization"|"fargateTaskRetirementWaitPeriod"|"guardDutyActivate",
value = "string",
principalArn = "string",
type = "user"|"aws_managed"
)
),
nextToken = "string"
)
Request syntax¶
svc$list_account_settings(
name = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights"|"fargateFIPSMode"|"tagResourceAuthorization"|"fargateTaskRetirementWaitPeriod"|"guardDutyActivate",
value = "string",
principalArn = "string",
effectiveSettings = TRUE|FALSE,
nextToken = "string",
maxResults = 123
)
Examples¶
## Not run:
# 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::<aws_account_id>:user/principalName"
)
## End(Not run)