Skip to content

Commit 2949a13

Browse files
author
awstools
committed
docs(client-config-service): Updating documentation service limits
1 parent dfd16d6 commit 2949a13

File tree

8 files changed

+163
-24
lines changed

8 files changed

+163
-24
lines changed

clients/client-config-service/src/ConfigService.ts

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1767,10 +1767,25 @@ export class ConfigService extends ConfigServiceClient {
17671767
* <p>Returns a list of organization Config rules. </p>
17681768
*
17691769
* <note>
1770-
* <p>When you specify the limit and the next token, you receive a paginated response.
1771-
* Limit and next token are not applicable if you specify organization Config rule names.
1770+
* <p>When you specify the limit and the next token, you receive a paginated response.</p>
1771+
* <p>Limit and next token are not applicable if you specify organization Config rule names.
17721772
* It is only applicable, when you request all the organization Config rules.</p>
1773-
* </note>
1773+
*
1774+
* <p>
1775+
* <i>For accounts within an organzation</i>
1776+
* </p>
1777+
*
1778+
* <p>If you deploy an organizational rule or conformance pack in an organization
1779+
* administrator account, and then establish a delegated administrator and deploy an
1780+
* organizational rule or conformance pack in the delegated administrator account, you
1781+
* won't be able to see the organizational rule or conformance pack in the organization
1782+
* administrator account from the delegated administrator account or see the organizational
1783+
* rule or conformance pack in the delegated administrator account from organization
1784+
* administrator account. The <code>DescribeOrganizationConfigRules</code> and
1785+
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
1786+
* the organization-related resource that were deployed from within the account calling
1787+
* those APIs.</p>
1788+
* </note>
17741789
*/
17751790
public describeOrganizationConfigRules(
17761791
args: DescribeOrganizationConfigRulesCommandInput,
@@ -1849,7 +1864,22 @@ export class ConfigService extends ConfigServiceClient {
18491864
* <p>When you specify the limit and the next token, you receive a paginated response. </p>
18501865
* <p>Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable,
18511866
* when you request all the organization conformance packs. </p>
1852-
* </note>
1867+
*
1868+
* <p>
1869+
* <i>For accounts within an organzation</i>
1870+
* </p>
1871+
*
1872+
* <p>If you deploy an organizational rule or conformance pack in an organization
1873+
* administrator account, and then establish a delegated administrator and deploy an
1874+
* organizational rule or conformance pack in the delegated administrator account, you
1875+
* won't be able to see the organizational rule or conformance pack in the organization
1876+
* administrator account from the delegated administrator account or see the organizational
1877+
* rule or conformance pack in the delegated administrator account from organization
1878+
* administrator account. The <code>DescribeOrganizationConfigRules</code> and
1879+
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
1880+
* the organization-related resource that were deployed from within the account calling
1881+
* those APIs.</p>
1882+
* </note>
18531883
*/
18541884
public describeOrganizationConformancePacks(
18551885
args: DescribeOrganizationConformancePacksCommandInput,
@@ -3338,10 +3368,13 @@ export class ConfigService extends ConfigServiceClient {
33383368
}
33393369

33403370
/**
3341-
* <p>Deploys conformance packs across member accounts in an Amazon Web Services Organization.</p>
3371+
* <p>Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account,
3372+
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
3373+
* <b>Service Limits</b>
3374+
* </a> in the Config Developer Guide.</p>
33423375
* <p>Only a master account and a delegated administrator can call this API.
33433376
* When calling this API with a delegated administrator, you must ensure Organizations
3344-
* <code>ListDelegatedAdministrator</code> permissions are added.</p>
3377+
* <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
33453378
* <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code>
33463379
* through the <code>EnableAWSServiceAccess</code> action and creates a
33473380
* service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
@@ -3357,7 +3390,6 @@ export class ConfigService extends ConfigServiceClient {
33573390
* If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
33583391
* <p>Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated.
33593392
* You cannot update a conformance pack while it is in this state.</p>
3360-
* <p>You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization. </p>
33613393
* </note>
33623394
*/
33633395
public putOrganizationConformancePack(
@@ -3401,6 +3433,10 @@ export class ConfigService extends ConfigServiceClient {
34013433
* <p>This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules,
34023434
* the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.</p>
34033435
* </note>
3436+
* <note>
3437+
* <p>For manual remediation configuration, you need to provide a value for <code>automationAssumeRole</code> or use a value in the <code>assumeRole</code>field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.</p>
3438+
* <p>However, for automatic remediation configuration, the only valid <code>assumeRole</code> field value is <code>AutomationAssumeRole</code> and you need to provide a value for <code>AutomationAssumeRole</code> to remediate your resources.</p>
3439+
* </note>
34043440
*/
34053441
public putRemediationConfigurations(
34063442
args: PutRemediationConfigurationsCommandInput,

clients/client-config-service/src/commands/DescribeOrganizationConfigRulesCommand.ts

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,25 @@ export interface DescribeOrganizationConfigRulesCommandOutput
2828
* <p>Returns a list of organization Config rules. </p>
2929
*
3030
* <note>
31-
* <p>When you specify the limit and the next token, you receive a paginated response.
32-
* Limit and next token are not applicable if you specify organization Config rule names.
31+
* <p>When you specify the limit and the next token, you receive a paginated response.</p>
32+
* <p>Limit and next token are not applicable if you specify organization Config rule names.
3333
* It is only applicable, when you request all the organization Config rules.</p>
34-
* </note>
34+
*
35+
* <p>
36+
* <i>For accounts within an organzation</i>
37+
* </p>
38+
*
39+
* <p>If you deploy an organizational rule or conformance pack in an organization
40+
* administrator account, and then establish a delegated administrator and deploy an
41+
* organizational rule or conformance pack in the delegated administrator account, you
42+
* won't be able to see the organizational rule or conformance pack in the organization
43+
* administrator account from the delegated administrator account or see the organizational
44+
* rule or conformance pack in the delegated administrator account from organization
45+
* administrator account. The <code>DescribeOrganizationConfigRules</code> and
46+
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
47+
* the organization-related resource that were deployed from within the account calling
48+
* those APIs.</p>
49+
* </note>
3550
* @example
3651
* Use a bare-bones client and the command you need to make an API call.
3752
* ```javascript

clients/client-config-service/src/commands/DescribeOrganizationConformancePacksCommand.ts

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,22 @@ export interface DescribeOrganizationConformancePacksCommandOutput
3333
* <p>When you specify the limit and the next token, you receive a paginated response. </p>
3434
* <p>Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable,
3535
* when you request all the organization conformance packs. </p>
36-
* </note>
36+
*
37+
* <p>
38+
* <i>For accounts within an organzation</i>
39+
* </p>
40+
*
41+
* <p>If you deploy an organizational rule or conformance pack in an organization
42+
* administrator account, and then establish a delegated administrator and deploy an
43+
* organizational rule or conformance pack in the delegated administrator account, you
44+
* won't be able to see the organizational rule or conformance pack in the organization
45+
* administrator account from the delegated administrator account or see the organizational
46+
* rule or conformance pack in the delegated administrator account from organization
47+
* administrator account. The <code>DescribeOrganizationConfigRules</code> and
48+
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
49+
* the organization-related resource that were deployed from within the account calling
50+
* those APIs.</p>
51+
* </note>
3752
* @example
3853
* Use a bare-bones client and the command you need to make an API call.
3954
* ```javascript

clients/client-config-service/src/commands/PutOrganizationConformancePackCommand.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,13 @@ export interface PutOrganizationConformancePackCommandOutput
2525
__MetadataBearer {}
2626

2727
/**
28-
* <p>Deploys conformance packs across member accounts in an Amazon Web Services Organization.</p>
28+
* <p>Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account,
29+
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
30+
* <b>Service Limits</b>
31+
* </a> in the Config Developer Guide.</p>
2932
* <p>Only a master account and a delegated administrator can call this API.
3033
* When calling this API with a delegated administrator, you must ensure Organizations
31-
* <code>ListDelegatedAdministrator</code> permissions are added.</p>
34+
* <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
3235
* <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code>
3336
* through the <code>EnableAWSServiceAccess</code> action and creates a
3437
* service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
@@ -44,7 +47,6 @@ export interface PutOrganizationConformancePackCommandOutput
4447
* If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
4548
* <p>Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated.
4649
* You cannot update a conformance pack while it is in this state.</p>
47-
* <p>You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization. </p>
4850
* </note>
4951
* @example
5052
* Use a bare-bones client and the command you need to make an API call.

clients/client-config-service/src/commands/PutRemediationConfigurationsCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ export interface PutRemediationConfigurationsCommandOutput
3636
* <p>This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules,
3737
* the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.</p>
3838
* </note>
39+
* <note>
40+
* <p>For manual remediation configuration, you need to provide a value for <code>automationAssumeRole</code> or use a value in the <code>assumeRole</code>field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.</p>
41+
* <p>However, for automatic remediation configuration, the only valid <code>assumeRole</code> field value is <code>AutomationAssumeRole</code> and you need to provide a value for <code>AutomationAssumeRole</code> to remediate your resources.</p>
42+
* </note>
3943
* @example
4044
* Use a bare-bones client and the command you need to make an API call.
4145
* ```javascript

clients/client-config-service/src/models/models_0.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1565,7 +1565,7 @@ export interface ConfigRule {
15651565
* <code>MaximumExecutionFrequency</code> when:</p>
15661566
* <ul>
15671567
* <li>
1568-
* <p>You are using an Config managed rule that is triggered at
1568+
* <p>This is for an Config managed rule that is triggered at
15691569
* a periodic frequency.</p>
15701570
* </li>
15711571
* <li>
@@ -2305,6 +2305,9 @@ export interface ConfigurationRecorder {
23052305
/**
23062306
* <p>Amazon Resource Name (ARN) of the IAM role used to describe the
23072307
* Amazon Web Services resources associated with the account.</p>
2308+
* <note>
2309+
* <p>While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.</p>
2310+
* </note>
23082311
*/
23092312
roleARN?: string;
23102313

@@ -4783,7 +4786,7 @@ export interface OrganizationManagedRuleMetadata {
47834786
InputParameters?: string;
47844787

47854788
/**
4786-
* <p>The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.</p>
4789+
* <p>The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.</p>
47874790
* <note>
47884791
* <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
47894792
* value for the <code>MaximumExecutionFrequency</code> parameter.</p>

clients/client-config-service/src/models/models_1.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,10 @@ export interface PutResourceConfigRequest {
258258

259259
/**
260260
* <p>Tags associated with the resource.</p>
261+
* <note>
262+
* <p>This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources.
263+
* Tags for <code>PutResourceConfig</code> are tags that you supply for the configuration items of your custom resources.</p>
264+
* </note>
261265
*/
262266
Tags?: Record<string, string>;
263267
}

0 commit comments

Comments
 (0)