Amazonka.Config.DescribeOrganizationConfigRules

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.

For accounts within an organzation

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

This operation returns paginated results.

Creating a Request

data DescribeOrganizationConfigRules

See: newDescribeOrganizationConfigRules smart constructor.

Constructors

DescribeOrganizationConfigRules'

Fields

• 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.

• 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.

• 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.

Instances

ToJSON DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toJSON :: DescribeOrganizationConfigRules -> Value

toEncoding :: DescribeOrganizationConfigRules -> Encoding

toJSONList :: [DescribeOrganizationConfigRules] -> Value

toEncodingList :: [DescribeOrganizationConfigRules] -> Encoding

ToHeaders DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toHeaders :: DescribeOrganizationConfigRules -> [Header]

ToPath DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toPath :: DescribeOrganizationConfigRules -> ByteString

ToQuery DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

toQuery :: DescribeOrganizationConfigRules -> QueryString

AWSPager DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

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

AWSRequest DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Associated Types

type AWSResponse DescribeOrganizationConfigRules

Methods

request :: (Service -> Service) -> DescribeOrganizationConfigRules -> Request DescribeOrganizationConfigRules

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

Generic DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Associated Types

type Rep DescribeOrganizationConfigRules :: Type -> Type

Methods

from :: DescribeOrganizationConfigRules -> Rep DescribeOrganizationConfigRules x

to :: Rep DescribeOrganizationConfigRules x -> DescribeOrganizationConfigRules

Read DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

readsPrec :: Int -> ReadS DescribeOrganizationConfigRules

readList :: ReadS [DescribeOrganizationConfigRules]

readPrec :: ReadPrec DescribeOrganizationConfigRules

readListPrec :: ReadPrec [DescribeOrganizationConfigRules]

Show DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

showsPrec :: Int -> DescribeOrganizationConfigRules -> ShowS

show :: DescribeOrganizationConfigRules -> String

showList :: [DescribeOrganizationConfigRules] -> ShowS

NFData DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

rnf :: DescribeOrganizationConfigRules -> ()

Eq DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

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

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

Hashable DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

hashWithSalt :: Int -> DescribeOrganizationConfigRules -> Int

hash :: DescribeOrganizationConfigRules -> Int

type AWSResponse DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

type AWSResponse DescribeOrganizationConfigRules = DescribeOrganizationConfigRulesResponse

type Rep DescribeOrganizationConfigRules

Defined in Amazonka.Config.DescribeOrganizationConfigRules

type Rep DescribeOrganizationConfigRules = D1 ('MetaData "DescribeOrganizationConfigRules" "Amazonka.Config.DescribeOrganizationConfigRules" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeOrganizationConfigRules'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organizationConfigRuleNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeOrganizationConfigRules :: DescribeOrganizationConfigRules

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: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.

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: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.

Request Lenses

describeOrganizationConfigRules_limit :: Lens' DescribeOrganizationConfigRules (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.

describeOrganizationConfigRules_nextToken :: Lens' DescribeOrganizationConfigRules (Maybe Text)

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

describeOrganizationConfigRules_organizationConfigRuleNames :: Lens' DescribeOrganizationConfigRules (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.

Destructuring the Response

data DescribeOrganizationConfigRulesResponse

See: newDescribeOrganizationConfigRulesResponse smart constructor.

Constructors

DescribeOrganizationConfigRulesResponse'

Fields

• 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.

• organizationConfigRules :: Maybe [OrganizationConfigRule]

  Returns a list of OrganizationConfigRule objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeOrganizationConfigRulesResponse

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Associated Types

type Rep DescribeOrganizationConfigRulesResponse :: Type -> Type

Methods

from :: DescribeOrganizationConfigRulesResponse -> Rep DescribeOrganizationConfigRulesResponse x

to :: Rep DescribeOrganizationConfigRulesResponse x -> DescribeOrganizationConfigRulesResponse

Read DescribeOrganizationConfigRulesResponse

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

readsPrec :: Int -> ReadS DescribeOrganizationConfigRulesResponse

readList :: ReadS [DescribeOrganizationConfigRulesResponse]

readPrec :: ReadPrec DescribeOrganizationConfigRulesResponse

readListPrec :: ReadPrec [DescribeOrganizationConfigRulesResponse]

Show DescribeOrganizationConfigRulesResponse

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

showsPrec :: Int -> DescribeOrganizationConfigRulesResponse -> ShowS

show :: DescribeOrganizationConfigRulesResponse -> String

showList :: [DescribeOrganizationConfigRulesResponse] -> ShowS

NFData DescribeOrganizationConfigRulesResponse

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

rnf :: DescribeOrganizationConfigRulesResponse -> ()

Eq DescribeOrganizationConfigRulesResponse

Defined in Amazonka.Config.DescribeOrganizationConfigRules

Methods

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

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

type Rep DescribeOrganizationConfigRulesResponse

Defined in Amazonka.Config.DescribeOrganizationConfigRules

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

newDescribeOrganizationConfigRulesResponse

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:

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

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

Response Lenses

describeOrganizationConfigRulesResponse_nextToken :: Lens' DescribeOrganizationConfigRulesResponse (Maybe Text)

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

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

Returns a list of OrganizationConfigRule objects.

describeOrganizationConfigRulesResponse_httpStatus :: Lens' DescribeOrganizationConfigRulesResponse Int

The response's http status code.