Skip to content

Commit 6548ac4

Browse files
author
awstools
committed
feat(client-securityhub): This release adds new StandardsControlsUpdatable field to the StandardsSubscription resource
1 parent 559d2c8 commit 6548ac4

9 files changed

+81
-8
lines changed

clients/client-securityhub/src/commands/BatchDisableStandardsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,9 @@ export interface BatchDisableStandardsCommandOutput extends BatchDisableStandard
5454
* // "<keys>": "STRING_VALUE",
5555
* // },
5656
* // StandardsStatus: "PENDING" || "READY" || "FAILED" || "DELETING" || "INCOMPLETE", // required
57+
* // StandardsControlsUpdatable: "READY_FOR_UPDATES" || "NOT_READY_FOR_UPDATES",
5758
* // StandardsStatusReason: { // StandardsStatusReason
58-
* // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "INTERNAL_ERROR", // required
59+
* // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED" || "INTERNAL_ERROR", // required
5960
* // },
6061
* // },
6162
* // ],

clients/client-securityhub/src/commands/BatchEnableStandardsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,9 @@ export interface BatchEnableStandardsCommandOutput extends BatchEnableStandardsR
6060
* // "<keys>": "STRING_VALUE",
6161
* // },
6262
* // StandardsStatus: "PENDING" || "READY" || "FAILED" || "DELETING" || "INCOMPLETE", // required
63+
* // StandardsControlsUpdatable: "READY_FOR_UPDATES" || "NOT_READY_FOR_UPDATES",
6364
* // StandardsStatusReason: { // StandardsStatusReason
64-
* // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "INTERNAL_ERROR", // required
65+
* // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED" || "INTERNAL_ERROR", // required
6566
* // },
6667
* // },
6768
* // ],

clients/client-securityhub/src/commands/BatchGetStandardsControlAssociationsCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ export interface BatchGetStandardsControlAssociationsCommandOutput
3939
* <p>
4040
* For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
4141
* </p>
42+
* <p>
43+
* Calls to this operation return a <code>RESOURCE_NOT_FOUND_EXCEPTION</code> error when the standard subscription for the association has a <code>NOT_READY_FOR_UPDATES</code> value for <code>StandardsControlsUpdatable</code>.
44+
* </p>
4245
* @example
4346
* Use a bare-bones client and the command you need to make an API call.
4447
* ```javascript

clients/client-securityhub/src/commands/DescribeStandardsControlsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ export interface DescribeStandardsControlsCommandOutput extends DescribeStandard
3131
* <p>Returns a list of security standards controls.</p>
3232
* <p>For each control, the results include information about whether it is currently enabled,
3333
* the severity, and a link to remediation information.</p>
34+
* <p>This operation returns an empty list for standard subscriptions where <code>StandardsControlsUpdatable</code> has value <code>NOT_READY_FOR_UPDATES</code>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

clients/client-securityhub/src/commands/GetEnabledStandardsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@ export interface GetEnabledStandardsCommandOutput extends GetEnabledStandardsRes
5353
* // "<keys>": "STRING_VALUE",
5454
* // },
5555
* // StandardsStatus: "PENDING" || "READY" || "FAILED" || "DELETING" || "INCOMPLETE", // required
56+
* // StandardsControlsUpdatable: "READY_FOR_UPDATES" || "NOT_READY_FOR_UPDATES",
5657
* // StandardsStatusReason: { // StandardsStatusReason
57-
* // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "INTERNAL_ERROR", // required
58+
* // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED" || "INTERNAL_ERROR", // required
5859
* // },
5960
* // },
6061
* // ],

clients/client-securityhub/src/commands/ListStandardsControlAssociationsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ export interface ListStandardsControlAssociationsCommandOutput
3636
* <p>
3737
* Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
3838
* </p>
39+
* <p>This operation omits standards control associations for standard subscriptions where <code>StandardsControlsUpdatable</code> has value <code>NOT_READY_FOR_UPDATES</code>.</p>
3940
* @example
4041
* Use a bare-bones client and the command you need to make an API call.
4142
* ```javascript

