Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECS.ListAccountSettings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the account settings for a specified principal.

This operation returns paginated results.

Synopsis

data ListAccountSettings = ListAccountSettings' {
- effectiveSettings :: Maybe Bool
- maxResults :: Maybe Int
- name :: Maybe SettingName
- nextToken :: Maybe Text
- principalArn :: Maybe Text
- value :: Maybe Text
}
newListAccountSettings :: ListAccountSettings
listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool)
listAccountSettings_maxResults :: Lens' ListAccountSettings (Maybe Int)
listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName)
listAccountSettings_nextToken :: Lens' ListAccountSettings (Maybe Text)
listAccountSettings_principalArn :: Lens' ListAccountSettings (Maybe Text)
listAccountSettings_value :: Lens' ListAccountSettings (Maybe Text)
data ListAccountSettingsResponse = ListAccountSettingsResponse' {
- nextToken :: Maybe Text
- settings :: Maybe [Setting]
- httpStatus :: Int
}
newListAccountSettingsResponse :: Int -> ListAccountSettingsResponse
listAccountSettingsResponse_nextToken :: Lens' ListAccountSettingsResponse (Maybe Text)
listAccountSettingsResponse_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting])
listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int

Creating a Request

data ListAccountSettings Source #

See: newListAccountSettings smart constructor.

Constructors

ListAccountSettings'

Fields

effectiveSettings :: Maybe 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.
maxResults :: Maybe 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 :: Maybe SettingName
The name of the account setting you want to list the settings for.
nextToken :: Maybe Text
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.
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.
principalArn :: Maybe Text
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.
value :: Maybe Text
The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

Instances

Instances details

ToJSON ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods toJSON :: ListAccountSettings -> Value # toEncoding :: ListAccountSettings -> Encoding # toJSONList :: [ListAccountSettings] -> Value # toEncodingList :: [ListAccountSettings] -> Encoding #
ToHeaders ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods toHeaders :: ListAccountSettings -> [Header] #
ToPath ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods toPath :: ListAccountSettings -> ByteString #
ToQuery ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods toQuery :: ListAccountSettings -> QueryString #
AWSPager ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods page :: ListAccountSettings -> AWSResponse ListAccountSettings -> Maybe ListAccountSettings #
AWSRequest ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Associated Types type AWSResponse ListAccountSettings # Methods request :: (Service -> Service) -> ListAccountSettings -> Request ListAccountSettings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAccountSettings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccountSettings))) #
Generic ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Associated Types type Rep ListAccountSettings :: Type -> Type # Methods from :: ListAccountSettings -> Rep ListAccountSettings x # to :: Rep ListAccountSettings x -> ListAccountSettings #
Read ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods readsPrec :: Int -> ReadS ListAccountSettings # readList :: ReadS [ListAccountSettings] # readPrec :: ReadPrec ListAccountSettings # readListPrec :: ReadPrec [ListAccountSettings] #
Show ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods showsPrec :: Int -> ListAccountSettings -> ShowS # show :: ListAccountSettings -> String # showList :: [ListAccountSettings] -> ShowS #
NFData ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods rnf :: ListAccountSettings -> () #
Eq ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods (==) :: ListAccountSettings -> ListAccountSettings -> Bool # (/=) :: ListAccountSettings -> ListAccountSettings -> Bool #
Hashable ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods hashWithSalt :: Int -> ListAccountSettings -> Int # hash :: ListAccountSettings -> Int #
type AWSResponse ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings type AWSResponse ListAccountSettings = ListAccountSettingsResponse
type Rep ListAccountSettings Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings type Rep ListAccountSettings = D1 ('MetaData "ListAccountSettings" "Amazonka.ECS.ListAccountSettings" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListAccountSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "effectiveSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SettingName)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "principalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:effectiveSettings:ListAccountSettings', listAccountSettings_effectiveSettings - 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.

$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 isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

ListAccountSettings, listAccountSettings_name - The name of the account setting you want to list the settings for.

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's 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, 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.

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

Request Lenses

listAccountSettings_effectiveSettings :: Lens' ListAccountSettings (Maybe Bool) Source #

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.

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 isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

listAccountSettings_name :: Lens' ListAccountSettings (Maybe SettingName) Source #

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

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's 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_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_value :: Lens' ListAccountSettings (Maybe Text) Source #

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

Destructuring the Response

data ListAccountSettingsResponse Source #

See: newListAccountSettingsResponse smart constructor.

Constructors

ListAccountSettingsResponse'

Fields

nextToken :: Maybe Text
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.
settings :: Maybe [Setting]
The account settings for the resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListAccountSettingsResponse Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Associated Types type Rep ListAccountSettingsResponse :: Type -> Type # Methods from :: ListAccountSettingsResponse -> Rep ListAccountSettingsResponse x # to :: Rep ListAccountSettingsResponse x -> ListAccountSettingsResponse #
Read ListAccountSettingsResponse Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods readsPrec :: Int -> ReadS ListAccountSettingsResponse # readList :: ReadS [ListAccountSettingsResponse] # readPrec :: ReadPrec ListAccountSettingsResponse # readListPrec :: ReadPrec [ListAccountSettingsResponse] #
Show ListAccountSettingsResponse Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods showsPrec :: Int -> ListAccountSettingsResponse -> ShowS # show :: ListAccountSettingsResponse -> String # showList :: [ListAccountSettingsResponse] -> ShowS #
NFData ListAccountSettingsResponse Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods rnf :: ListAccountSettingsResponse -> () #
Eq ListAccountSettingsResponse Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings Methods (==) :: ListAccountSettingsResponse -> ListAccountSettingsResponse -> Bool # (/=) :: ListAccountSettingsResponse -> ListAccountSettingsResponse -> Bool #
type Rep ListAccountSettingsResponse Source #
Instance details Defined in Amazonka.ECS.ListAccountSettings type Rep ListAccountSettingsResponse = D1 ('MetaData "ListAccountSettingsResponse" "Amazonka.ECS.ListAccountSettings" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListAccountSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Setting])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAccountSettingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAccountSettingsResponse'`
-> ListAccountSettingsResponse

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:

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.

ListAccountSettingsResponse, listAccountSettingsResponse_settings - The account settings for the resource.

$sel:httpStatus:ListAccountSettingsResponse', listAccountSettingsResponse_httpStatus - The response's http status code.

Response Lenses

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_settings :: Lens' ListAccountSettingsResponse (Maybe [Setting]) Source #

The account settings for the resource.

listAccountSettingsResponse_httpStatus :: Lens' ListAccountSettingsResponse Int Source #

The response's http status code.