@aws-sdk/client-codecommit 3.391.0 → 3.395.0

package/dist-types/commands/UpdatePullRequestDescriptionCommand.d.ts

@@ -43,7 +43,7 @@ export interface UpdatePullRequestDescriptionCommandOutput extends UpdatePullReq
  * //     description: "STRING_VALUE",
  * //     lastActivityDate: new Date("TIMESTAMP"),
  * //     creationDate: new Date("TIMESTAMP"),
- * //     pullRequestStatus: "STRING_VALUE",
+ * //     pullRequestStatus: "OPEN" || "CLOSED",
  * //     authorArn: "STRING_VALUE",
  * //     pullRequestTargets: [ // PullRequestTargetList
  * //       { // PullRequestTarget
@@ -57,7 +57,7 @@ export interface UpdatePullRequestDescriptionCommandOutput extends UpdatePullReq
  * //           isMerged: true || false,
  * //           mergedBy: "STRING_VALUE",
  * //           mergeCommitId: "STRING_VALUE",
- * //           mergeOption: "STRING_VALUE",
+ * //           mergeOption: "FAST_FORWARD_MERGE" || "SQUASH_MERGE" || "THREE_WAY_MERGE",
  * //         },
  * //       },
  * //     ],

package/dist-types/commands/UpdatePullRequestStatusCommand.d.ts

@@ -32,7 +32,7 @@ export interface UpdatePullRequestStatusCommandOutput extends UpdatePullRequestS
  * const client = new CodeCommitClient(config);
  * const input = { // UpdatePullRequestStatusInput
  *   pullRequestId: "STRING_VALUE", // required
- *   pullRequestStatus: "STRING_VALUE", // required
+ *   pullRequestStatus: "OPEN" || "CLOSED", // required
  * };
  * const command = new UpdatePullRequestStatusCommand(input);
  * const response = await client.send(command);
@@ -43,7 +43,7 @@ export interface UpdatePullRequestStatusCommandOutput extends UpdatePullRequestS
  * //     description: "STRING_VALUE",
  * //     lastActivityDate: new Date("TIMESTAMP"),
  * //     creationDate: new Date("TIMESTAMP"),
- * //     pullRequestStatus: "STRING_VALUE",
+ * //     pullRequestStatus: "OPEN" || "CLOSED",
  * //     authorArn: "STRING_VALUE",
  * //     pullRequestTargets: [ // PullRequestTargetList
  * //       { // PullRequestTarget
@@ -57,7 +57,7 @@ export interface UpdatePullRequestStatusCommandOutput extends UpdatePullRequestS
  * //           isMerged: true || false,
  * //           mergedBy: "STRING_VALUE",
  * //           mergeCommitId: "STRING_VALUE",
- * //           mergeOption: "STRING_VALUE",
+ * //           mergeOption: "FAST_FORWARD_MERGE" || "SQUASH_MERGE" || "THREE_WAY_MERGE",
  * //         },
  * //       },
  * //     ],

package/dist-types/commands/UpdatePullRequestTitleCommand.d.ts

@@ -43,7 +43,7 @@ export interface UpdatePullRequestTitleCommandOutput extends UpdatePullRequestTi
  * //     description: "STRING_VALUE",
  * //     lastActivityDate: new Date("TIMESTAMP"),
  * //     creationDate: new Date("TIMESTAMP"),
- * //     pullRequestStatus: "STRING_VALUE",
+ * //     pullRequestStatus: "OPEN" || "CLOSED",
  * //     authorArn: "STRING_VALUE",
  * //     pullRequestTargets: [ // PullRequestTargetList
  * //       { // PullRequestTarget
@@ -57,7 +57,7 @@ export interface UpdatePullRequestTitleCommandOutput extends UpdatePullRequestTi
  * //           isMerged: true || false,
  * //           mergedBy: "STRING_VALUE",
  * //           mergeCommitId: "STRING_VALUE",
- * //           mergeOption: "STRING_VALUE",
+ * //           mergeOption: "FAST_FORWARD_MERGE" || "SQUASH_MERGE" || "THREE_WAY_MERGE",
  * //         },
  * //       },
  * //     ],

