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.Config.PutConfigurationAggregator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.

Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

Synopsis

Creating a Request

data PutConfigurationAggregator Source #

See: newPutConfigurationAggregator smart constructor.

Constructors

PutConfigurationAggregator'
Fields accountAggregationSources :: Maybe [AccountAggregationSource] A list of AccountAggregationSource object. organizationAggregationSource :: Maybe OrganizationAggregationSource An OrganizationAggregationSource object. tags :: Maybe [Tag] An array of tag object. configurationAggregatorName :: Text The name of the configuration aggregator.

Instances

Instances details

ToJSON PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods toJSON :: PutConfigurationAggregator -> Value # toEncoding :: PutConfigurationAggregator -> Encoding # toJSONList :: [PutConfigurationAggregator] -> Value # toEncodingList :: [PutConfigurationAggregator] -> Encoding #
ToHeaders PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods toHeaders :: PutConfigurationAggregator -> [Header] #
ToPath PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods toPath :: PutConfigurationAggregator -> ByteString #
ToQuery PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods toQuery :: PutConfigurationAggregator -> QueryString #
AWSRequest PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Associated Types type AWSResponse PutConfigurationAggregator # Methods request :: (Service -> Service) -> PutConfigurationAggregator -> Request PutConfigurationAggregator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutConfigurationAggregator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutConfigurationAggregator))) #
Generic PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Associated Types type Rep PutConfigurationAggregator :: Type -> Type # Methods from :: PutConfigurationAggregator -> Rep PutConfigurationAggregator x # to :: Rep PutConfigurationAggregator x -> PutConfigurationAggregator #
Read PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods readsPrec :: Int -> ReadS PutConfigurationAggregator # readList :: ReadS [PutConfigurationAggregator] # readPrec :: ReadPrec PutConfigurationAggregator # readListPrec :: ReadPrec [PutConfigurationAggregator] #
Show PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods showsPrec :: Int -> PutConfigurationAggregator -> ShowS # show :: PutConfigurationAggregator -> String # showList :: [PutConfigurationAggregator] -> ShowS #
NFData PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods rnf :: PutConfigurationAggregator -> () #
Eq PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods (==) :: PutConfigurationAggregator -> PutConfigurationAggregator -> Bool # (/=) :: PutConfigurationAggregator -> PutConfigurationAggregator -> Bool #
Hashable PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods hashWithSalt :: Int -> PutConfigurationAggregator -> Int # hash :: PutConfigurationAggregator -> Int #
type AWSResponse PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator type AWSResponse PutConfigurationAggregator = PutConfigurationAggregatorResponse
type Rep PutConfigurationAggregator Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator type Rep PutConfigurationAggregator = D1 ('MetaData "PutConfigurationAggregator" "Amazonka.Config.PutConfigurationAggregator" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutConfigurationAggregator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountAggregationSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccountAggregationSource])) :: S1 ('MetaSel ('Just "organizationAggregationSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationAggregationSource))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "configurationAggregatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutConfigurationAggregator Source #

Arguments

:: Text	`PutConfigurationAggregator`
-> PutConfigurationAggregator

Create a value of PutConfigurationAggregator 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:

PutConfigurationAggregator, putConfigurationAggregator_accountAggregationSources - A list of AccountAggregationSource object.

PutConfigurationAggregator, putConfigurationAggregator_organizationAggregationSource - An OrganizationAggregationSource object.

PutConfigurationAggregator, putConfigurationAggregator_tags - An array of tag object.

PutConfigurationAggregator, putConfigurationAggregator_configurationAggregatorName - The name of the configuration aggregator.

Request Lenses

putConfigurationAggregator_accountAggregationSources :: Lens' PutConfigurationAggregator (Maybe [AccountAggregationSource]) Source #

A list of AccountAggregationSource object.

putConfigurationAggregator_organizationAggregationSource :: Lens' PutConfigurationAggregator (Maybe OrganizationAggregationSource) Source #

An OrganizationAggregationSource object.

putConfigurationAggregator_tags :: Lens' PutConfigurationAggregator (Maybe [Tag]) Source #

An array of tag object.

putConfigurationAggregator_configurationAggregatorName :: Lens' PutConfigurationAggregator Text Source #

The name of the configuration aggregator.

Destructuring the Response

data PutConfigurationAggregatorResponse Source #

See: newPutConfigurationAggregatorResponse smart constructor.

Constructors

PutConfigurationAggregatorResponse'
Fields configurationAggregator :: Maybe ConfigurationAggregator Returns a ConfigurationAggregator object. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutConfigurationAggregatorResponse Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Associated Types type Rep PutConfigurationAggregatorResponse :: Type -> Type # Methods from :: PutConfigurationAggregatorResponse -> Rep PutConfigurationAggregatorResponse x # to :: Rep PutConfigurationAggregatorResponse x -> PutConfigurationAggregatorResponse #
Read PutConfigurationAggregatorResponse Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods readsPrec :: Int -> ReadS PutConfigurationAggregatorResponse # readList :: ReadS [PutConfigurationAggregatorResponse] # readPrec :: ReadPrec PutConfigurationAggregatorResponse # readListPrec :: ReadPrec [PutConfigurationAggregatorResponse] #
Show PutConfigurationAggregatorResponse Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods showsPrec :: Int -> PutConfigurationAggregatorResponse -> ShowS # show :: PutConfigurationAggregatorResponse -> String # showList :: [PutConfigurationAggregatorResponse] -> ShowS #
NFData PutConfigurationAggregatorResponse Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods rnf :: PutConfigurationAggregatorResponse -> () #
Eq PutConfigurationAggregatorResponse Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator Methods (==) :: PutConfigurationAggregatorResponse -> PutConfigurationAggregatorResponse -> Bool # (/=) :: PutConfigurationAggregatorResponse -> PutConfigurationAggregatorResponse -> Bool #
type Rep PutConfigurationAggregatorResponse Source #
Instance details Defined in Amazonka.Config.PutConfigurationAggregator type Rep PutConfigurationAggregatorResponse = D1 ('MetaData "PutConfigurationAggregatorResponse" "Amazonka.Config.PutConfigurationAggregator" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutConfigurationAggregatorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationAggregator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationAggregator)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutConfigurationAggregatorResponse Source #

Arguments

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

Create a value of PutConfigurationAggregatorResponse 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:configurationAggregator:PutConfigurationAggregatorResponse', putConfigurationAggregatorResponse_configurationAggregator - Returns a ConfigurationAggregator object.

$sel:httpStatus:PutConfigurationAggregatorResponse', putConfigurationAggregatorResponse_httpStatus - The response's http status code.

Response Lenses

putConfigurationAggregatorResponse_configurationAggregator :: Lens' PutConfigurationAggregatorResponse (Maybe ConfigurationAggregator) Source #

Returns a ConfigurationAggregator object.

putConfigurationAggregatorResponse_httpStatus :: Lens' PutConfigurationAggregatorResponse Int Source #

The response's http status code.