Skip to content

Commit bf0bcbf

Browse files
author
awstools
committed
docs(client-accessanalyzer): Fixed a typo in description field.
1 parent 7ae5125 commit bf0bcbf

File tree

7 files changed

+31
-16
lines changed

7 files changed

+31
-16
lines changed

clients/client-accessanalyzer/src/commands/GetFindingCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataB
2828

2929
/**
3030
* @public
31-
* <p>Retrieves information about the specified finding.</p>
31+
* <p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use
32+
* <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM
33+
* policy statement. You must have permission to perform the
34+
* <code>access-analyzer:GetFinding</code> action.</p>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

clients/client-accessanalyzer/src/commands/GetFindingV2Command.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface GetFindingV2CommandOutput extends GetFindingV2Response, __Metad
2828

2929
/**
3030
* @public
31-
* <p>Retrieves information about the specified finding.</p>
31+
* <p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use
32+
* <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM
33+
* policy statement. You must have permission to perform the
34+
* <code>access-analyzer:GetFinding</code> action.</p>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

clients/client-accessanalyzer/src/commands/ListAnalyzedResourcesCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResource
2929
/**
3030
* @public
3131
* <p>Retrieves a list of resources of the specified type that have been analyzed by the
32-
* specified analyzer..</p>
32+
* specified external access analyzer. This action is not supported for unused access
33+
* analyzers.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

clients/client-accessanalyzer/src/commands/ListFindingsCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad
2828

2929
/**
3030
* @public
31-
* <p>Retrieves a list of findings generated by the specified analyzer.</p>
31+
* <p>Retrieves a list of findings generated by the specified analyzer. ListFindings and
32+
* ListFindingsV2 both use <code>access-analyzer:ListFindings</code> in the
33+
* <code>Action</code> element of an IAM policy statement. You must have permission to
34+
* perform the <code>access-analyzer:ListFindings</code> action.</p>
3235
* <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>
3336
* @example
3437
* Use a bare-bones client and the command you need to make an API call.

clients/client-accessanalyzer/src/commands/ListFindingsV2Command.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface ListFindingsV2CommandOutput extends ListFindingsV2Response, __M
2828

2929
/**
3030
* @public
31-
* <p>Retrieves a list of findings generated by the specified analyzer.</p>
31+
* <p>Retrieves a list of findings generated by the specified analyzer. ListFindings and
32+
* ListFindingsV2 both use <code>access-analyzer:ListFindings</code> in the
33+
* <code>Action</code> element of an IAM policy statement. You must have permission to
34+
* perform the <code>access-analyzer:ListFindings</code> action.</p>
3235
* <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>
3336
* @example
3437
* Use a bare-bones client and the command you need to make an API call.

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

+5-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ import { AccessAnalyzerServiceException as __BaseException } from "./AccessAnaly
1111
export interface Access {
1212
/**
1313
* @public
14-
* <p>A list of actions for the access permissions.</p>
14+
* <p>A list of actions for the access permissions. Any strings that can be used as an action
15+
* in an IAM policy can be used in the list of actions to check.</p>
1516
*/
1617
actions: string[] | undefined;
1718
}
@@ -577,7 +578,7 @@ export interface CreateAnalyzerRequest {
577578
/**
578579
* @public
579580
* <p>The type of analyzer to create. Only <code>ACCOUNT</code>, <code>ORGANIZATION</code>,
580-
* <code>ACCOUNT_UNUSED_ACCESS</code>, and <code>ORGANIZTAION_UNUSED_ACCESS</code>
581+
* <code>ACCOUNT_UNUSED_ACCESS</code>, and <code>ORGANIZATION_UNUSED_ACCESS</code>
581582
* analyzers are supported. You can create only one analyzer per account per Region. You can
582583
* create up to 5 analyzers per organization per Region.</p>
583584
*/
@@ -1839,7 +1840,8 @@ export interface S3BucketConfiguration {
18391840
* existing policy attached to the directory bucket. If the access preview is for a new
18401841
* resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an
18411842
* directory bucket without a policy. To propose deletion of an existing bucket policy, you
1842-
* can specify an empty string. For more information about bucket policy limits, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies</a>.</p>
1843+
* can specify an empty string. For more information about Amazon S3 directory bucket policies, see
1844+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example directory bucket policies for S3 Express One Zone</a>.</p>
18431845
*/
18441846
export interface S3ExpressDirectoryBucketConfiguration {
18451847
/**

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

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"actions": {
88
"target": "com.amazonaws.accessanalyzer#ActionsList",
99
"traits": {
10-
"smithy.api#documentation": "<p>A list of actions for the access permissions.</p>",
10+
"smithy.api#documentation": "<p>A list of actions for the access permissions. Any strings that can be used as an action\n in an IAM policy can be used in the list of actions to check.</p>",
1111
"smithy.api#length": {
1212
"max": 100
1313
},
@@ -2525,7 +2525,7 @@
25252525
"type": {
25262526
"target": "com.amazonaws.accessanalyzer#Type",
25272527
"traits": {
2528-
"smithy.api#documentation": "<p>The type of analyzer to create. Only <code>ACCOUNT</code>, <code>ORGANIZATION</code>,\n <code>ACCOUNT_UNUSED_ACCESS</code>, and <code>ORGANIZTAION_UNUSED_ACCESS</code>\n analyzers are supported. You can create only one analyzer per account per Region. You can\n create up to 5 analyzers per organization per Region.</p>",
2528+
"smithy.api#documentation": "<p>The type of analyzer to create. Only <code>ACCOUNT</code>, <code>ORGANIZATION</code>,\n <code>ACCOUNT_UNUSED_ACCESS</code>, and <code>ORGANIZATION_UNUSED_ACCESS</code>\n analyzers are supported. You can create only one analyzer per account per Region. You can\n create up to 5 analyzers per organization per Region.</p>",
25292529
"smithy.api#required": {}
25302530
}
25312531
},
@@ -3803,7 +3803,7 @@
38033803
}
38043804
],
38053805
"traits": {
3806-
"smithy.api#documentation": "<p>Retrieves information about the specified finding.</p>",
3806+
"smithy.api#documentation": "<p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use\n <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM\n policy statement. You must have permission to perform the\n <code>access-analyzer:GetFinding</code> action.</p>",
38073807
"smithy.api#http": {
38083808
"uri": "/finding/{id}",
38093809
"method": "GET",
@@ -3876,7 +3876,7 @@
38763876
}
38773877
],
38783878
"traits": {
3879-
"smithy.api#documentation": "<p>Retrieves information about the specified finding.</p>",
3879+
"smithy.api#documentation": "<p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use\n <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM\n policy statement. You must have permission to perform the\n <code>access-analyzer:GetFinding</code> action.</p>",
38803880
"smithy.api#http": {
38813881
"uri": "/findingv2/{id}",
38823882
"method": "GET",
@@ -4698,7 +4698,7 @@
46984698
}
46994699
],
47004700
"traits": {
4701-
"smithy.api#documentation": "<p>Retrieves a list of resources of the specified type that have been analyzed by the\n specified analyzer..</p>",
4701+
"smithy.api#documentation": "<p>Retrieves a list of resources of the specified type that have been analyzed by the\n specified external access analyzer. This action is not supported for unused access\n analyzers.</p>",
47024702
"smithy.api#http": {
47034703
"uri": "/analyzed-resource",
47044704
"method": "POST",
@@ -4962,7 +4962,7 @@
49624962
}
49634963
],
49644964
"traits": {
4965-
"smithy.api#documentation": "<p>Retrieves a list of findings generated by the specified analyzer.</p>\n <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>",
4965+
"smithy.api#documentation": "<p>Retrieves a list of findings generated by the specified analyzer. ListFindings and\n ListFindingsV2 both use <code>access-analyzer:ListFindings</code> in the\n <code>Action</code> element of an IAM policy statement. You must have permission to\n perform the <code>access-analyzer:ListFindings</code> action.</p>\n <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>",
49664966
"smithy.api#http": {
49674967
"uri": "/finding",
49684968
"method": "POST",
@@ -5061,7 +5061,7 @@
50615061
}
50625062
],
50635063
"traits": {
5064-
"smithy.api#documentation": "<p>Retrieves a list of findings generated by the specified analyzer.</p>\n <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>",
5064+
"smithy.api#documentation": "<p>Retrieves a list of findings generated by the specified analyzer. ListFindings and\n ListFindingsV2 both use <code>access-analyzer:ListFindings</code> in the\n <code>Action</code> element of an IAM policy statement. You must have permission to\n perform the <code>access-analyzer:ListFindings</code> action.</p>\n <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>",
50655065
"smithy.api#http": {
50665066
"uri": "/findingv2",
50675067
"method": "POST",
@@ -5958,7 +5958,7 @@
59585958
}
59595959
},
59605960
"traits": {
5961-
"smithy.api#documentation": "<p>Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about bucket policy limits, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html\">Example bucket policies</a>.</p>"
5961+
"smithy.api#documentation": "<p>Proposed access control configuration for an Amazon S3 directory bucket. You can propose a\n configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you\n own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3\n directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the\n existing policy attached to the directory bucket. If the access preview is for a new\n resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an\n directory bucket without a policy. To propose deletion of an existing bucket policy, you\n can specify an empty string. For more information about Amazon S3 directory bucket policies, see\n <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html\">Example directory bucket policies for S3 Express One Zone</a>.</p>"
59625962
}
59635963
},
59645964
"com.amazonaws.accessanalyzer#S3ExpressDirectoryBucketPolicy": {

0 commit comments

Comments
 (0)