package/dist-types/commands/UpdateRepositoryDescriptionCommand.d.ts

@@ -24,7 +24,7 @@ export interface UpdateRepositoryDescriptionCommandOutput extends __MetadataBear
 /**
  * @public
  * <p>Sets or changes the comment or description for a repository.</p>
- *         <note>
+ *          <note>
  *             <p>The description field for a repository accepts all HTML characters and all valid
  *                 Unicode characters. Applications that do not HTML-encode the description and display
  *                 it in a webpage can expose users to potentially malicious code. Make sure that you
@@ -73,8 +73,7 @@ export interface UpdateRepositoryDescriptionCommandOutput extends __MetadataBear
  *
  * @throws {@link InvalidRepositoryNameException} (client fault)
  *  <p>A specified repository name is not valid.</p>
- *
- *         <note>
+ *          <note>
  *             <p>This exception occurs only when a specified repository name is not valid. Other
  *                 exceptions occur when a required repository parameter is missing, or when a
  *                 specified repository does not exist.</p>

package/dist-types/commands/UpdateRepositoryNameCommand.d.ts

@@ -23,10 +23,10 @@ export interface UpdateRepositoryNameCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Renames a repository. The repository name must be unique across the calling AWS
- *             account. Repository names are limited to 100 alphanumeric, dash, and underscore
+ * <p>Renames a repository. The repository name must be unique across the calling Amazon Web Services account.
+ *             Repository names are limited to 100 alphanumeric, dash, and underscore
  *             characters, and cannot include certain characters. The suffix .git is prohibited. For
- *             more information about the limits on repository names, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html">Limits</a> in the AWS CodeCommit
+ *             more information about the limits on repository names, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html">Quotas</a> in the CodeCommit
  *             User Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -52,8 +52,7 @@ export interface UpdateRepositoryNameCommandOutput extends __MetadataBearer {
  *
  * @throws {@link InvalidRepositoryNameException} (client fault)
  *  <p>A specified repository name is not valid.</p>
- *
- *         <note>
+ *          <note>
  *             <p>This exception occurs only when a specified repository name is not valid. Other
  *                 exceptions occur when a required repository parameter is missing, or when a
  *                 specified repository does not exist.</p>

package/dist-types/commands/index.d.ts

@@ -43,6 +43,7 @@ export * from "./GetRepositoryTriggersCommand";
 export * from "./ListApprovalRuleTemplatesCommand";
 export * from "./ListAssociatedApprovalRuleTemplatesForRepositoryCommand";
 export * from "./ListBranchesCommand";
+export * from "./ListFileCommitHistoryCommand";
 export * from "./ListPullRequestsCommand";
 export * from "./ListRepositoriesCommand";
 export * from "./ListRepositoriesForApprovalRuleTemplateCommand";

package/dist-types/index.d.ts

@@ -1,77 +1,74 @@
 /**
- * <fullname>AWS CodeCommit</fullname>
- *         <p>This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the operations and data types for
- *             AWS CodeCommit API along with usage examples.</p>
- *         <p>You can use the AWS CodeCommit API to work with the following objects:</p>
- *
- *             <p>Repositories, by calling the following:</p>
- *           <ul>
+ * <fullname>CodeCommit</fullname>
+ *          <p>This is the <i>CodeCommit API Reference</i>. This reference provides descriptions of the operations and data types for
+ *             CodeCommit API along with usage examples.</p>
+ *          <p>You can use the CodeCommit API to work with the following objects:</p>
+ *          <p>Repositories, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                   <p>
- *                   <a>BatchGetRepositories</a>, which returns information about one or more repositories associated with your AWS account.</p>
+ *                <p>
+ *                   <a>BatchGetRepositories</a>, which returns information about one or more repositories associated with your Amazon Web Services account.</p>
  *             </li>
  *             <li>
- *                   <p>
- *                   <a>CreateRepository</a>, which creates an AWS CodeCommit repository.</p>
+ *                <p>
+ *                   <a>CreateRepository</a>, which creates an CodeCommit repository.</p>
  *             </li>
  *             <li>
- *                   <p>
- *                   <a>DeleteRepository</a>, which deletes an AWS CodeCommit repository.</p>
+ *                <p>
+ *                   <a>DeleteRepository</a>, which deletes an CodeCommit repository.</p>
  *             </li>
  *             <li>
- *                   <p>
+ *                <p>
  *                   <a>GetRepository</a>, which returns information about a specified repository.</p>
  *             </li>
  *             <li>
- *                   <p>
- *                   <a>ListRepositories</a>, which lists all AWS CodeCommit repositories associated with your AWS account.</p>
+ *                <p>
+ *                   <a>ListRepositories</a>, which lists all CodeCommit repositories associated with your Amazon Web Services account.</p>
  *             </li>
  *             <li>
- *                   <p>
+ *                <p>
  *                   <a>UpdateRepositoryDescription</a>, which sets or updates the description of the repository.</p>
- *               </li>
+ *             </li>
  *             <li>
- *                   <p>
+ *                <p>
  *                   <a>UpdateRepositoryName</a>, which changes the name of the
  *                     repository. If you change the name of a repository, no other users of that
  *                     repository can access it until you send them the new HTTPS or SSH URL to
  *                     use.</p>
  *             </li>
  *          </ul>
- *
- *             <p>Branches, by calling the following:</p>
- *             <ul>
+ *          <p>Branches, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                     <p>
+ *                <p>
  *                   <a>CreateBranch</a>, which creates a branch in a specified
  *                     repository.</p>
  *             </li>
  *             <li>
- *                     <p>
+ *                <p>
  *                   <a>DeleteBranch</a>, which deletes the specified branch in a repository unless it is the default branch.</p>
- *                 </li>
+ *             </li>
  *             <li>
- *                     <p>
+ *                <p>
  *                   <a>GetBranch</a>, which returns information about a specified branch.</p>
  *             </li>
  *             <li>
- *                     <p>
+ *                <p>
  *                   <a>ListBranches</a>, which lists all branches for a specified repository.</p>
  *             </li>
  *             <li>
- *                     <p>
+ *                <p>
  *                   <a>UpdateDefaultBranch</a>, which changes the default branch for a repository.</p>
  *             </li>
  *          </ul>
- *
- *         <p>Files, by calling the following:</p>
- *         <ul>
+ *          <p>Files, by calling the following:</p>
+ *          <ul>
  *             <li>
  *                <p>
  *                   <a>DeleteFile</a>, which deletes the content of a specified file from a specified branch.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetBlob</a>, which returns the base-64 encoded content of an
  *                     individual Git blob object in a repository.</p>
  *             </li>
@@ -85,85 +82,81 @@
  *             </li>
  *             <li>
  *                <p>
+ *                   <a>ListFileCommitHistory</a>, which retrieves a list of commits and changes to a specified file. </p>
+ *             </li>
+ *             <li>
+ *                <p>
  *                   <a>PutFile</a>, which adds or modifies a single file in a specified repository and branch.</p>
  *             </li>
  *          </ul>
- *
- *
- *             <p>Commits, by calling the following:</p>
- *               <ul>
+ *          <p>Commits, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                       <p>
+ *                <p>
  *                   <a>BatchGetCommits</a>, which returns information about one or more commits in a repository.</p>
- *                   </li>
+ *             </li>
  *             <li>
  *                <p>
  *                   <a>CreateCommit</a>, which creates a commit for changes to a repository.</p>
  *             </li>
  *             <li>
- *                       <p>
+ *                <p>
  *                   <a>GetCommit</a>, which returns information about  a commit, including commit
  *                           messages and author and committer information.</p>
- *                   </li>
+ *             </li>
  *             <li>
- *                       <p>
+ *                <p>
  *                   <a>GetDifferences</a>, which returns information about the
  *                     differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID,
  *                     or other fully qualified reference).</p>
- *                   </li>
+ *             </li>
  *          </ul>
- *
- *
- *         <p>Merges, by calling the following:</p>
- *         <ul>
+ *          <p>Merges, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>BatchDescribeMergeConflicts</a>, which returns information about conflicts in a merge between commits in a repository.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>CreateUnreferencedMergeCommit</a>, which creates an unreferenced commit between two branches or commits for the
  *                     purpose of comparing them and identifying any potential conflicts.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>DescribeMergeConflicts</a>, which returns information about merge conflicts between the base, source, and destination versions
  *                     of a file in a potential merge.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetMergeCommit</a>, which returns information about the merge between a source and destination commit. </p>
- *
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetMergeConflicts</a>, which returns information about merge conflicts
  *                     between the source and destination branch in a pull request.</p>
  *             </li>
  *             <li>
- *
- *                 <p>
+ *                <p>
  *                   <a>GetMergeOptions</a>, which returns information about the available merge options between two branches or commit specifiers.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>MergeBranchesByFastForward</a>, which merges two branches using the fast-forward merge option.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>MergeBranchesBySquash</a>, which merges two branches using the squash merge option.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>MergeBranchesByThreeWay</a>, which merges two branches using the three-way merge option.</p>
  *             </li>
  *          </ul>
- *
- *
- *         <p>Pull requests, by calling the following:</p>
- *         <ul>
+ *          <p>Pull requests, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>CreatePullRequest</a>, which creates a pull request in a specified repository.</p>
  *             </li>
  *             <li>
@@ -175,7 +168,7 @@
  *                   <a>DeletePullRequestApprovalRule</a>, which deletes an approval rule for a specified pull request.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>DescribePullRequestEvents</a>, which returns information about one or more pull request events.</p>
  *             </li>
  *             <li>
@@ -183,12 +176,11 @@
  *                   <a>EvaluatePullRequestApprovalRules</a>, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetCommentsForPullRequest</a>, which returns information about comments on a specified pull request.</p>
  *             </li>
  *             <li>
- *
- *                 <p>
+ *                <p>
  *                   <a>GetPullRequest</a>, which returns information about a specified pull request.</p>
  *             </li>
  *             <li>
@@ -201,22 +193,22 @@
  *             pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>ListPullRequests</a>, which lists all pull requests for a repository.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>MergePullRequestByFastForward</a>, which merges the source destination branch of a pull request into the specified destination
  *                     branch for that pull request using the fast-forward merge option.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>MergePullRequestBySquash</a>, which merges the source destination branch of a pull request into the specified destination
  *                 branch for that pull request using the squash merge option.</p>
  *             </li>
  *             <li>
- *                 <p>
- *                   <a>MergePullRequestByThreeWay</a>. which merges the source destination branch of a pull request into the specified destination
+ *                <p>
+ *                   <a>MergePullRequestByThreeWay</a>, which merges the source destination branch of a pull request into the specified destination
  *                 branch for that pull request using the three-way merge option.</p>
  *             </li>
  *             <li>
@@ -224,7 +216,7 @@
  *                   <a>OverridePullRequestApprovalRules</a>, which sets aside all approval rule requirements for a pull request.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>PostCommentForPullRequest</a>, which posts a comment to a pull request at the specified line, file, or request.</p>
  *             </li>
  *             <li>
@@ -236,33 +228,32 @@
  *                   <a>UpdatePullRequestApprovalState</a>, which updates the state of an approval on a pull request.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>UpdatePullRequestDescription</a>, which updates the description of a pull request.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>UpdatePullRequestStatus</a>, which updates the status of a pull request.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>UpdatePullRequestTitle</a>, which updates the title of a pull request.</p>
  *             </li>
  *          </ul>
- *
- *         <p>Approval rule templates, by calling the following:</p>
- *         <ul>
+ *          <p>Approval rule templates, by calling the following:</p>
+ *          <ul>
  *             <li>
  *                <p>
  *                   <a>AssociateApprovalRuleTemplateWithRepository</a>, which associates a template
  *                     with a specified repository. After the template is associated with a repository,
- *                     AWS CodeCommit creates approval rules that match the template conditions on
+ *                     CodeCommit creates approval rules that match the template conditions on
  *                     every pull request created in the specified repository.</p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a>BatchAssociateApprovalRuleTemplateWithRepositories</a>, which associates a
  *                     template with one or more specified repositories. After the template is
- *                     associated with a repository, AWS CodeCommit creates approval rules that match
+ *                     associated with a repository, CodeCommit creates approval rules that match
  *                     the template conditions on every pull request created in the specified
  *                     repositories.</p>
  *             </li>
@@ -276,7 +267,7 @@
  *             <li>
  *                <p>
  *                   <a>CreateApprovalRuleTemplate</a>, which creates a template for approval rules that can then be associated with one or more repositories
- *              in your AWS account.</p>
+ *              in your Amazon Web Services account.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -295,7 +286,7 @@
  *             </li>
  *             <li>
  *                <p>
- *                   <a>ListApprovalRuleTemplates</a>, which lists all approval rule templates in the AWS Region in your AWS account.</p>
+ *                   <a>ListApprovalRuleTemplates</a>, which lists all approval rule templates in the Amazon Web Services Region in your Amazon Web Services account.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -319,32 +310,31 @@
  *                   <a>UpdateApprovalRuleTemplateContent</a>, which updates the content of an approval rule template.</p>
  *             </li>
  *          </ul>
- *
- *         <p>Comments in a repository, by calling the following:</p>
- *         <ul>
+ *          <p>Comments in a repository, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>DeleteCommentContent</a>, which deletes the content of a comment on a commit in a repository.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetComment</a>, which returns information about a comment on a commit.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetCommentReactions</a>, which returns information about emoji reactions to comments.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>GetCommentsForComparedCommit</a>, which returns information about comments on the comparison between two commit specifiers
  *                     in a repository.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>PostCommentForComparedCommit</a>, which creates a comment on the comparison between two commit specifiers in a repository.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>PostCommentReply</a>, which creates a reply to a comment.</p>
  *             </li>
  *             <li>
@@ -352,50 +342,44 @@
  *                   <a>PutCommentReaction</a>, which creates or updates an emoji reaction to a comment.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <a>UpdateComment</a>, which updates the content of a comment on a commit in a repository.</p>
  *             </li>
  *          </ul>
- *
- *         <p>Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:</p>
- *         <ul>
+ *          <p>Tags used to tag resources in CodeCommit (not Git tags), by calling the following:</p>
+ *          <ul>
  *             <li>
  *                <p>
- *                   <a>ListTagsForResource</a>, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.</p>
+ *                   <a>ListTagsForResource</a>, which gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a>TagResource</a>, which adds or updates tags for a resource in AWS CodeCommit.</p>
+ *                   <a>TagResource</a>, which adds or updates tags for a resource in CodeCommit.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a>UntagResource</a>, which removes tags for a resource in AWS CodeCommit.</p>
+ *                   <a>UntagResource</a>, which removes tags for a resource in CodeCommit.</p>
  *             </li>
  *          </ul>
- *
- *             <p>Triggers, by calling the following:</p>
- *                 <ul>
+ *          <p>Triggers, by calling the following:</p>
+ *          <ul>
  *             <li>
- *                         <p>
+ *                <p>
  *                   <a>GetRepositoryTriggers</a>, which returns information about triggers configured
  *                             for a repository.</p>
  *             </li>
  *             <li>
- *                         <p>
+ *                <p>
  *                   <a>PutRepositoryTriggers</a>, which replaces all triggers for a repository and can
  *                             be used to create or delete triggers.</p>
  *             </li>
  *             <li>
- *                         <p>
+ *                <p>
  *                   <a>TestRepositoryTriggers</a>, which tests the functionality of a repository trigger
  *                             by sending data to the trigger target.</p>
  *             </li>
  *          </ul>
- *
- *
- *
- *
- *         <p>For information about how to use AWS CodeCommit, see the <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit User Guide</a>.</p>
+ *          <p>For information about how to use CodeCommit, see the <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">CodeCommit User Guide</a>.</p>
  *
  * @packageDocumentation
  */