libZSservicesZSamazonka-configZSamazonka-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Config.DescribeOrganizationConfigRules

Description

Returns a list of organization config rules.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeOrganizationConfigRules Source #

See: newDescribeOrganizationConfigRules smart constructor.

Constructors

DescribeOrganizationConfigRules' 

Fields

  • organizationConfigRuleNames :: Maybe [Text]

    The names of organization config rules for which you want details. If you do not specify any names, Config returns details for all your organization config rules.

  • nextToken :: Maybe Text

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

  • limit :: Maybe Natural

    The maximum number of organization config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

Instances

Instances details
Eq DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

(==) :: DescribeOrganizationConfigRules -> DescribeOrganizationConfigRules -> Bool #

(/=) :: DescribeOrganizationConfigRules -> DescribeOrganizationConfigRules -> Bool #

Read DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

readsPrec :: Int -> ReadS DescribeOrganizationConfigRules #

readList :: ReadS [DescribeOrganizationConfigRules] #

readPrec :: ReadPrec DescribeOrganizationConfigRules #

readListPrec :: ReadPrec [DescribeOrganizationConfigRules] #

Show DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

showsPrec :: Int -> DescribeOrganizationConfigRules -> ShowS #

show :: DescribeOrganizationConfigRules -> String #

showList :: [DescribeOrganizationConfigRules] -> ShowS #

Generic DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Associated Types

type Rep DescribeOrganizationConfigRules :: Type -> Type #

Methods

from :: DescribeOrganizationConfigRules -> Rep DescribeOrganizationConfigRules x #

to :: Rep DescribeOrganizationConfigRules x -> DescribeOrganizationConfigRules #

NFData DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

rnf :: DescribeOrganizationConfigRules -> () #

Hashable DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

hashWithSalt :: Int -> DescribeOrganizationConfigRules -> Int #

hash :: DescribeOrganizationConfigRules -> Int #

ToJSON DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toJSON :: DescribeOrganizationConfigRules -> Value #

toEncoding :: DescribeOrganizationConfigRules -> Encoding #

toJSONList :: [DescribeOrganizationConfigRules] -> Value #

toEncodingList :: [DescribeOrganizationConfigRules] -> Encoding #

AWSPager DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

page :: DescribeOrganizationConfigRules -> AWSResponse DescribeOrganizationConfigRules -> Maybe DescribeOrganizationConfigRules #

AWSRequest DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Associated Types

type AWSResponse DescribeOrganizationConfigRules #

Methods

request :: DescribeOrganizationConfigRules -> Request DescribeOrganizationConfigRules #

response :: MonadResource m => Logger -> Service -> Proxy DescribeOrganizationConfigRules -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOrganizationConfigRules))) #

ToHeaders DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toHeaders :: DescribeOrganizationConfigRules -> [Header] #

ToPath DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toPath :: DescribeOrganizationConfigRules -> ByteString #

ToQuery DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toQuery :: DescribeOrganizationConfigRules -> QueryString #

type Rep DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

type Rep DescribeOrganizationConfigRules = D1 ('MetaData "DescribeOrganizationConfigRules" "Amazonka.Config.DescribeOrganizationConfigRules" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "DescribeOrganizationConfigRules'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationConfigRuleNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeOrganizationConfigRules Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

type AWSResponse DescribeOrganizationConfigRules = DescribeOrganizationConfigRulesResponse

newDescribeOrganizationConfigRules :: DescribeOrganizationConfigRules Source #

Create a value of DescribeOrganizationConfigRules 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:organizationConfigRuleNames:DescribeOrganizationConfigRules', describeOrganizationConfigRules_organizationConfigRuleNames - The names of organization config rules for which you want details. If you do not specify any names, Config returns details for all your organization config rules.

$sel:nextToken:DescribeOrganizationConfigRules', describeOrganizationConfigRules_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:limit:DescribeOrganizationConfigRules', describeOrganizationConfigRules_limit - The maximum number of organization config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

Request Lenses

describeOrganizationConfigRules_organizationConfigRuleNames :: Lens' DescribeOrganizationConfigRules (Maybe [Text]) Source #

The names of organization config rules for which you want details. If you do not specify any names, Config returns details for all your organization config rules.

describeOrganizationConfigRules_nextToken :: Lens' DescribeOrganizationConfigRules (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeOrganizationConfigRules_limit :: Lens' DescribeOrganizationConfigRules (Maybe Natural) Source #

The maximum number of organization config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

Destructuring the Response

data DescribeOrganizationConfigRulesResponse Source #

See: newDescribeOrganizationConfigRulesResponse smart constructor.

Constructors

DescribeOrganizationConfigRulesResponse' 

Fields

Instances

Instances details
Eq DescribeOrganizationConfigRulesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

(==) :: DescribeOrganizationConfigRulesResponse -> DescribeOrganizationConfigRulesResponse -> Bool #

(/=) :: DescribeOrganizationConfigRulesResponse -> DescribeOrganizationConfigRulesResponse -> Bool #

Read DescribeOrganizationConfigRulesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

readsPrec :: Int -> ReadS DescribeOrganizationConfigRulesResponse #

readList :: ReadS [DescribeOrganizationConfigRulesResponse] #

readPrec :: ReadPrec DescribeOrganizationConfigRulesResponse #

readListPrec :: ReadPrec [DescribeOrganizationConfigRulesResponse] #

Show DescribeOrganizationConfigRulesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

showsPrec :: Int -> DescribeOrganizationConfigRulesResponse -> ShowS #

show :: DescribeOrganizationConfigRulesResponse -> String #

showList :: [DescribeOrganizationConfigRulesResponse] -> ShowS #

Generic DescribeOrganizationConfigRulesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Associated Types

type Rep DescribeOrganizationConfigRulesResponse :: Type -> Type #

Methods

from :: DescribeOrganizationConfigRulesResponse -> Rep DescribeOrganizationConfigRulesResponse x #

to :: Rep DescribeOrganizationConfigRulesResponse x -> DescribeOrganizationConfigRulesResponse #

NFData DescribeOrganizationConfigRulesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

rnf :: DescribeOrganizationConfigRulesResponse -> () #

type Rep DescribeOrganizationConfigRulesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRules

type Rep DescribeOrganizationConfigRulesResponse = D1 ('MetaData "DescribeOrganizationConfigRulesResponse" "Amazonka.Config.DescribeOrganizationConfigRules" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "DescribeOrganizationConfigRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationConfigRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrganizationConfigRule])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOrganizationConfigRulesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeOrganizationConfigRulesResponse'

-> DescribeOrganizationConfigRulesResponse 

Create a value of DescribeOrganizationConfigRulesResponse 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:organizationConfigRules:DescribeOrganizationConfigRulesResponse', describeOrganizationConfigRulesResponse_organizationConfigRules - Returns a list of OrganizationConfigRule objects.

$sel:nextToken:DescribeOrganizationConfigRules', describeOrganizationConfigRulesResponse_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:httpStatus:DescribeOrganizationConfigRulesResponse', describeOrganizationConfigRulesResponse_httpStatus - The response's http status code.

Response Lenses

describeOrganizationConfigRulesResponse_organizationConfigRules :: Lens' DescribeOrganizationConfigRulesResponse (Maybe [OrganizationConfigRule]) Source #

Returns a list of OrganizationConfigRule objects.

describeOrganizationConfigRulesResponse_nextToken :: Lens' DescribeOrganizationConfigRulesResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeOrganizationConfigRulesResponse_httpStatus :: Lens' DescribeOrganizationConfigRulesResponse Int Source #

The response's http status code.