amazonka-config-2.0: Amazon Config SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Config.DescribeOrganizationConfigRuleStatuses

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 #

Constructors

DescribeOrganizationConfigRuleStatuses' 

Fields

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

  • 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 status details. If you do not specify any names, Config returns details for all your organization Config rules.

Instances

Instances details
ToJSON DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

ToHeaders DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

ToPath DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

ToQuery DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

AWSPager DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

AWSRequest DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Generic DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Read DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Show DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

NFData DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Eq DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Hashable DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

type AWSResponse DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

type Rep DescribeOrganizationConfigRuleStatuses Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

type Rep DescribeOrganizationConfigRuleStatuses = D1 ('MetaData "DescribeOrganizationConfigRuleStatuses" "Amazonka.Config.DescribeOrganizationConfigRuleStatuses" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeOrganizationConfigRuleStatuses'" '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])))))

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

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

Request Lenses

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.

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

Destructuring the Response

data DescribeOrganizationConfigRuleStatusesResponse Source #

Constructors

DescribeOrganizationConfigRuleStatusesResponse' 

Fields

Instances

Instances details
Generic DescribeOrganizationConfigRuleStatusesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Read DescribeOrganizationConfigRuleStatusesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Show DescribeOrganizationConfigRuleStatusesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

NFData DescribeOrganizationConfigRuleStatusesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

Eq DescribeOrganizationConfigRuleStatusesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

type Rep DescribeOrganizationConfigRuleStatusesResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeOrganizationConfigRuleStatuses

type Rep DescribeOrganizationConfigRuleStatusesResponse = D1 ('MetaData "DescribeOrganizationConfigRuleStatusesResponse" "Amazonka.Config.DescribeOrganizationConfigRuleStatuses" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" '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 #

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:

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.