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 |
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.
Synopsis
- data DescribeOrganizationConfigRules = DescribeOrganizationConfigRules' {}
- newDescribeOrganizationConfigRules :: DescribeOrganizationConfigRules
- describeOrganizationConfigRules_limit :: Lens' DescribeOrganizationConfigRules (Maybe Natural)
- describeOrganizationConfigRules_nextToken :: Lens' DescribeOrganizationConfigRules (Maybe Text)
- describeOrganizationConfigRules_organizationConfigRuleNames :: Lens' DescribeOrganizationConfigRules (Maybe [Text])
- data DescribeOrganizationConfigRulesResponse = DescribeOrganizationConfigRulesResponse' {}
- newDescribeOrganizationConfigRulesResponse :: Int -> DescribeOrganizationConfigRulesResponse
- describeOrganizationConfigRulesResponse_nextToken :: Lens' DescribeOrganizationConfigRulesResponse (Maybe Text)
- describeOrganizationConfigRulesResponse_organizationConfigRules :: Lens' DescribeOrganizationConfigRulesResponse (Maybe [OrganizationConfigRule])
- describeOrganizationConfigRulesResponse_httpStatus :: Lens' DescribeOrganizationConfigRulesResponse Int
Creating a Request
data DescribeOrganizationConfigRules Source #
See: newDescribeOrganizationConfigRules
smart constructor.
DescribeOrganizationConfigRules' | |
|
Instances
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: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) 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.
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_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.
Destructuring the Response
data DescribeOrganizationConfigRulesResponse Source #
See: newDescribeOrganizationConfigRulesResponse
smart constructor.
DescribeOrganizationConfigRulesResponse' | |
|
Instances
newDescribeOrganizationConfigRulesResponse Source #
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) Source #
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]) Source #
Returns a list of OrganizationConfigRule
objects.
describeOrganizationConfigRulesResponse_httpStatus :: Lens' DescribeOrganizationConfigRulesResponse Int Source #
The response's http status code.