You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-codecommit/README.md
+30-32Lines changed: 30 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -6,33 +6,32 @@
6
6
7
7
AWS SDK for JavaScript CodeCommit Client for Node.js, Browser and React Native.
8
8
9
-
<fullname>AWS CodeCommit</fullname>
10
-
11
-
<p>This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the operations and data types for
12
-
AWS CodeCommit API along with usage examples.</p>
13
-
<p>You can use the AWS CodeCommit API to work with the following objects:</p>
9
+
<fullname>CodeCommit</fullname>
14
10
11
+
<p>This is the <i>CodeCommit API Reference</i>. This reference provides descriptions of the operations and data types for
12
+
CodeCommit API along with usage examples.</p>
13
+
<p>You can use the CodeCommit API to work with the following objects:</p>
15
14
<p>Repositories, by calling the following:</p>
16
15
<ul>
17
16
<li>
18
17
<p>
19
-
<a>BatchGetRepositories</a>, which returns information about one or more repositories associated with your AWS account.</p>
18
+
<a>BatchGetRepositories</a>, which returns information about one or more repositories associated with your Amazon Web Services account.</p>
20
19
</li>
21
20
<li>
22
21
<p>
23
-
<a>CreateRepository</a>, which creates an AWS CodeCommit repository.</p>
22
+
<a>CreateRepository</a>, which creates an CodeCommit repository.</p>
24
23
</li>
25
24
<li>
26
25
<p>
27
-
<a>DeleteRepository</a>, which deletes an AWS CodeCommit repository.</p>
26
+
<a>DeleteRepository</a>, which deletes an CodeCommit repository.</p>
28
27
</li>
29
28
<li>
30
29
<p>
31
30
<a>GetRepository</a>, which returns information about a specified repository.</p>
32
31
</li>
33
32
<li>
34
33
<p>
35
-
<a>ListRepositories</a>, which lists all AWS CodeCommit repositories associated with your AWS account.</p>
34
+
<a>ListRepositories</a>, which lists all CodeCommit repositories associated with your Amazon Web Services account.</p>
36
35
</li>
37
36
<li>
38
37
<p>
@@ -46,7 +45,6 @@ repository can access it until you send them the new HTTPS or SSH URL to
46
45
use.</p>
47
46
</li>
48
47
</ul>
49
-
50
48
<p>Branches, by calling the following:</p>
51
49
<ul>
52
50
<li>
@@ -71,7 +69,6 @@ repository.</p>
71
69
<a>UpdateDefaultBranch</a>, which changes the default branch for a repository.</p>
72
70
</li>
73
71
</ul>
74
-
75
72
<p>Files, by calling the following:</p>
76
73
<ul>
77
74
<li>
@@ -93,10 +90,13 @@ individual Git blob object in a repository.</p>
93
90
</li>
94
91
<li>
95
92
<p>
93
+
<a>ListFileCommitHistory</a>, which retrieves a list of commits and changes to a specified file. </p>
94
+
</li>
95
+
<li>
96
+
<p>
96
97
<a>PutFile</a>, which adds or modifies a single file in a specified repository and branch.</p>
97
98
</li>
98
99
</ul>
99
-
100
100
<p>Commits, by calling the following:</p>
101
101
<ul>
102
102
<li>
@@ -119,7 +119,6 @@ differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID,
119
119
or other fully qualified reference).</p>
120
120
</li>
121
121
</ul>
122
-
123
122
<p>Merges, by calling the following:</p>
124
123
<ul>
125
124
<li>
@@ -139,15 +138,13 @@ of a file in a potential merge.</p>
139
138
<li>
140
139
<p>
141
140
<a>GetMergeCommit</a>, which returns information about the merge between a source and destination commit. </p>
142
-
143
141
</li>
144
142
<li>
145
143
<p>
146
144
<a>GetMergeConflicts</a>, which returns information about merge conflicts
147
145
between the source and destination branch in a pull request.</p>
148
146
</li>
149
147
<li>
150
-
151
148
<p>
152
149
<a>GetMergeOptions</a>, which returns information about the available merge options between two branches or commit specifiers.</p>
153
150
</li>
@@ -164,7 +161,6 @@ between the source and destination branch in a pull request.</p>
164
161
<a>MergeBranchesByThreeWay</a>, which merges two branches using the three-way merge option.</p>
165
162
</li>
166
163
</ul>
167
-
168
164
<p>Pull requests, by calling the following:</p>
169
165
<ul>
170
166
<li>
@@ -192,7 +188,6 @@ between the source and destination branch in a pull request.</p>
192
188
<a>GetCommentsForPullRequest</a>, which returns information about comments on a specified pull request.</p>
193
189
</li>
194
190
<li>
195
-
196
191
<p>
197
192
<a>GetPullRequest</a>, which returns information about a specified pull request.</p>
198
193
</li>
@@ -221,7 +216,7 @@ branch for that pull request using the squash merge option.</p>
221
216
</li>
222
217
<li>
223
218
<p>
224
-
<a>MergePullRequestByThreeWay</a>. which merges the source destination branch of a pull request into the specified destination
219
+
<a>MergePullRequestByThreeWay</a>, which merges the source destination branch of a pull request into the specified destination
225
220
branch for that pull request using the three-way merge option.</p>
226
221
</li>
227
222
<li>
@@ -253,21 +248,20 @@ branch for that pull request using the three-way merge option.</p>
253
248
<a>UpdatePullRequestTitle</a>, which updates the title of a pull request.</p>
254
249
</li>
255
250
</ul>
256
-
257
251
<p>Approval rule templates, by calling the following:</p>
258
252
<ul>
259
253
<li>
260
254
<p>
261
255
<a>AssociateApprovalRuleTemplateWithRepository</a>, which associates a template
262
256
with a specified repository. After the template is associated with a repository,
263
-
AWS CodeCommit creates approval rules that match the template conditions on
257
+
CodeCommit creates approval rules that match the template conditions on
264
258
every pull request created in the specified repository.</p>
265
259
</li>
266
260
<li>
267
261
<p>
268
262
<a>BatchAssociateApprovalRuleTemplateWithRepositories</a>, which associates a
269
263
template with one or more specified repositories. After the template is
270
-
associated with a repository, AWS CodeCommit creates approval rules that match
264
+
associated with a repository, CodeCommit creates approval rules that match
271
265
the template conditions on every pull request created in the specified
272
266
repositories.</p>
273
267
</li>
@@ -281,7 +275,7 @@ created in those repositories.</p>
281
275
<li>
282
276
<p>
283
277
<a>CreateApprovalRuleTemplate</a>, which creates a template for approval rules that can then be associated with one or more repositories
284
-
in your AWS account.</p>
278
+
in your Amazon Web Services account.</p>
285
279
</li>
286
280
<li>
287
281
<p>
@@ -300,7 +294,7 @@ specified repository.</p>
300
294
</li>
301
295
<li>
302
296
<p>
303
-
<a>ListApprovalRuleTemplates</a>, which lists all approval rule templates in the AWS Region in your AWS account.</p>
297
+
<a>ListApprovalRuleTemplates</a>, which lists all approval rule templates in the Amazon Web Services Region in your Amazon Web Services account.</p>
304
298
</li>
305
299
<li>
306
300
<p>
@@ -324,7 +318,6 @@ approval rule template.</p>
324
318
<a>UpdateApprovalRuleTemplateContent</a>, which updates the content of an approval rule template.</p>
325
319
</li>
326
320
</ul>
327
-
328
321
<p>Comments in a repository, by calling the following:</p>
329
322
<ul>
330
323
<li>
@@ -361,23 +354,21 @@ in a repository.</p>
361
354
<a>UpdateComment</a>, which updates the content of a comment on a commit in a repository.</p>
362
355
</li>
363
356
</ul>
364
-
365
-
<p>Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:</p>
357
+
<p>Tags used to tag resources in CodeCommit (not Git tags), by calling the following:</p>
366
358
<ul>
367
359
<li>
368
360
<p>
369
-
<a>ListTagsForResource</a>, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.</p>
361
+
<a>ListTagsForResource</a>, which gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.</p>
370
362
</li>
371
363
<li>
372
364
<p>
373
-
<a>TagResource</a>, which adds or updates tags for a resource in AWS CodeCommit.</p>
365
+
<a>TagResource</a>, which adds or updates tags for a resource in CodeCommit.</p>
374
366
</li>
375
367
<li>
376
368
<p>
377
-
<a>UntagResource</a>, which removes tags for a resource in AWS CodeCommit.</p>
369
+
<a>UntagResource</a>, which removes tags for a resource in CodeCommit.</p>
378
370
</li>
379
371
</ul>
380
-
381
372
<p>Triggers, by calling the following:</p>
382
373
<ul>
383
374
<li>
@@ -396,8 +387,7 @@ be used to create or delete triggers.</p>
396
387
by sending data to the trigger target.</p>
397
388
</li>
398
389
</ul>
399
-
400
-
<p>For information about how to use AWS CodeCommit, see the <ahref="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit User Guide</a>.</p>
390
+
<p>For information about how to use CodeCommit, see the <ahref="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">CodeCommit User Guide</a>.</p>
401
391
402
392
## Installing
403
393
@@ -953,6 +943,14 @@ ListBranches
953
943
954
944
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/classes/listbranchescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/interfaces/listbranchescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/interfaces/listbranchescommandoutput.html)
955
945
946
+
</details>
947
+
<details>
948
+
<summary>
949
+
ListFileCommitHistory
950
+
</summary>
951
+
952
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/classes/listfilecommithistorycommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/interfaces/listfilecommithistorycommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/interfaces/listfilecommithistorycommandoutput.html)
0 commit comments