clients/client-securityhub/src/commands/UpdateStandardsControlCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export interface UpdateStandardsControlCommandOutput extends UpdateStandardsCont
3030
/**
3131
* <p>Used to control whether an individual security standard control is enabled or
3232
* disabled.</p>
33+
* <p>Calls to this operation return a <code>RESOURCE_NOT_FOUND_EXCEPTION</code> error when the standard subscription for the control has <code>StandardsControlsUpdatable</code> value <code>NOT_READY_FOR_UPDATES</code>.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

clients/client-securityhub/src/models/models_2.ts

+35
Original file line numberDiff line numberDiff line change
@@ -4348,6 +4348,20 @@ export interface BatchDisableStandardsRequest {
43484348
StandardsSubscriptionArns: string[] | undefined;
43494349
}
43504350

4351+
/**
4352+
* @public
4353+
* @enum
4354+
*/
4355+
export const StandardsControlsUpdatable = {
4356+
NOT_READY_FOR_UPDATES: "NOT_READY_FOR_UPDATES",
4357+
READY_FOR_UPDATES: "READY_FOR_UPDATES",
4358+
} as const;
4359+
4360+
/**
4361+
* @public
4362+
*/
4363+
export type StandardsControlsUpdatable = (typeof StandardsControlsUpdatable)[keyof typeof StandardsControlsUpdatable];
4364+
43514365
/**
43524366
* @public
43534367
* @enum
@@ -4371,6 +4385,7 @@ export type StandardsStatus = (typeof StandardsStatus)[keyof typeof StandardsSta
43714385
*/
43724386
export const StatusReasonCode = {
43734387
INTERNAL_ERROR: "INTERNAL_ERROR",
4388+
MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED: "MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED",
43744389
NO_AVAILABLE_CONFIGURATION_RECORDER: "NO_AVAILABLE_CONFIGURATION_RECORDER",
43754390
} as const;
43764391

