list_account_settings¶
Operation¶
list_account_settings
async
¶
list_account_settings(request: ListAccountSettingsInput | ListAccountSettingsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListAccountSettingsOutput
list_account_settings(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAccountSettingsInputDict]) -> ListAccountSettingsOutput
Lists the account settings for a specified principal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListAccountSettingsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
ListAccountSettingsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAccountSettingsInput structure.
Attributes¶
effective_settings
class-attribute
instance-attribute
¶
effective_settings: bool = ...
Determines 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're set. Otherwise, no account
settings are returned.
max_results
class-attribute
instance-attribute
¶
max_results: int = ...
The maximum number of account setting results returned by
ListAccountSettings in paginated output. When this parameter is used,
ListAccountSettings 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 ListAccountSettings
request with the returned nextToken value. This value can be between 1
and 10. If this parameter isn't used, then ListAccountSettings
returns up to 10 results and a nextToken value if applicable.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the account setting you want to list the settings for.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value returned from a ListAccountSettings request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults was provided, it's
possible the number of results to be fewer than maxResults.
Note
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.
principal_arn
class-attribute
instance-attribute
¶
principal_arn: str | None = ...
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.
In order to use this parameter, you must be the root user, or the principal.
Note
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
Dictionaries¶
ListAccountSettingsInputDict
¶
Bases: TypedDict
Dictionary form of ListAccountSettingsInput.
Attributes¶
effective_settings
instance-attribute
¶
effective_settings: bool | None
Determines 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're set. Otherwise, no account
settings are returned.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of account setting results returned by
ListAccountSettings in paginated output. When this parameter is used,
ListAccountSettings 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 ListAccountSettings
request with the returned nextToken value. This value can be between 1
and 10. If this parameter isn't used, then ListAccountSettings
returns up to 10 results and a nextToken value if applicable.
name
instance-attribute
¶
name: str | None
The name of the account setting you want to list the settings for.
next_token
instance-attribute
¶
next_token: str | None
The nextToken value returned from a ListAccountSettings request
indicating that more results are available to fulfill the request and
further calls will be needed. If maxResults was provided, it's
possible the number of results to be fewer than maxResults.
Note
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.
principal_arn
instance-attribute
¶
principal_arn: str | None
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.
In order to use this parameter, you must be the root user, or the principal.
Note
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
Output¶
ListAccountSettingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAccountSettingsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.