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

Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides organization config rule deployment status for an organization.

The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

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 DescribeOrganizationConfigRuleStatuses Source #

See: newDescribeOrganizationConfigRuleStatuses smart constructor.

Constructors

DescribeOrganizationConfigRuleStatuses'

Fields

organizationConfigRuleNames :: Maybe [Text]
The names of organization config rules for which you want status 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 OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

Instances

Instances details

Eq DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods (==) :: DescribeOrganizationConfigRuleStatuses -> DescribeOrganizationConfigRuleStatuses -> Bool # (/=) :: DescribeOrganizationConfigRuleStatuses -> DescribeOrganizationConfigRuleStatuses -> Bool #
Read DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods readsPrec :: Int -> ReadS DescribeOrganizationConfigRuleStatuses # readList :: ReadS [DescribeOrganizationConfigRuleStatuses] # readPrec :: ReadPrec DescribeOrganizationConfigRuleStatuses # readListPrec :: ReadPrec [DescribeOrganizationConfigRuleStatuses] #
Show DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods showsPrec :: Int -> DescribeOrganizationConfigRuleStatuses -> ShowS # show :: DescribeOrganizationConfigRuleStatuses -> String # showList :: [DescribeOrganizationConfigRuleStatuses] -> ShowS #
Generic DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Associated Types type Rep DescribeOrganizationConfigRuleStatuses :: Type -> Type # Methods from :: DescribeOrganizationConfigRuleStatuses -> Rep DescribeOrganizationConfigRuleStatuses x # to :: Rep DescribeOrganizationConfigRuleStatuses x -> DescribeOrganizationConfigRuleStatuses #
NFData DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods rnf :: DescribeOrganizationConfigRuleStatuses -> () #
Hashable DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods hashWithSalt :: Int -> DescribeOrganizationConfigRuleStatuses -> Int # hash :: DescribeOrganizationConfigRuleStatuses -> Int #
ToJSON DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods toJSON :: DescribeOrganizationConfigRuleStatuses -> Value # toEncoding :: DescribeOrganizationConfigRuleStatuses -> Encoding # toJSONList :: [DescribeOrganizationConfigRuleStatuses] -> Value # toEncodingList :: [DescribeOrganizationConfigRuleStatuses] -> Encoding #
AWSPager DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods page :: DescribeOrganizationConfigRuleStatuses -> AWSResponse DescribeOrganizationConfigRuleStatuses -> Maybe DescribeOrganizationConfigRuleStatuses #
AWSRequest DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Associated Types type AWSResponse DescribeOrganizationConfigRuleStatuses # Methods request :: DescribeOrganizationConfigRuleStatuses -> Request DescribeOrganizationConfigRuleStatuses # response :: MonadResource m => Logger -> Service -> Proxy DescribeOrganizationConfigRuleStatuses -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOrganizationConfigRuleStatuses))) #
ToHeaders DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods toHeaders :: DescribeOrganizationConfigRuleStatuses -> [Header] #
ToPath DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods toPath :: DescribeOrganizationConfigRuleStatuses -> ByteString #
ToQuery DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods toQuery :: DescribeOrganizationConfigRuleStatuses -> QueryString #
type Rep DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses type Rep DescribeOrganizationConfigRuleStatuses = D1 ('MetaData "DescribeOrganizationConfigRuleStatuses" "Amazonka.Config.DescribeOrganizationConfigRuleStatuses" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "DescribeOrganizationConfigRuleStatuses'" '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 DescribeOrganizationConfigRuleStatuses Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses type AWSResponse DescribeOrganizationConfigRuleStatuses = DescribeOrganizationConfigRuleStatusesResponse

newDescribeOrganizationConfigRuleStatuses :: DescribeOrganizationConfigRuleStatuses Source #

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

$sel:nextToken:DescribeOrganizationConfigRuleStatuses', describeOrganizationConfigRuleStatuses_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:DescribeOrganizationConfigRuleStatuses', describeOrganizationConfigRuleStatuses_limit - The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

Request Lenses

describeOrganizationConfigRuleStatuses_organizationConfigRuleNames :: Lens' DescribeOrganizationConfigRuleStatuses (Maybe [Text]) Source #

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

describeOrganizationConfigRuleStatuses_nextToken :: Lens' DescribeOrganizationConfigRuleStatuses (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.

describeOrganizationConfigRuleStatuses_limit :: Lens' DescribeOrganizationConfigRuleStatuses (Maybe Natural) Source #

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

Destructuring the Response

data DescribeOrganizationConfigRuleStatusesResponse Source #

See: newDescribeOrganizationConfigRuleStatusesResponse smart constructor.

Constructors

DescribeOrganizationConfigRuleStatusesResponse'
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. organizationConfigRuleStatuses :: Maybe [OrganizationConfigRuleStatus] A list of `OrganizationConfigRuleStatus` objects. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeOrganizationConfigRuleStatusesResponse Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods (==) :: DescribeOrganizationConfigRuleStatusesResponse -> DescribeOrganizationConfigRuleStatusesResponse -> Bool # (/=) :: DescribeOrganizationConfigRuleStatusesResponse -> DescribeOrganizationConfigRuleStatusesResponse -> Bool #
Read DescribeOrganizationConfigRuleStatusesResponse Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods readsPrec :: Int -> ReadS DescribeOrganizationConfigRuleStatusesResponse # readList :: ReadS [DescribeOrganizationConfigRuleStatusesResponse] # readPrec :: ReadPrec DescribeOrganizationConfigRuleStatusesResponse # readListPrec :: ReadPrec [DescribeOrganizationConfigRuleStatusesResponse] #
Show DescribeOrganizationConfigRuleStatusesResponse Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods showsPrec :: Int -> DescribeOrganizationConfigRuleStatusesResponse -> ShowS # show :: DescribeOrganizationConfigRuleStatusesResponse -> String # showList :: [DescribeOrganizationConfigRuleStatusesResponse] -> ShowS #
Generic DescribeOrganizationConfigRuleStatusesResponse Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Associated Types type Rep DescribeOrganizationConfigRuleStatusesResponse :: Type -> Type # Methods from :: DescribeOrganizationConfigRuleStatusesResponse -> Rep DescribeOrganizationConfigRuleStatusesResponse x # to :: Rep DescribeOrganizationConfigRuleStatusesResponse x -> DescribeOrganizationConfigRuleStatusesResponse #
NFData DescribeOrganizationConfigRuleStatusesResponse Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses Methods rnf :: DescribeOrganizationConfigRuleStatusesResponse -> () #
type Rep DescribeOrganizationConfigRuleStatusesResponse Source #
Instance details Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses type Rep DescribeOrganizationConfigRuleStatusesResponse = D1 ('MetaData "DescribeOrganizationConfigRuleStatusesResponse" "Amazonka.Config.DescribeOrganizationConfigRuleStatuses" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "DescribeOrganizationConfigRuleStatusesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "organizationConfigRuleStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrganizationConfigRuleStatus])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOrganizationConfigRuleStatusesResponse Source #

Arguments

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

Create a value of DescribeOrganizationConfigRuleStatusesResponse 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:nextToken:DescribeOrganizationConfigRuleStatuses', describeOrganizationConfigRuleStatusesResponse_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:organizationConfigRuleStatuses:DescribeOrganizationConfigRuleStatusesResponse', describeOrganizationConfigRuleStatusesResponse_organizationConfigRuleStatuses - A list of OrganizationConfigRuleStatus objects.

$sel:httpStatus:DescribeOrganizationConfigRuleStatusesResponse', describeOrganizationConfigRuleStatusesResponse_httpStatus - The response's http status code.

Response Lenses

describeOrganizationConfigRuleStatusesResponse_nextToken :: Lens' DescribeOrganizationConfigRuleStatusesResponse (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.

describeOrganizationConfigRuleStatusesResponse_organizationConfigRuleStatuses :: Lens' DescribeOrganizationConfigRuleStatusesResponse (Maybe [OrganizationConfigRuleStatus]) Source #

A list of OrganizationConfigRuleStatus objects.

describeOrganizationConfigRuleStatusesResponse_httpStatus :: Lens' DescribeOrganizationConfigRuleStatusesResponse Int Source #

The response's http status code.