Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Lists the account settings for a specified principal.
This operation returns paginated results.
Synopsis
- data ListAccountSettings = ListAccountSettings' {
- value :: Maybe Text
- nextToken :: Maybe Text
- name :: Maybe SettingName
- principalArn :: Maybe Text
- effectiveSettings :: Maybe Bool
- maxResults :: Maybe Int
- newListAccountSettings :: ListAccountSettings
- listAccountSettings_value :: Lens' ListAccountSettings (Maybe Text)
- listAccountSettings_nextToken :: Lens' ListAccountSettings (Maybe Text)
- listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName)
- listAccountSettings_principalArn :: Lens' ListAccountSettings (Maybe Text)
- listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool)
- listAccountSettings_maxResults :: Lens' ListAccountSettings (Maybe Int)
- data ListAccountSettingsResponse = ListAccountSettingsResponse' {}
- newListAccountSettingsResponse :: Int -> ListAccountSettingsResponse
- listAccountSettingsResponse_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting])
- listAccountSettingsResponse_nextToken :: Lens' ListAccountSettingsResponse (Maybe Text)
- listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int
Creating a Request
data ListAccountSettings Source #
See: newListAccountSettings
smart constructor.
ListAccountSettings' | |
|
Instances
newListAccountSettings :: ListAccountSettings Source #
Create a value of ListAccountSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:ListAccountSettings'
, listAccountSettings_value
- The value of the account settings with which to filter results. You must
also specify an account setting name to use this parameter.
$sel:nextToken:ListAccountSettings'
, listAccountSettings_nextToken
- 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 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.
$sel:name:ListAccountSettings'
, listAccountSettings_name
- The name of the account setting you want to list the settings for.
$sel:principalArn:ListAccountSettings'
, listAccountSettings_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.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
$sel:effectiveSettings:ListAccountSettings'
, listAccountSettings_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.
$sel:maxResults:ListAccountSettings'
, listAccountSettings_maxResults
- 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 is not used, then ListAccountSettings
returns up to 10 results and a nextToken
value if applicable.
Request Lenses
listAccountSettings_value :: Lens' ListAccountSettings (Maybe Text) Source #
The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
listAccountSettings_nextToken :: Lens' ListAccountSettings (Maybe Text) Source #
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 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.
listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName) Source #
The name of the account setting you want to list the settings for.
listAccountSettings_principalArn :: Lens' ListAccountSettings (Maybe Text) Source #
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.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool) Source #
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.
listAccountSettings_maxResults :: Lens' ListAccountSettings (Maybe Int) Source #
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 is not used, then ListAccountSettings
returns up to 10 results and a nextToken
value if applicable.
Destructuring the Response
data ListAccountSettingsResponse Source #
See: newListAccountSettingsResponse
smart constructor.
ListAccountSettingsResponse' | |
|
Instances
newListAccountSettingsResponse Source #
Create a value of ListAccountSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:settings:ListAccountSettingsResponse'
, listAccountSettingsResponse_settings
- The account settings for the resource.
$sel:nextToken:ListAccountSettings'
, listAccountSettingsResponse_nextToken
- 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.
$sel:httpStatus:ListAccountSettingsResponse'
, listAccountSettingsResponse_httpStatus
- The response's http status code.
Response Lenses
listAccountSettingsResponse_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting]) Source #
The account settings for the resource.
listAccountSettingsResponse_nextToken :: Lens' ListAccountSettingsResponse (Maybe Text) Source #
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.
listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int Source #
The response's http status code.