Skip to content

Commit 4d7233a

Browse files
author
awstools
committed
feat(client-auditmanager): With this release, the AssessmentControl description field has been deprecated, as of May 19, 2025. Additionally, the UpdateAssessment API can now return a ServiceQuotaExceededException when applicable service quotas are exceeded.
1 parent eeecd10 commit 4d7233a

File tree

4 files changed

+55
-40
lines changed

4 files changed

+55
-40
lines changed

clients/client-auditmanager/src/commands/GetServicesInScopeCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ export interface GetServicesInScopeCommandInput extends GetServicesInScopeReques
2828
export interface GetServicesInScopeCommandOutput extends GetServicesInScopeResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets a list of the Amazon Web Services from which Audit Manager can collect
31+
* <p>Gets a list of the Amazon Web Services services from which Audit Manager can collect
3232
* evidence. </p>
33-
* <p>Audit Manager defines which Amazon Web Services are in scope for an
33+
* <p>Audit Manager defines which Amazon Web Services services are in scope for an
3434
* assessment. Audit Manager infers this scope by examining the assessment’s controls and
3535
* their data sources, and then mapping this information to one or more of the corresponding
36-
* Amazon Web Services that are in this list.</p>
36+
* Amazon Web Services services that are in this list.</p>
3737
* <note>
3838
* <p>For information about why it's no longer possible to specify services in scope manually, see
3939
* <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-collection-issues.html#unable-to-edit-services">I can't edit the services in scope for my assessment</a> in

clients/client-auditmanager/src/commands/UpdateAssessmentCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,12 @@ export interface UpdateAssessmentCommandOutput extends UpdateAssessmentResponse,
213213
* @throws {@link ResourceNotFoundException} (client fault)
214214
* <p> The resource that's specified in the request can't be found. </p>
215215
*
216+
* @throws {@link ServiceQuotaExceededException} (client fault)
217+
* <p>You've reached your account quota for this resource type. To perform the requested
218+
* action, delete some existing resources or <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">request a quota increase</a> from
219+
* the Service Quotas console. For a list of Audit Manager service quotas, see <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html">Quotas and
220+
* restrictions for Audit Manager</a>.</p>
221+
*
216222
* @throws {@link ThrottlingException} (client fault)
217223
* <p>The request was denied due to request throttling.</p>
218224
*