@@ -4443,6 +4458,23 @@ export interface StandardsSubscription {
44434458
*/
44444459
StandardsStatus: StandardsStatus | undefined;
44454460

4461+
/**
4462+
* <p>Indicates whether the controls associated with this standards subscription can be viewed and updated.</p>
4463+
* <p>The values are as follows:</p>
4464+
* <ul>
4465+
* <li>
4466+
* <p>
4467+
* <code>READY_FOR_UPDATES</code> - Controls associated with this standards subscription can be viewed and updated.</p>
4468+
* </li>
4469+
* <li>
4470+
* <p>
4471+
* <code>NOT_READY_FOR_UPDATES</code> - Controls associated with this standards subscription cannot be retrieved or updated yet. Security Hub is still processing a request to create the controls.</p>
4472+
* </li>
4473+
* </ul>
4474+
* @public
4475+
*/
4476+
StandardsControlsUpdatable?: StandardsControlsUpdatable | undefined;
4477+
44464478
/**
44474479
* <p>The reason for the current status.</p>
44484480
* @public
@@ -5880,6 +5912,9 @@ export interface BatchUpdateStandardsControlAssociationsRequest {
58805912
* <p>
58815913
* Updates the enablement status of a security control in a specified standard.
58825914
* </p>
5915+
* <p>
5916+
* Calls to this operation return a <code>RESOURCE_NOT_FOUND_EXCEPTION</code> error when the standard subscription for the control has <code>StandardsControlsUpdatable</code> value <code>NOT_READY_FOR_UPDATES</code>.
5917+
* </p>
58835918
* @public
58845919
*/
58855920
StandardsControlAssociationUpdates: StandardsControlAssociationUpdate[] | undefined;

codegen/sdk-codegen/aws-models/securityhub.json

+34-5
Original file line numberDiff line numberDiff line change
@@ -21462,7 +21462,7 @@
2146221462
}
2146321463
],
2146421464
"traits": {
21465-
"smithy.api#documentation": "<p>\n For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.\n </p>",
21465+
"smithy.api#documentation": "<p>\n For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.\n </p>\n <p>\n Calls to this operation return a <code>RESOURCE_NOT_FOUND_EXCEPTION</code> error when the standard subscription for the association has a <code>NOT_READY_FOR_UPDATES</code> value for <code>StandardsControlsUpdatable</code>.\n </p>",
2146621466
"smithy.api#http": {
2146721467
"method": "POST",
2146821468
"uri": "/associations/batchGet",
@@ -22024,7 +22024,7 @@
2202422024
"target": "com.amazonaws.securityhub#StandardsControlAssociationUpdates",
2202522025
"traits": {
2202622026
"smithy.api#clientOptional": {},
22027-
"smithy.api#documentation": "<p>\n Updates the enablement status of a security control in a specified standard.\n </p>",
22027+
"smithy.api#documentation": "<p>\n Updates the enablement status of a security control in a specified standard.\n </p>\n <p>\n Calls to this operation return a <code>RESOURCE_NOT_FOUND_EXCEPTION</code> error when the standard subscription for the control has <code>StandardsControlsUpdatable</code> value <code>NOT_READY_FOR_UPDATES</code>.\n </p>",
2202822028
"smithy.api#required": {}
2202922029
}
2203022030
}
@@ -24678,7 +24678,7 @@
2467824678
}
2467924679
],
2468024680
"traits": {
24681-
"smithy.api#documentation": "<p>Returns a list of security standards controls.</p>\n <p>For each control, the results include information about whether it is currently enabled,\n the severity, and a link to remediation information.</p>",
24681+
"smithy.api#documentation": "<p>Returns a list of security standards controls.</p>\n <p>For each control, the results include information about whether it is currently enabled,\n the severity, and a link to remediation information.</p>\n <p>This operation returns an empty list for standard subscriptions where <code>StandardsControlsUpdatable</code> has value <code>NOT_READY_FOR_UPDATES</code>.</p>",
2468224682
"smithy.api#http": {
2468324683
"method": "GET",
2468424684
"uri": "/standards/controls/{StandardsSubscriptionArn+}",
@@ -28718,7 +28718,7 @@
2871828718
}
2871928719
],
2872028720
"traits": {
28721-
"smithy.api#documentation": "<p>\n Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.\n </p>",
28721+
"smithy.api#documentation": "<p>\n Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.\n </p>\n <p>This operation omits standards control associations for standard subscriptions where <code>StandardsControlsUpdatable</code> has value <code>NOT_READY_FOR_UPDATES</code>.</p>",
2872228722
"smithy.api#http": {
2872328723
"method": "GET",
2872428724
"uri": "/associations",
@@ -34145,6 +34145,23 @@
3414534145
"target": "com.amazonaws.securityhub#StandardsControl"
3414634146
}
3414734147
},
34148+
"com.amazonaws.securityhub#StandardsControlsUpdatable": {
34149+
"type": "enum",
34150+
"members": {
34151+
"READY_FOR_UPDATES": {
34152+
"target": "smithy.api#Unit",
34153+
"traits": {
34154+
"smithy.api#enumValue": "READY_FOR_UPDATES"
34155+
}
34156+
},
34157+
"NOT_READY_FOR_UPDATES": {
34158+
"target": "smithy.api#Unit",
34159+
"traits": {
34160+
"smithy.api#enumValue": "NOT_READY_FOR_UPDATES"
34161+
}
34162+
}
34163+
}
34164+
},
3414834165
"com.amazonaws.securityhub#StandardsInputParameterMap": {
3414934166
"type": "map",
3415034167
"key": {
@@ -34260,6 +34277,12 @@
3426034277
"smithy.api#required": {}
3426134278
}
3426234279
},
34280+
"StandardsControlsUpdatable": {
34281+
"target": "com.amazonaws.securityhub#StandardsControlsUpdatable",
34282+
"traits": {
34283+
"smithy.api#documentation": "<p>Indicates whether the controls associated with this standards subscription can be viewed and updated.</p>\n <p>The values are as follows:</p>\n <ul>\n <li>\n <p>\n <code>READY_FOR_UPDATES</code> - Controls associated with this standards subscription can be viewed and updated.</p>\n </li>\n <li>\n <p>\n <code>NOT_READY_FOR_UPDATES</code> - Controls associated with this standards subscription cannot be retrieved or updated yet. Security Hub is still processing a request to create the controls.</p>\n </li>\n </ul>"
34284+
}
34285+
},
3426334286
"StandardsStatusReason": {
3426434287
"target": "com.amazonaws.securityhub#StandardsStatusReason",
3426534288
"traits": {
@@ -34612,6 +34635,12 @@
3461234635
"smithy.api#enumValue": "NO_AVAILABLE_CONFIGURATION_RECORDER"
3461334636
}
3461434637
},
34638+
"MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED": {
34639+
"target": "smithy.api#Unit",
34640+
"traits": {
34641+
"smithy.api#enumValue": "MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED"
34642+
}
34643+
},
3461534644
"INTERNAL_ERROR": {
3461634645
"target": "smithy.api#Unit",
3461734646
"traits": {
@@ -36319,7 +36348,7 @@
3631936348
}
3632036349
],
3632136350
"traits": {
36322-
"smithy.api#documentation": "<p>Used to control whether an individual security standard control is enabled or\n disabled.</p>",
36351+
"smithy.api#documentation": "<p>Used to control whether an individual security standard control is enabled or\n disabled.</p>\n <p>Calls to this operation return a <code>RESOURCE_NOT_FOUND_EXCEPTION</code> error when the standard subscription for the control has <code>StandardsControlsUpdatable</code> value <code>NOT_READY_FOR_UPDATES</code>.</p>",
3632336352
"smithy.api#examples": [
3632436353
{
3632536354
"title": "To update the enablement status of a standard control",

0 commit comments

Comments
 (0)