Learn R Programming
aws.ecx (version 1.0.5)

ecs_list_account_settings: List Account Settings

Description

Lists the account settings for a specified principal.

Usage

ecs_list_account_settings(
  maxResults = NULL,
  nextToken = NULL,
  name = NULL,
  value = NULL,
  principalArn = NULL,
  effectiveSettings = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

maxResults

Character. Pagination limit[optional]

nextToken

Characters. The token for the next page of results[optional]

name

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

value

Character. The value of the account settings with which to filter results.

principalArn

Character. The ARN of the principal, which can be an IAM user, IAM role, or the root user.

effectiveSettings

Logical. Specifies whether to return the effective settings.

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

maxResults

Pagination limit

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.