clients/client-auditmanager/src/models/models_0.ts

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ export interface AssessmentControl {
159159

160160
/**
161161
* <p> The description of the control. </p>
162+
*
163+
* @deprecated
162164
* @public
163165
*/
164166
description?: string | undefined;
@@ -504,27 +506,27 @@ export interface AssessmentReportsDestination {
504506
}
505507

506508
/**
507-
* <p> An Amazon Web Service such as Amazon S3 or CloudTrail.
509+
* <p> An Amazon Web Services service such as Amazon S3 or CloudTrail.
508510
* </p>
509-
* <p>For an example of how to find an Amazon Web Service name and how to define it in
511+
* <p>For an example of how to find an Amazon Web Services service name and how to define it in
510512
* your assessment scope, see the following:</p>
511513
* <ul>
512514
* <li>
513515
* <p>
514-
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_2">Finding an Amazon Web Service name to use in your assessment scope</a>
516+
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_2">Finding an Amazon Web Services service name to use in your assessment scope</a>
515517
* </p>
516518
* </li>
517519
* <li>
518520
* <p>
519-
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_3">Defining an Amazon Web Service name in your assessment scope</a>
521+
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_3">Defining an Amazon Web Services service name in your assessment scope</a>
520522
* </p>
521523
* </li>
522524
* </ul>
523525
* @public
524526
*/
525527
export interface AWSService {
526528
/**
527-
* <p> The name of the Amazon Web Service. </p>
529+
* <p> The name of the Amazon Web Services service. </p>
528530
* @public
529531
*/
530532
serviceName?: string | undefined;
@@ -534,12 +536,12 @@ export interface AWSService {
534536
* <p> The wrapper that contains the Amazon Web Services accounts that are in
535537
* scope for the assessment. </p>
536538
* <note>
537-
* <p>You no longer need to specify which Amazon Web Services are in scope when you
539+
* <p>You no longer need to specify which Amazon Web Services services are in scope when you
538540
* create or update an assessment. Audit Manager infers the services in scope by
539541
* examining your assessment controls and their data sources, and then mapping this
540-
* information to the relevant Amazon Web Services. </p>
542+
* information to the relevant Amazon Web Services services. </p>
541543
* <p>If an underlying data source changes for your assessment, we automatically update the
542-
* services scope as needed to reflect the correct Amazon Web Services. This
544+
* services scope as needed to reflect the correct Amazon Web Services services. This
543545
* ensures that your assessment collects accurate and comprehensive evidence about all of
544546
* the relevant services in your AWS environment.</p>
545547
* </note>
@@ -558,7 +560,7 @@ export interface Scope {
558560
* </p>
559561
* <important>
560562
* <p>This API parameter is no longer supported. If you use this parameter to specify one
561-
* or more Amazon Web Services, Audit Manager ignores this input. Instead, the
563+
* or more Amazon Web Services services, Audit Manager ignores this input. Instead, the
562564
* value for <code>awsServices</code> will show as empty.</p>
563565
* </important>
564566
*
@@ -735,7 +737,7 @@ export interface AssessmentEvidenceFolder {
735737
id?: string | undefined;
736738

737739
/**
738-
* <p> The Amazon Web Service that the evidence was collected from. </p>
740+
* <p> The Amazon Web Services service that the evidence was collected from. </p>
739741
* @public
740742
*/
741743
dataSource?: string | undefined;
@@ -772,7 +774,7 @@ export interface AssessmentEvidenceFolder {
772774

773775
/**
774776
* <p> The number of evidence that falls under the configuration data category. This evidence
775-
* is collected from configuration snapshots of other Amazon Web Services such as
777+
* is collected from configuration snapshots of other Amazon Web Services services such as
776778
* Amazon EC2, Amazon S3, or IAM. </p>
777779
* @public
778780
*/
@@ -1759,12 +1761,12 @@ export interface CreateAssessmentRequest {
17591761
* <p> The wrapper that contains the Amazon Web Services accounts that are in
17601762
* scope for the assessment. </p>
17611763
* <note>
1762-
* <p>You no longer need to specify which Amazon Web Services are in scope when you
1764+
* <p>You no longer need to specify which Amazon Web Services services are in scope when you
17631765
* create or update an assessment. Audit Manager infers the services in scope by
17641766
* examining your assessment controls and their data sources, and then mapping this
1765-
* information to the relevant Amazon Web Services. </p>
1767+
* information to the relevant Amazon Web Services services. </p>
17661768
* <p>If an underlying data source changes for your assessment, we automatically update the
1767-
* services scope as needed to reflect the correct Amazon Web Services. This
1769+
* services scope as needed to reflect the correct Amazon Web Services services. This
17681770
* ensures that your assessment collects accurate and comprehensive evidence about all of
17691771
* the relevant services in your AWS environment.</p>
17701772
* </note>
@@ -2097,7 +2099,7 @@ export interface SourceKeyword {
20972099
* <p>For CloudTrail: Make sure that the <code>keywordValue</code> is written
20982100
* as <code>serviceprefix_ActionName</code>. For example,
20992101
* <code>cloudtrail_StartLogging</code>. For accuracy, we recommend that you
2100-
* review the Amazon Web Service prefix and action names in the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html">Service Authorization Reference</a>.</p>
2102+
* review the Amazon Web Services service prefix and action names in the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html">Service Authorization Reference</a>.</p>
21012103
* </li>
21022104
* </ol>
21032105
* </important>
@@ -3292,7 +3294,7 @@ export interface Evidence {
32923294
time?: Date | undefined;
32933295

32943296
/**
3295-
* <p> The Amazon Web Service that the evidence is collected from. </p>
3297+
* <p> The Amazon Web Services service that the evidence is collected from. </p>
32963298
* @public
32973299
*/
32983300
eventSource?: string | undefined;
@@ -3854,30 +3856,30 @@ export interface GetOrganizationAdminAccountResponse {
38543856
export interface GetServicesInScopeRequest {}
38553857

38563858
/**
3857-
* <p> The metadata that's associated with the Amazon Web Service. </p>
3859+
* <p> The metadata that's associated with the Amazon Web Services service. </p>
38583860
* @public
38593861
*/
38603862
export interface ServiceMetadata {
38613863
/**
3862-
* <p> The name of the Amazon Web Service. </p>
3864+
* <p> The name of the Amazon Web Services service. </p>
38633865
* @public
38643866
*/
38653867
name?: string | undefined;
38663868

38673869
/**
3868-
* <p> The display name of the Amazon Web Service. </p>
3870+
* <p> The display name of the Amazon Web Services service. </p>
38693871
* @public
38703872
*/
38713873
displayName?: string | undefined;
38723874

38733875
/**
3874-
* <p> The description of the Amazon Web Service. </p>
3876+
* <p> The description of the Amazon Web Services service. </p>
38753877
* @public
38763878
*/
38773879
description?: string | undefined;
38783880

38793881
/**
3880-
* <p> The category that the Amazon Web Service belongs to, such as compute, storage,
3882+
* <p> The category that the Amazon Web Services service belongs to, such as compute, storage,
38813883
* or database. </p>
38823884
* @public
38833885
*/
@@ -3889,7 +3891,7 @@ export interface ServiceMetadata {
38893891
*/
38903892
export interface GetServicesInScopeResponse {
38913893
/**
3892-
* <p> The metadata that's associated with the Amazon Web Service. </p>
3894+
* <p> The metadata that's associated with the Amazon Web Services service. </p>
38933895
* @public
38943896
*/
38953897
serviceMetadata?: ServiceMetadata[] | undefined;

0 commit comments

Comments
 (0)