Skip to content

docs(clients): apply increased level of structural hint documentation truncation #4585

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.

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

Merged
merged 1 commit into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}
* import { AccessAnalyzerClient, ApplyArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ApplyArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ApplyArchiveRuleRequest
* analyzerArn: "STRING_VALUE", // required
* ruleName: "STRING_VALUE", // required
* clientToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerat
* import { AccessAnalyzerClient, CancelPolicyGenerationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, CancelPolicyGenerationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // CancelPolicyGenerationRequest
* jobId: "STRING_VALUE", // required
* };
* const command = new CancelPolicyGenerationCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,41 +43,41 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes
* import { AccessAnalyzerClient, CreateAccessPreviewCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, CreateAccessPreviewCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // CreateAccessPreviewRequest
* analyzerArn: "STRING_VALUE", // required
* configurations: { // required
* "<keys>": { // Union: only one key present
* ebsSnapshot: {
* userIds: [
* configurations: { // ConfigurationsMap // required
* "<keys>": { // Configuration Union: only one key present
* ebsSnapshot: { // EbsSnapshotConfiguration
* userIds: [ // EbsUserIdList
* "STRING_VALUE",
* ],
* groups: [
* groups: [ // EbsGroupList
* "STRING_VALUE",
* ],
* kmsKeyId: "STRING_VALUE",
* },
* ecrRepository: {
* ecrRepository: { // EcrRepositoryConfiguration
* repositoryPolicy: "STRING_VALUE",
* },
* iamRole: {
* iamRole: { // IamRoleConfiguration
* trustPolicy: "STRING_VALUE",
* },
* efsFileSystem: {
* efsFileSystem: { // EfsFileSystemConfiguration
* fileSystemPolicy: "STRING_VALUE",
* },
* kmsKey: {
* keyPolicies: {
* kmsKey: { // KmsKeyConfiguration
* keyPolicies: { // KmsKeyPoliciesMap
* "<keys>": "STRING_VALUE",
* },
* grants: [
* {
* operations: [ // required
* grants: [ // KmsGrantConfigurationsList
* { // KmsGrantConfiguration
* operations: [ // KmsGrantOperationsList // required
* "STRING_VALUE",
* ],
* granteePrincipal: "STRING_VALUE", // required
* retiringPrincipal: "STRING_VALUE",
* constraints: {
* encryptionContextEquals: {
* constraints: { // KmsGrantConstraints
* encryptionContextEquals: { // KmsConstraintsMap
* "<keys>": "STRING_VALUE",
* },
* encryptionContextSubset: {
Expand All @@ -88,65 +88,65 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes
* },
* ],
* },
* rdsDbClusterSnapshot: {
* attributes: {
* "<keys>": { // Union: only one key present
* accountIds: [
* rdsDbClusterSnapshot: { // RdsDbClusterSnapshotConfiguration
* attributes: { // RdsDbClusterSnapshotAttributesMap
* "<keys>": { // RdsDbClusterSnapshotAttributeValue Union: only one key present
* accountIds: [ // RdsDbClusterSnapshotAccountIdsList
* "STRING_VALUE",
* ],
* },
* },
* kmsKeyId: "STRING_VALUE",
* },
* rdsDbSnapshot: {
* attributes: {
* "<keys>": { // Union: only one key present
* accountIds: [
* rdsDbSnapshot: { // RdsDbSnapshotConfiguration
* attributes: { // RdsDbSnapshotAttributesMap
* "<keys>": { // RdsDbSnapshotAttributeValue Union: only one key present
* accountIds: [ // RdsDbSnapshotAccountIdsList
* "STRING_VALUE",
* ],
* },
* },
* kmsKeyId: "STRING_VALUE",
* },
* secretsManagerSecret: {
* secretsManagerSecret: { // SecretsManagerSecretConfiguration
* kmsKeyId: "STRING_VALUE",
* secretPolicy: "STRING_VALUE",
* },
* s3Bucket: {
* s3Bucket: { // S3BucketConfiguration
* bucketPolicy: "STRING_VALUE",
* bucketAclGrants: [
* {
* bucketAclGrants: [ // S3BucketAclGrantConfigurationsList
* { // S3BucketAclGrantConfiguration
* permission: "STRING_VALUE", // required
* grantee: { // Union: only one key present
* grantee: { // AclGrantee Union: only one key present
* id: "STRING_VALUE",
* uri: "STRING_VALUE",
* },
* },
* ],
* bucketPublicAccessBlock: {
* bucketPublicAccessBlock: { // S3PublicAccessBlockConfiguration
* ignorePublicAcls: true || false, // required
* restrictPublicBuckets: true || false, // required
* },
* accessPoints: {
* "<keys>": {
* accessPoints: { // S3AccessPointConfigurationsMap
* "<keys>": { // S3AccessPointConfiguration
* accessPointPolicy: "STRING_VALUE",
* publicAccessBlock: {
* ignorePublicAcls: true || false, // required
* restrictPublicBuckets: true || false, // required
* },
* networkOrigin: { // Union: only one key present
* vpcConfiguration: {
* networkOrigin: { // NetworkOriginConfiguration Union: only one key present
* vpcConfiguration: { // VpcConfiguration
* vpcId: "STRING_VALUE", // required
* },
* internetConfiguration: {},
* },
* },
* },
* },
* snsTopic: {
* snsTopic: { // SnsTopicConfiguration
* topicPolicy: "STRING_VALUE",
* },
* sqsQueue: {
* sqsQueue: { // SqsQueueConfiguration
* queuePolicy: "STRING_VALUE",
* },
* },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M
* import { AccessAnalyzerClient, CreateAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, CreateAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // CreateAnalyzerRequest
* analyzerName: "STRING_VALUE", // required
* type: "STRING_VALUE", // required
* archiveRules: [
* {
* archiveRules: [ // InlineArchiveRulesList
* { // InlineArchiveRule
* ruleName: "STRING_VALUE", // required
* filter: { // required
* "<keys>": {
* eq: [
* filter: { // FilterCriteriaMap // required
* "<keys>": { // Criterion
* eq: [ // ValueList
* "STRING_VALUE",
* ],
* neq: [
Expand All @@ -64,7 +64,7 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M
* },
* },
* ],
* tags: {
* tags: { // TagsMap
* "<keys>": "STRING_VALUE",
* },
* clientToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}
* import { AccessAnalyzerClient, CreateArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, CreateArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // CreateArchiveRuleRequest
* analyzerName: "STRING_VALUE", // required
* ruleName: "STRING_VALUE", // required
* filter: { // required
* "<keys>": {
* eq: [
* filter: { // FilterCriteriaMap // required
* "<keys>": { // Criterion
* eq: [ // ValueList
* "STRING_VALUE",
* ],
* neq: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}
* import { AccessAnalyzerClient, DeleteAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, DeleteAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // DeleteAnalyzerRequest
* analyzerName: "STRING_VALUE", // required
* clientToken: "STRING_VALUE",
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}
* import { AccessAnalyzerClient, DeleteArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, DeleteArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // DeleteArchiveRuleRequest
* analyzerName: "STRING_VALUE", // required
* ruleName: "STRING_VALUE", // required
* clientToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse,
* import { AccessAnalyzerClient, GetAccessPreviewCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, GetAccessPreviewCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // GetAccessPreviewRequest
* accessPreviewId: "STRING_VALUE", // required
* analyzerArn: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceRes
* import { AccessAnalyzerClient, GetAnalyzedResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, GetAnalyzedResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // GetAnalyzedResourceRequest
* analyzerArn: "STRING_VALUE", // required
* resourceArn: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __Metadat
* import { AccessAnalyzerClient, GetAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, GetAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // GetAnalyzerRequest
* analyzerName: "STRING_VALUE", // required
* };
* const command = new GetAnalyzerCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __M
* import { AccessAnalyzerClient, GetArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, GetArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // GetArchiveRuleRequest
* analyzerName: "STRING_VALUE", // required
* ruleName: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataB
* import { AccessAnalyzerClient, GetFindingCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, GetFindingCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // GetFindingRequest
* analyzerArn: "STRING_VALUE", // required
* id: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface GetGeneratedPolicyCommandOutput extends GetGeneratedPolicyRespo
* import { AccessAnalyzerClient, GetGeneratedPolicyCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, GetGeneratedPolicyCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // GetGeneratedPolicyRequest
* jobId: "STRING_VALUE", // required
* includeResourcePlaceholders: true || false,
* includeServiceLevelTemplate: true || false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ export interface ListAccessPreviewFindingsCommandOutput extends ListAccessPrevie
* import { AccessAnalyzerClient, ListAccessPreviewFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListAccessPreviewFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListAccessPreviewFindingsRequest
* accessPreviewId: "STRING_VALUE", // required
* analyzerArn: "STRING_VALUE", // required
* filter: {
* "<keys>": {
* eq: [
* filter: { // FilterCriteriaMap
* "<keys>": { // Criterion
* eq: [ // ValueList
* "STRING_VALUE",
* ],
* neq: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface ListAccessPreviewsCommandOutput extends ListAccessPreviewsRespo
* import { AccessAnalyzerClient, ListAccessPreviewsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListAccessPreviewsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListAccessPreviewsRequest
* analyzerArn: "STRING_VALUE", // required
* nextToken: "STRING_VALUE",
* maxResults: Number("int"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResource
* import { AccessAnalyzerClient, ListAnalyzedResourcesCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListAnalyzedResourcesCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListAnalyzedResourcesRequest
* analyzerArn: "STRING_VALUE", // required
* resourceType: "STRING_VALUE",
* nextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface ListAnalyzersCommandOutput extends ListAnalyzersResponse, __Met
* import { AccessAnalyzerClient, ListAnalyzersCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListAnalyzersCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListAnalyzersRequest
* nextToken: "STRING_VALUE",
* maxResults: Number("int"),
* type: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface ListArchiveRulesCommandOutput extends ListArchiveRulesResponse,
* import { AccessAnalyzerClient, ListArchiveRulesCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListArchiveRulesCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListArchiveRulesRequest
* analyzerName: "STRING_VALUE", // required
* nextToken: "STRING_VALUE",
* maxResults: Number("int"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad
* import { AccessAnalyzerClient, ListFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListFindingsRequest
* analyzerArn: "STRING_VALUE", // required
* filter: {
* "<keys>": {
* eq: [
* filter: { // FilterCriteriaMap
* "<keys>": { // Criterion
* eq: [ // ValueList
* "STRING_VALUE",
* ],
* neq: [
Expand All @@ -59,7 +59,7 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad
* exists: true || false,
* },
* },
* sort: {
* sort: { // SortCriteria
* attributeName: "STRING_VALUE",
* orderBy: "STRING_VALUE",
* },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface ListPolicyGenerationsCommandOutput extends ListPolicyGeneration
* import { AccessAnalyzerClient, ListPolicyGenerationsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListPolicyGenerationsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListPolicyGenerationsRequest
* principalArn: "STRING_VALUE",
* maxResults: Number("int"),
* nextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
* import { AccessAnalyzerClient, ListTagsForResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* const input = { // ListTagsForResourceRequest
* resourceArn: "STRING_VALUE", // required
* };
* const command = new ListTagsForResourceCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ export interface StartPolicyGenerationCommandOutput extends StartPolicyGeneratio
* import { AccessAnalyzerClient, StartPolicyGenerationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
* // const { AccessAnalyzerClient, StartPolicyGenerationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
* const client = new AccessAnalyzerClient(config);
* const input = {
* policyGenerationDetails: {
* const input = { // StartPolicyGenerationRequest
* policyGenerationDetails: { // PolicyGenerationDetails
* principalArn: "STRING_VALUE", // required
* },
* cloudTrailDetails: {
* trails: [ // required
* {
* cloudTrailDetails: { // CloudTrailDetails
* trails: [ // TrailList // required
* { // Trail
* cloudTrailArn: "STRING_VALUE", // required
* regions: [
* regions: [ // RegionList
* "STRING_VALUE",
* ],
* allRegions: true || false,
Expand Down
Loading