Skip to content

Commit 605746f

Browse files
authored
docs: use heuristic to select sample operation (#5262)
* docs: use heuristic to select sample operation * docs: update example operation selections
1 parent 0471180 commit 605746f

File tree

349 files changed

+2584
-2608
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

349 files changed

+2584
-2608
lines changed

clients/client-accessanalyzer/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ using your favorite package manager:
3131

3232
The AWS SDK is modulized by clients and commands.
3333
To send a request, you only need to import the `AccessAnalyzerClient` and
34-
the commands you need, for example `ApplyArchiveRuleCommand`:
34+
the commands you need, for example `ListAnalyzersCommand`:
3535

3636
```js
3737
// ES5 example
38-
const { AccessAnalyzerClient, ApplyArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer");
38+
const { AccessAnalyzerClient, ListAnalyzersCommand } = require("@aws-sdk/client-accessanalyzer");
3939
```
4040

4141
```ts
4242
// ES6+ example
43-
import { AccessAnalyzerClient, ApplyArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer";
43+
import { AccessAnalyzerClient, ListAnalyzersCommand } from "@aws-sdk/client-accessanalyzer";
4444
```
4545

4646
### Usage
@@ -59,7 +59,7 @@ const client = new AccessAnalyzerClient({ region: "REGION" });
5959
const params = {
6060
/** input parameters */
6161
};
62-
const command = new ApplyArchiveRuleCommand(params);
62+
const command = new ListAnalyzersCommand(params);
6363
```
6464

6565
#### Async/await
@@ -138,15 +138,15 @@ const client = new AWS.AccessAnalyzer({ region: "REGION" });
138138

139139
// async/await.
140140
try {
141-
const data = await client.applyArchiveRule(params);
141+
const data = await client.listAnalyzers(params);
142142
// process data.
143143
} catch (error) {
144144
// error handling.
145145
}
146146

147147
// Promises.
148148
client
149-
.applyArchiveRule(params)
149+
.listAnalyzers(params)
150150
.then((data) => {
151151
// process data.
152152
})
@@ -155,7 +155,7 @@ client
155155
});
156156

157157
// callbacks.
158-
client.applyArchiveRule(params, (err, data) => {
158+
client.listAnalyzers(params, (err, data) => {
159159
// process err and data.
160160
});
161161
```

clients/client-account/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ using your favorite package manager:
2323

2424
The AWS SDK is modulized by clients and commands.
2525
To send a request, you only need to import the `AccountClient` and
26-
the commands you need, for example `DeleteAlternateContactCommand`:
26+
the commands you need, for example `ListRegionsCommand`:
2727

2828
```js
2929
// ES5 example
30-
const { AccountClient, DeleteAlternateContactCommand } = require("@aws-sdk/client-account");
30+
const { AccountClient, ListRegionsCommand } = require("@aws-sdk/client-account");
3131
```
3232

3333
```ts
3434
// ES6+ example
35-
import { AccountClient, DeleteAlternateContactCommand } from "@aws-sdk/client-account";
35+
import { AccountClient, ListRegionsCommand } from "@aws-sdk/client-account";
3636
```
3737

3838
### Usage
@@ -51,7 +51,7 @@ const client = new AccountClient({ region: "REGION" });
5151
const params = {
5252
/** input parameters */
5353
};
54-
const command = new DeleteAlternateContactCommand(params);
54+
const command = new ListRegionsCommand(params);
5555
```
5656

5757
#### Async/await
@@ -130,15 +130,15 @@ const client = new AWS.Account({ region: "REGION" });
130130

131131
// async/await.
132132
try {
133-
const data = await client.deleteAlternateContact(params);
133+
const data = await client.listRegions(params);
134134
// process data.
135135
} catch (error) {
136136
// error handling.
137137
}
138138

139139
// Promises.
140140
client
141-
.deleteAlternateContact(params)
141+
.listRegions(params)
142142
.then((data) => {
143143
// process data.
144144
})
@@ -147,7 +147,7 @@ client
147147
});
148148

149149
// callbacks.
150-
client.deleteAlternateContact(params, (err, data) => {
150+
client.listRegions(params, (err, data) => {
151151
// process err and data.
152152
});
153153
```

clients/client-acm-pca/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,16 @@ using your favorite package manager:
3838

3939
The AWS SDK is modulized by clients and commands.
4040
To send a request, you only need to import the `ACMPCAClient` and
41-
the commands you need, for example `CreateCertificateAuthorityCommand`:
41+
the commands you need, for example `ListTagsCommand`:
4242

4343
```js
4444
// ES5 example
45-
const { ACMPCAClient, CreateCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca");
45+
const { ACMPCAClient, ListTagsCommand } = require("@aws-sdk/client-acm-pca");
4646
```
4747

4848
```ts
4949
// ES6+ example
50-
import { ACMPCAClient, CreateCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca";
50+
import { ACMPCAClient, ListTagsCommand } from "@aws-sdk/client-acm-pca";
5151
```
5252

5353
### Usage
@@ -66,7 +66,7 @@ const client = new ACMPCAClient({ region: "REGION" });
6666
const params = {
6767
/** input parameters */
6868
};
69-
const command = new CreateCertificateAuthorityCommand(params);
69+
const command = new ListTagsCommand(params);
7070
```
7171

7272
#### Async/await
@@ -145,15 +145,15 @@ const client = new AWS.ACMPCA({ region: "REGION" });
145145

146146
// async/await.
147147
try {
148-
const data = await client.createCertificateAuthority(params);
148+
const data = await client.listTags(params);
149149
// process data.
150150
} catch (error) {
151151
// error handling.
152152
}
153153

154154
// Promises.
155155
client
156-
.createCertificateAuthority(params)
156+
.listTags(params)
157157
.then((data) => {
158158
// process data.
159159
})
@@ -162,7 +162,7 @@ client
162162
});
163163

164164
// callbacks.
165-
client.createCertificateAuthority(params, (err, data) => {
165+
client.listTags(params, (err, data) => {
166166
// process err and data.
167167
});
168168
```

clients/client-acm/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ using your favorite package manager:
2626

2727
The AWS SDK is modulized by clients and commands.
2828
To send a request, you only need to import the `ACMClient` and
29-
the commands you need, for example `AddTagsToCertificateCommand`:
29+
the commands you need, for example `ListCertificatesCommand`:
3030

3131
```js
3232
// ES5 example
33-
const { ACMClient, AddTagsToCertificateCommand } = require("@aws-sdk/client-acm");
33+
const { ACMClient, ListCertificatesCommand } = require("@aws-sdk/client-acm");
3434
```
3535

3636
```ts
3737
// ES6+ example
38-
import { ACMClient, AddTagsToCertificateCommand } from "@aws-sdk/client-acm";
38+
import { ACMClient, ListCertificatesCommand } from "@aws-sdk/client-acm";
3939
```
4040

4141
### Usage
@@ -54,7 +54,7 @@ const client = new ACMClient({ region: "REGION" });
5454
const params = {
5555
/** input parameters */
5656
};
57-
const command = new AddTagsToCertificateCommand(params);
57+
const command = new ListCertificatesCommand(params);
5858
```
5959

6060
#### Async/await
@@ -133,15 +133,15 @@ const client = new AWS.ACM({ region: "REGION" });
133133

134134
// async/await.
135135
try {
136-
const data = await client.addTagsToCertificate(params);
136+
const data = await client.listCertificates(params);
137137
// process data.
138138
} catch (error) {
139139
// error handling.
140140
}
141141

142142
// Promises.
143143
client
144-
.addTagsToCertificate(params)
144+
.listCertificates(params)
145145
.then((data) => {
146146
// process data.
147147
})
@@ -150,7 +150,7 @@ client
150150
});
151151

152152
// callbacks.
153-
client.addTagsToCertificate(params, (err, data) => {
153+
client.listCertificates(params, (err, data) => {
154154
// process err and data.
155155
});
156156
```

clients/client-alexa-for-business/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ using your favorite package manager:
2323

2424
The AWS SDK is modulized by clients and commands.
2525
To send a request, you only need to import the `AlexaForBusinessClient` and
26-
the commands you need, for example `ApproveSkillCommand`:
26+
the commands you need, for example `ListSkillsCommand`:
2727

2828
```js
2929
// ES5 example
30-
const { AlexaForBusinessClient, ApproveSkillCommand } = require("@aws-sdk/client-alexa-for-business");
30+
const { AlexaForBusinessClient, ListSkillsCommand } = require("@aws-sdk/client-alexa-for-business");
3131
```
3232

3333
```ts
3434
// ES6+ example
35-
import { AlexaForBusinessClient, ApproveSkillCommand } from "@aws-sdk/client-alexa-for-business";
35+
import { AlexaForBusinessClient, ListSkillsCommand } from "@aws-sdk/client-alexa-for-business";
3636
```
3737

3838
### Usage
@@ -51,7 +51,7 @@ const client = new AlexaForBusinessClient({ region: "REGION" });
5151
const params = {
5252
/** input parameters */
5353
};
54-
const command = new ApproveSkillCommand(params);
54+
const command = new ListSkillsCommand(params);
5555
```
5656

5757
#### Async/await
@@ -130,15 +130,15 @@ const client = new AWS.AlexaForBusiness({ region: "REGION" });
130130

131131
// async/await.
132132
try {
133-
const data = await client.approveSkill(params);
133+
const data = await client.listSkills(params);
134134
// process data.
135135
} catch (error) {
136136
// error handling.
137137
}
138138

139139
// Promises.
140140
client
141-
.approveSkill(params)
141+
.listSkills(params)
142142
.then((data) => {
143143
// process data.
144144
})
@@ -147,7 +147,7 @@ client
147147
});
148148

149149
// callbacks.
150-
client.approveSkill(params, (err, data) => {
150+
client.listSkills(params, (err, data) => {
151151
// process err and data.
152152
});
153153
```

clients/client-amp/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ using your favorite package manager:
2323

2424
The AWS SDK is modulized by clients and commands.
2525
To send a request, you only need to import the `AmpClient` and
26-
the commands you need, for example `CreateAlertManagerDefinitionCommand`:
26+
the commands you need, for example `ListWorkspacesCommand`:
2727

2828
```js
2929
// ES5 example
30-
const { AmpClient, CreateAlertManagerDefinitionCommand } = require("@aws-sdk/client-amp");
30+
const { AmpClient, ListWorkspacesCommand } = require("@aws-sdk/client-amp");
3131
```
3232

3333
```ts
3434
// ES6+ example
35-
import { AmpClient, CreateAlertManagerDefinitionCommand } from "@aws-sdk/client-amp";
35+
import { AmpClient, ListWorkspacesCommand } from "@aws-sdk/client-amp";
3636
```
3737

3838
### Usage
@@ -51,7 +51,7 @@ const client = new AmpClient({ region: "REGION" });
5151
const params = {
5252
/** input parameters */
5353
};
54-
const command = new CreateAlertManagerDefinitionCommand(params);
54+
const command = new ListWorkspacesCommand(params);
5555
```
5656

5757
#### Async/await
@@ -130,15 +130,15 @@ const client = new AWS.Amp({ region: "REGION" });
130130

131131
// async/await.
132132
try {
133-
const data = await client.createAlertManagerDefinition(params);
133+
const data = await client.listWorkspaces(params);
134134
// process data.
135135
} catch (error) {
136136
// error handling.
137137
}
138138

139139
// Promises.
140140
client
141-
.createAlertManagerDefinition(params)
141+
.listWorkspaces(params)
142142
.then((data) => {
143143
// process data.
144144
})
@@ -147,7 +147,7 @@ client
147147
});
148148

149149
// callbacks.
150-
client.createAlertManagerDefinition(params, (err, data) => {
150+
client.listWorkspaces(params, (err, data) => {
151151
// process err and data.
152152
});
153153
```

clients/client-amplify/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ using your favorite package manager:
2828

2929
The AWS SDK is modulized by clients and commands.
3030
To send a request, you only need to import the `AmplifyClient` and
31-
the commands you need, for example `CreateAppCommand`:
31+
the commands you need, for example `ListAppsCommand`:
3232

3333
```js
3434
// ES5 example
35-
const { AmplifyClient, CreateAppCommand } = require("@aws-sdk/client-amplify");
35+
const { AmplifyClient, ListAppsCommand } = require("@aws-sdk/client-amplify");
3636
```
3737

3838
```ts
3939
// ES6+ example
40-
import { AmplifyClient, CreateAppCommand } from "@aws-sdk/client-amplify";
40+
import { AmplifyClient, ListAppsCommand } from "@aws-sdk/client-amplify";
4141
```
4242

4343
### Usage
@@ -56,7 +56,7 @@ const client = new AmplifyClient({ region: "REGION" });
5656
const params = {
5757
/** input parameters */
5858
};
59-
const command = new CreateAppCommand(params);
59+
const command = new ListAppsCommand(params);
6060
```
6161

6262
#### Async/await
@@ -135,15 +135,15 @@ const client = new AWS.Amplify({ region: "REGION" });
135135

136136
// async/await.
137137
try {
138-
const data = await client.createApp(params);
138+
const data = await client.listApps(params);
139139
// process data.
140140
} catch (error) {
141141
// error handling.
142142
}
143143

144144
// Promises.
145145
client
146-
.createApp(params)
146+
.listApps(params)
147147
.then((data) => {
148148
// process data.
149149
})
@@ -152,7 +152,7 @@ client
152152
});
153153

154154
// callbacks.
155-
client.createApp(params, (err, data) => {
155+
client.listApps(params, (err, data) => {
156156
// process err and data.
157157
});
158158
```

0 commit comments

Comments
 (0)