Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(response-structure): add response structure to syntax example #4684

Merged
merged 2 commits into from
May 3, 2023
Merged

docs(response-structure): add response structure to syntax example #4684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b4d047
docs(response-structure): add response structure to syntax example
MYoung25 May 1, 2023
4e096ad
docs(comment-style): change comment style
MYoung25 May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 4 additions & 0 deletions clients/client-accessanalyzer/src/commands/ApplyArchiveRuleCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}
* };
* const command = new ApplyArchiveRuleCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param ApplyArchiveRuleCommandInput - {@link ApplyArchiveRuleCommandInput}
Expand All @@ -70,6 +72,8 @@ export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class ApplyArchiveRuleCommand extends $Command<
Expand Down
4 changes: 4 additions & 0 deletions clients/client-accessanalyzer/src/commands/CancelPolicyGenerationCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerat
* };
* const command = new CancelPolicyGenerationCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param CancelPolicyGenerationCommandInput - {@link CancelPolicyGenerationCommandInput}
Expand All @@ -64,6 +66,8 @@ export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerat
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class CancelPolicyGenerationCommand extends $Command<
Expand Down
6 changes: 6 additions & 0 deletions clients/client-accessanalyzer/src/commands/CreateAccessPreviewCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,10 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes
* };
* const command = new CreateAccessPreviewCommand(input);
* const response = await client.send(command);
* // { // CreateAccessPreviewResponse
* // id: "STRING_VALUE", // required
* // };
*
* ```
*
* @param CreateAccessPreviewCommandInput - {@link CreateAccessPreviewCommandInput}
Expand Down Expand Up @@ -181,6 +185,8 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class CreateAccessPreviewCommand extends $Command<
Expand Down
6 changes: 6 additions & 0 deletions clients/client-accessanalyzer/src/commands/CreateAnalyzerCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M
* };
* const command = new CreateAnalyzerCommand(input);
* const response = await client.send(command);
* // { // CreateAnalyzerResponse
* // arn: "STRING_VALUE",
* // };
*
* ```
*
* @param CreateAnalyzerCommandInput - {@link CreateAnalyzerCommandInput}
Expand All @@ -94,6 +98,8 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class CreateAnalyzerCommand extends $Command<
Expand Down
4 changes: 4 additions & 0 deletions clients/client-accessanalyzer/src/commands/CreateArchiveRuleCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}
* };
* const command = new CreateArchiveRuleCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param CreateArchiveRuleCommandInput - {@link CreateArchiveRuleCommandInput}
Expand Down Expand Up @@ -91,6 +93,8 @@ export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class CreateArchiveRuleCommand extends $Command<
Expand Down
4 changes: 4 additions & 0 deletions clients/client-accessanalyzer/src/commands/DeleteAnalyzerCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}
* };
* const command = new DeleteAnalyzerCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param DeleteAnalyzerCommandInput - {@link DeleteAnalyzerCommandInput}
Expand All @@ -70,6 +72,8 @@ export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class DeleteAnalyzerCommand extends $Command<
Expand Down
4 changes: 4 additions & 0 deletions clients/client-accessanalyzer/src/commands/DeleteArchiveRuleCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}
* };
* const command = new DeleteArchiveRuleCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param DeleteArchiveRuleCommandInput - {@link DeleteArchiveRuleCommandInput}
Expand All @@ -69,6 +71,8 @@ export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class DeleteArchiveRuleCommand extends $Command<
Expand Down
120 changes: 120 additions & 0 deletions clients/client-accessanalyzer/src/commands/GetAccessPreviewCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,124 @@ export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse,
* };
* const command = new GetAccessPreviewCommand(input);
* const response = await client.send(command);
* // { // GetAccessPreviewResponse
* // accessPreview: { // AccessPreview
* // id: "STRING_VALUE", // required
* // analyzerArn: "STRING_VALUE", // required
* // configurations: { // ConfigurationsMap // required
* // "<keys>": { // Configuration Union: only one key present
* // ebsSnapshot: { // EbsSnapshotConfiguration
* // userIds: [ // EbsUserIdList
* // "STRING_VALUE",
* // ],
* // groups: [ // EbsGroupList
* // "STRING_VALUE",
* // ],
* // kmsKeyId: "STRING_VALUE",
* // },
* // ecrRepository: { // EcrRepositoryConfiguration
* // repositoryPolicy: "STRING_VALUE",
* // },
* // iamRole: { // IamRoleConfiguration
* // trustPolicy: "STRING_VALUE",
* // },
* // efsFileSystem: { // EfsFileSystemConfiguration
* // fileSystemPolicy: "STRING_VALUE",
* // },
* // kmsKey: { // KmsKeyConfiguration
* // keyPolicies: { // KmsKeyPoliciesMap
* // "<keys>": "STRING_VALUE",
* // },
* // grants: [ // KmsGrantConfigurationsList
* // { // KmsGrantConfiguration
* // operations: [ // KmsGrantOperationsList // required
* // "STRING_VALUE",
* // ],
* // granteePrincipal: "STRING_VALUE", // required
* // retiringPrincipal: "STRING_VALUE",
* // constraints: { // KmsGrantConstraints
* // encryptionContextEquals: { // KmsConstraintsMap
* // "<keys>": "STRING_VALUE",
* // },
* // encryptionContextSubset: {
* // "<keys>": "STRING_VALUE",
* // },
* // },
* // issuingAccount: "STRING_VALUE", // required
* // },
* // ],
* // },
* // rdsDbClusterSnapshot: { // RdsDbClusterSnapshotConfiguration
* // attributes: { // RdsDbClusterSnapshotAttributesMap
* // "<keys>": { // RdsDbClusterSnapshotAttributeValue Union: only one key present
* // accountIds: [ // RdsDbClusterSnapshotAccountIdsList
* // "STRING_VALUE",
* // ],
* // },
* // },
* // kmsKeyId: "STRING_VALUE",
* // },
* // rdsDbSnapshot: { // RdsDbSnapshotConfiguration
* // attributes: { // RdsDbSnapshotAttributesMap
* // "<keys>": { // RdsDbSnapshotAttributeValue Union: only one key present
* // accountIds: [ // RdsDbSnapshotAccountIdsList
* // "STRING_VALUE",
* // ],
* // },
* // },
* // kmsKeyId: "STRING_VALUE",
* // },
* // secretsManagerSecret: { // SecretsManagerSecretConfiguration
* // kmsKeyId: "STRING_VALUE",
* // secretPolicy: "STRING_VALUE",
* // },
* // s3Bucket: { // S3BucketConfiguration
* // bucketPolicy: "STRING_VALUE",
* // bucketAclGrants: [ // S3BucketAclGrantConfigurationsList
* // { // S3BucketAclGrantConfiguration
* // permission: "STRING_VALUE", // required
* // grantee: { // AclGrantee Union: only one key present
* // id: "STRING_VALUE",
* // uri: "STRING_VALUE",
* // },
* // },
* // ],
* // bucketPublicAccessBlock: { // S3PublicAccessBlockConfiguration
* // ignorePublicAcls: true || false, // required
* // restrictPublicBuckets: true || false, // required
* // },
* // accessPoints: { // S3AccessPointConfigurationsMap
* // "<keys>": { // S3AccessPointConfiguration
* // accessPointPolicy: "STRING_VALUE",
* // publicAccessBlock: {
* // ignorePublicAcls: true || false, // required
* // restrictPublicBuckets: true || false, // required
* // },
* // networkOrigin: { // NetworkOriginConfiguration Union: only one key present
* // vpcConfiguration: { // VpcConfiguration
* // vpcId: "STRING_VALUE", // required
* // },
* // internetConfiguration: {},
* // },
* // },
* // },
* // },
* // snsTopic: { // SnsTopicConfiguration
* // topicPolicy: "STRING_VALUE",
* // },
* // sqsQueue: { // SqsQueueConfiguration
* // queuePolicy: "STRING_VALUE",
* // },
* // },
* // },
* // createdAt: new Date("TIMESTAMP"), // required
* // status: "STRING_VALUE", // required
* // statusReason: { // AccessPreviewStatusReason
* // code: "STRING_VALUE", // required
* // },
* // },
* // };
*
* ```
*
* @param GetAccessPreviewCommandInput - {@link GetAccessPreviewCommandInput}
Expand All @@ -68,6 +186,8 @@ export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse,
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class GetAccessPreviewCommand extends $Command<
Expand Down
22 changes: 22 additions & 0 deletions clients/client-accessanalyzer/src/commands/GetAnalyzedResourceCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,26 @@ export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceRes
* };
* const command = new GetAnalyzedResourceCommand(input);
* const response = await client.send(command);
* // { // GetAnalyzedResourceResponse
* // resource: { // AnalyzedResource
* // resourceArn: "STRING_VALUE", // required
* // resourceType: "STRING_VALUE", // required
* // createdAt: new Date("TIMESTAMP"), // required
* // analyzedAt: new Date("TIMESTAMP"), // required
* // updatedAt: new Date("TIMESTAMP"), // required
* // isPublic: true || false, // required
* // actions: [ // ActionList
* // "STRING_VALUE",
* // ],
* // sharedVia: [ // SharedViaList
* // "STRING_VALUE",
* // ],
* // status: "STRING_VALUE",
* // resourceOwnerAccount: "STRING_VALUE", // required
* // error: "STRING_VALUE",
* // },
* // };
*
* ```
*
* @param GetAnalyzedResourceCommandInput - {@link GetAnalyzedResourceCommandInput}
Expand All @@ -68,6 +88,8 @@ export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceRes
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class GetAnalyzedResourceCommand extends $Command<
Expand Down
20 changes: 20 additions & 0 deletions clients/client-accessanalyzer/src/commands/GetAnalyzerCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,24 @@ export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __Metadat
* };
* const command = new GetAnalyzerCommand(input);
* const response = await client.send(command);
* // { // GetAnalyzerResponse
* // analyzer: { // AnalyzerSummary
* // arn: "STRING_VALUE", // required
* // name: "STRING_VALUE", // required
* // type: "STRING_VALUE", // required
* // createdAt: new Date("TIMESTAMP"), // required
* // lastResourceAnalyzed: "STRING_VALUE",
* // lastResourceAnalyzedAt: new Date("TIMESTAMP"),
* // tags: { // TagsMap
* // "<keys>": "STRING_VALUE",
* // },
* // status: "STRING_VALUE", // required
* // statusReason: { // StatusReason
* // code: "STRING_VALUE", // required
* // },
* // },
* // };
*
* ```
*
* @param GetAnalyzerCommandInput - {@link GetAnalyzerCommandInput}
Expand All @@ -67,6 +85,8 @@ export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __Metadat
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class GetAnalyzerCommand extends $Command<
Expand Down
24 changes: 24 additions & 0 deletions clients/client-accessanalyzer/src/commands/GetArchiveRuleCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,28 @@ export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __M
* };
* const command = new GetArchiveRuleCommand(input);
* const response = await client.send(command);
* // { // GetArchiveRuleResponse
* // archiveRule: { // ArchiveRuleSummary
* // ruleName: "STRING_VALUE", // required
* // filter: { // FilterCriteriaMap // required
* // "<keys>": { // Criterion
* // eq: [ // ValueList
* // "STRING_VALUE",
* // ],
* // neq: [
* // "STRING_VALUE",
* // ],
* // contains: [
* // "STRING_VALUE",
* // ],
* // exists: true || false,
* // },
* // },
* // createdAt: new Date("TIMESTAMP"), // required
* // updatedAt: new Date("TIMESTAMP"), // required
* // },
* // };
*
* ```
*
* @param GetArchiveRuleCommandInput - {@link GetArchiveRuleCommandInput}
Expand All @@ -69,6 +91,8 @@ export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __M
* @throws {@link ValidationException} (client fault)
* <p>Validation exception error.</p>
*
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
*/
export class GetArchiveRuleCommand extends $Command<
Expand Down
Loading