Struct aws_sdk_codecommit::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS CodeCommit
Client for invoking operations on AWS CodeCommit. Each operation on AWS CodeCommit is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_codecommit::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_codecommit::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateApprovalRuleTemplateWithRepository
operation has
a Client::associate_approval_rule_template_with_repository
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_approval_rule_template_with_repository()
.approval_rule_template_name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_approval_rule_template_with_repository(
&self
) -> AssociateApprovalRuleTemplateWithRepositoryFluentBuilder
pub fn associate_approval_rule_template_with_repository( &self ) -> AssociateApprovalRuleTemplateWithRepositoryFluentBuilder
Constructs a fluent builder for the AssociateApprovalRuleTemplateWithRepository
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name for the approval rule template.
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that you want to associate with the template.
- On success, responds with
AssociateApprovalRuleTemplateWithRepositoryOutput
- On failure, responds with
SdkError<AssociateApprovalRuleTemplateWithRepositoryError>
source§impl Client
impl Client
sourcepub fn batch_associate_approval_rule_template_with_repositories(
&self
) -> BatchAssociateApprovalRuleTemplateWithRepositoriesFluentBuilder
pub fn batch_associate_approval_rule_template_with_repositories( &self ) -> BatchAssociateApprovalRuleTemplateWithRepositoriesFluentBuilder
Constructs a fluent builder for the BatchAssociateApprovalRuleTemplateWithRepositories
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the template you want to associate with one or more repositories.
repository_names(impl Into<String>)
/set_repository_names(Option<Vec::<String>>)
:
required: trueThe names of the repositories you want to associate with the template.
The length constraint limit is for each string in the array. The array itself can be empty.
- On success, responds with
BatchAssociateApprovalRuleTemplateWithRepositoriesOutput
with field(s):associated_repository_names(Vec::<String>)
:A list of names of the repositories that have been associated with the template.
errors(Vec::<BatchAssociateApprovalRuleTemplateWithRepositoriesError>)
:A list of any errors that might have occurred while attempting to create the association between the template and the repositories.
- On failure, responds with
SdkError<BatchAssociateApprovalRuleTemplateWithRepositoriesError>
source§impl Client
impl Client
sourcepub fn batch_describe_merge_conflicts(
&self
) -> BatchDescribeMergeConflictsFluentBuilder
pub fn batch_describe_merge_conflicts( &self ) -> BatchDescribeMergeConflictsFluentBuilder
Constructs a fluent builder for the BatchDescribeMergeConflicts
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the merge conflicts you want to review.
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
merge_option(MergeOptionTypeEnum)
/set_merge_option(Option<MergeOptionTypeEnum>)
:
required: trueThe merge option or strategy you want to use to merge the code.
max_merge_hunks(i32)
/set_max_merge_hunks(Option<i32>)
:
required: falseThe maximum number of merge hunks to include in the output.
max_conflict_files(i32)
/set_max_conflict_files(Option<i32>)
:
required: falseThe maximum number of files to include in the output.
file_paths(impl Into<String>)
/set_file_paths(Option<Vec::<String>>)
:
required: falseThe path of the target files used to describe the conflicts. If not specified, the default is all conflict files.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
- On success, responds with
BatchDescribeMergeConflictsOutput
with field(s):conflicts(Vec::<Conflict>)
:A list of conflicts for each file, including the conflict metadata and the hunks of the differences between the files.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
errors(Option<Vec::<BatchDescribeMergeConflictsError>>)
:A list of any errors returned while describing the merge conflicts for each file.
destination_commit_id(String)
:The commit ID of the destination commit specifier that was used in the merge evaluation.
source_commit_id(String)
:The commit ID of the source commit specifier that was used in the merge evaluation.
base_commit_id(Option<String>)
:The commit ID of the merge base.
- On failure, responds with
SdkError<BatchDescribeMergeConflictsError>
source§impl Client
impl Client
sourcepub fn batch_disassociate_approval_rule_template_from_repositories(
&self
) -> BatchDisassociateApprovalRuleTemplateFromRepositoriesFluentBuilder
pub fn batch_disassociate_approval_rule_template_from_repositories( &self ) -> BatchDisassociateApprovalRuleTemplateFromRepositoriesFluentBuilder
Constructs a fluent builder for the BatchDisassociateApprovalRuleTemplateFromRepositories
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the template that you want to disassociate from one or more repositories.
repository_names(impl Into<String>)
/set_repository_names(Option<Vec::<String>>)
:
required: trueThe repository names that you want to disassociate from the approval rule template.
The length constraint limit is for each string in the array. The array itself can be empty.
- On success, responds with
BatchDisassociateApprovalRuleTemplateFromRepositoriesOutput
with field(s):disassociated_repository_names(Vec::<String>)
:A list of repository names that have had their association with the template removed.
errors(Vec::<BatchDisassociateApprovalRuleTemplateFromRepositoriesError>)
:A list of any errors that might have occurred while attempting to remove the association between the template and the repositories.
- On failure, responds with
SdkError<BatchDisassociateApprovalRuleTemplateFromRepositoriesError>
source§impl Client
impl Client
sourcepub fn batch_get_commits(&self) -> BatchGetCommitsFluentBuilder
pub fn batch_get_commits(&self) -> BatchGetCommitsFluentBuilder
Constructs a fluent builder for the BatchGetCommits
operation.
- The fluent builder is configurable:
commit_ids(impl Into<String>)
/set_commit_ids(Option<Vec::<String>>)
:
required: trueThe full commit IDs of the commits to get information about.
You must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the commits.
- On success, responds with
BatchGetCommitsOutput
with field(s):commits(Option<Vec::<Commit>>)
:An array of commit data type objects, each of which contains information about a specified commit.
errors(Option<Vec::<BatchGetCommitsError>>)
:Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA ID or that commit was not found in the specified repository, the ID returns an error object with more information.
- On failure, responds with
SdkError<BatchGetCommitsError>
source§impl Client
impl Client
sourcepub fn batch_get_repositories(&self) -> BatchGetRepositoriesFluentBuilder
pub fn batch_get_repositories(&self) -> BatchGetRepositoriesFluentBuilder
Constructs a fluent builder for the BatchGetRepositories
operation.
- The fluent builder is configurable:
repository_names(impl Into<String>)
/set_repository_names(Option<Vec::<String>>)
:
required: trueThe names of the repositories to get information about.
The length constraint limit is for each string in the array. The array itself can be empty.
- On success, responds with
BatchGetRepositoriesOutput
with field(s):repositories(Option<Vec::<RepositoryMetadata>>)
:A list of repositories returned by the batch get repositories operation.
repositories_not_found(Option<Vec::<String>>)
:Returns a list of repository names for which information could not be found.
errors(Option<Vec::<BatchGetRepositoriesError>>)
:Returns information about any errors returned when attempting to retrieve information about the repositories.
- On failure, responds with
SdkError<BatchGetRepositoriesError>
source§impl Client
impl Client
sourcepub fn create_approval_rule_template(
&self
) -> CreateApprovalRuleTemplateFluentBuilder
pub fn create_approval_rule_template( &self ) -> CreateApprovalRuleTemplateFluentBuilder
Constructs a fluent builder for the CreateApprovalRuleTemplate
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the approval rule template. Provide descriptive names, because this name is applied to the approval rules created automatically in associated repositories.
approval_rule_template_content(impl Into<String>)
/set_approval_rule_template_content(Option<String>)
:
required: trueThe content of the approval rule that is created on pull requests in associated repositories. If you specify one or more destination references (branches), approval rules are created in an associated repository only if their destination references (branches) match those specified in the template.
When you create the content of the approval rule template, you can specify approvers in an approval pool in one of two ways:
-
CodeCommitApprovers: This option only requires an Amazon Web Services account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the Amazon Web Services account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:
-
An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
-
A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)
This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).
-
-
Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.
For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.
-
approval_rule_template_description(impl Into<String>)
/set_approval_rule_template_description(Option<String>)
:
required: falseThe description of the approval rule template. Consider providing a description that explains what this template does and when it might be appropriate to associate it with repositories.
- On success, responds with
CreateApprovalRuleTemplateOutput
with field(s):approval_rule_template(Option<ApprovalRuleTemplate>)
:The content and structure of the created approval rule template.
- On failure, responds with
SdkError<CreateApprovalRuleTemplateError>
source§impl Client
impl Client
sourcepub fn create_branch(&self) -> CreateBranchFluentBuilder
pub fn create_branch(&self) -> CreateBranchFluentBuilder
Constructs a fluent builder for the CreateBranch
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository in which you want to create the new branch.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: trueThe name of the new branch to create.
commit_id(impl Into<String>)
/set_commit_id(Option<String>)
:
required: trueThe ID of the commit to point the new branch to.
- On success, responds with
CreateBranchOutput
- On failure, responds with
SdkError<CreateBranchError>
source§impl Client
impl Client
sourcepub fn create_commit(&self) -> CreateCommitFluentBuilder
pub fn create_commit(&self) -> CreateCommitFluentBuilder
Constructs a fluent builder for the CreateCommit
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you create the commit.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: trueThe name of the branch where you create the commit.
parent_commit_id(impl Into<String>)
/set_parent_commit_id(Option<String>)
:
required: falseThe ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.
author_name(impl Into<String>)
/set_author_name(Option<String>)
:
required: falseThe name of the author who created the commit. This information is used as both the author and committer for the commit.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address of the person who created the commit.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.
put_files(PutFileEntry)
/set_put_files(Option<Vec::<PutFileEntry>>)
:
required: falseThe files to add or update in this commit.
delete_files(DeleteFileEntry)
/set_delete_files(Option<Vec::<DeleteFileEntry>>)
:
required: falseThe files to delete in this commit. These files still exist in earlier commits.
set_file_modes(SetFileModeEntry)
/set_set_file_modes(Option<Vec::<SetFileModeEntry>>)
:
required: falseThe file modes to update for files in this commit.
- On success, responds with
CreateCommitOutput
with field(s):commit_id(Option<String>)
:The full commit ID of the commit that contains your committed file changes.
tree_id(Option<String>)
:The full SHA-1 pointer of the tree information for the commit that contains the commited file changes.
files_added(Option<Vec::<FileMetadata>>)
:The files added as part of the committed file changes.
files_updated(Option<Vec::<FileMetadata>>)
:The files updated as part of the commited file changes.
files_deleted(Option<Vec::<FileMetadata>>)
:The files deleted as part of the committed file changes.
- On failure, responds with
SdkError<CreateCommitError>
source§impl Client
impl Client
sourcepub fn create_pull_request(&self) -> CreatePullRequestFluentBuilder
pub fn create_pull_request(&self) -> CreatePullRequestFluentBuilder
Constructs a fluent builder for the CreatePullRequest
operation.
- The fluent builder is configurable:
title(impl Into<String>)
/set_title(Option<String>)
:
required: trueThe title of the pull request. This title is used to identify the pull request to other users in the repository.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the pull request.
targets(Target)
/set_targets(Option<Vec::<Target>>)
:
required: trueThe targets for the pull request, including the source of the code to be reviewed (the source branch) and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
The Amazon Web ServicesSDKs prepopulate client request tokens. If you are using an Amazon Web ServicesSDK, an idempotency token is created for you.
- On success, responds with
CreatePullRequestOutput
with field(s):pull_request(Option<PullRequest>)
:Information about the newly created pull request.
- On failure, responds with
SdkError<CreatePullRequestError>
source§impl Client
impl Client
sourcepub fn create_pull_request_approval_rule(
&self
) -> CreatePullRequestApprovalRuleFluentBuilder
pub fn create_pull_request_approval_rule( &self ) -> CreatePullRequestApprovalRuleFluentBuilder
Constructs a fluent builder for the CreatePullRequestApprovalRule
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request for which you want to create the approval rule.
approval_rule_name(impl Into<String>)
/set_approval_rule_name(Option<String>)
:
required: trueThe name for the approval rule.
approval_rule_content(impl Into<String>)
/set_approval_rule_content(Option<String>)
:
required: trueThe content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the CodeCommit User Guide.
When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:
-
CodeCommitApprovers: This option only requires an Amazon Web Services account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the Amazon Web Services account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:
-
An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
-
A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)
This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).
-
-
Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.
For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.
-
- On success, responds with
CreatePullRequestApprovalRuleOutput
with field(s):approval_rule(Option<ApprovalRule>)
:Information about the created approval rule.
- On failure, responds with
SdkError<CreatePullRequestApprovalRuleError>
source§impl Client
impl Client
sourcepub fn create_repository(&self) -> CreateRepositoryFluentBuilder
pub fn create_repository(&self) -> CreateRepositoryFluentBuilder
Constructs a fluent builder for the CreateRepository
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the new repository to be created.
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. For more information about the limits on repository names, see Quotas in the CodeCommit User Guide. The suffix .git is prohibited.
repository_description(impl Into<String>)
/set_repository_description(Option<String>)
:
required: falseA comment or description about the new repository.
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 HTML-encode the description field in any application that uses this API to display the repository description on a webpage.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseOne or more tag key-value pairs to use when tagging this repository.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe ID of the encryption key. You can view the ID of an encryption key in the KMS console, or use the KMS APIs to programmatically retrieve a key ID. For more information about acceptable values for kmsKeyID, see KeyId in the Decrypt API description in the Key Management Service API Reference.
If no key is specified, the default
aws/codecommit
Amazon Web Services managed key is used.
- On success, responds with
CreateRepositoryOutput
with field(s):repository_metadata(Option<RepositoryMetadata>)
:Information about the newly created repository.
- On failure, responds with
SdkError<CreateRepositoryError>
source§impl Client
impl Client
sourcepub fn create_unreferenced_merge_commit(
&self
) -> CreateUnreferencedMergeCommitFluentBuilder
pub fn create_unreferenced_merge_commit( &self ) -> CreateUnreferencedMergeCommitFluentBuilder
Constructs a fluent builder for the CreateUnreferencedMergeCommit
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to create the unreferenced merge commit.
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
merge_option(MergeOptionTypeEnum)
/set_merge_option(Option<MergeOptionTypeEnum>)
:
required: trueThe merge option or strategy you want to use to merge the code.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
author_name(impl Into<String>)
/set_author_name(Option<String>)
:
required: falseThe name of the author who created the unreferenced commit. This information is used as both the author and committer for the commit.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address for the person who created the unreferenced commit.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message for the unreferenced commit.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file is created for empty folders. The default is false.
conflict_resolution(ConflictResolution)
/set_conflict_resolution(Option<ConflictResolution>)
:
required: falseIf AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
- On success, responds with
CreateUnreferencedMergeCommitOutput
with field(s):commit_id(Option<String>)
:The full commit ID of the commit that contains your merge results.
tree_id(Option<String>)
:The full SHA-1 pointer of the tree information for the commit that contains the merge results.
- On failure, responds with
SdkError<CreateUnreferencedMergeCommitError>
source§impl Client
impl Client
sourcepub fn delete_approval_rule_template(
&self
) -> DeleteApprovalRuleTemplateFluentBuilder
pub fn delete_approval_rule_template( &self ) -> DeleteApprovalRuleTemplateFluentBuilder
Constructs a fluent builder for the DeleteApprovalRuleTemplate
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the approval rule template to delete.
- On success, responds with
DeleteApprovalRuleTemplateOutput
with field(s):approval_rule_template_id(String)
:The system-generated ID of the deleted approval rule template. If the template has been previously deleted, the only response is a 200 OK.
- On failure, responds with
SdkError<DeleteApprovalRuleTemplateError>
source§impl Client
impl Client
sourcepub fn delete_branch(&self) -> DeleteBranchFluentBuilder
pub fn delete_branch(&self) -> DeleteBranchFluentBuilder
Constructs a fluent builder for the DeleteBranch
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the branch to be deleted.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: trueThe name of the branch to delete.
- On success, responds with
DeleteBranchOutput
with field(s):deleted_branch(Option<BranchInfo>)
:Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch.
- On failure, responds with
SdkError<DeleteBranchError>
source§impl Client
impl Client
sourcepub fn delete_comment_content(&self) -> DeleteCommentContentFluentBuilder
pub fn delete_comment_content(&self) -> DeleteCommentContentFluentBuilder
Constructs a fluent builder for the DeleteCommentContent
operation.
- The fluent builder is configurable:
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueThe unique, system-generated ID of the comment. To get this ID, use
GetCommentsForComparedCommit
orGetCommentsForPullRequest
.
- On success, responds with
DeleteCommentContentOutput
with field(s):comment(Option<Comment>)
:Information about the comment you just deleted.
- On failure, responds with
SdkError<DeleteCommentContentError>
source§impl Client
impl Client
sourcepub fn delete_file(&self) -> DeleteFileFluentBuilder
pub fn delete_file(&self) -> DeleteFileFluentBuilder
Constructs a fluent builder for the DeleteFile
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the file to delete.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: trueThe name of the branch where the commit that deletes the file is made.
file_path(impl Into<String>)
/set_file_path(Option<String>)
:
required: trueThe fully qualified path to the file that to be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.
parent_commit_id(impl Into<String>)
/set_parent_commit_id(Option<String>)
:
required: trueThe ID of the commit that is the tip of the branch where you want to create the commit that deletes the file. This must be the HEAD commit for the branch. The commit that deletes the file is created from this commit ID.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file. By default, empty folders are deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 also deletes the empty folders dir4, dir3, and dir2.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message is used.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the author of the commit that deletes the file. If no name is specified, the user’s ARN is used as the author name and committer name.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address for the commit that deletes the file. If no email address is specified, the email address is left blank.
- On success, responds with
DeleteFileOutput
with field(s):commit_id(String)
:The full commit ID of the commit that contains the change that deletes the file.
blob_id(String)
:The blob ID removed from the tree as part of deleting the file.
tree_id(String)
:The full SHA-1 pointer of the tree information for the commit that contains the delete file change.
file_path(String)
:The fully qualified path to the file to be deleted, including the full name and extension of that file.
- On failure, responds with
SdkError<DeleteFileError>
source§impl Client
impl Client
sourcepub fn delete_pull_request_approval_rule(
&self
) -> DeletePullRequestApprovalRuleFluentBuilder
pub fn delete_pull_request_approval_rule( &self ) -> DeletePullRequestApprovalRuleFluentBuilder
Constructs a fluent builder for the DeletePullRequestApprovalRule
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request that contains the approval rule you want to delete.
approval_rule_name(impl Into<String>)
/set_approval_rule_name(Option<String>)
:
required: trueThe name of the approval rule you want to delete.
- On success, responds with
DeletePullRequestApprovalRuleOutput
with field(s):approval_rule_id(String)
:The ID of the deleted approval rule.
If the approval rule was deleted in an earlier API call, the response is 200 OK without content.
- On failure, responds with
SdkError<DeletePullRequestApprovalRuleError>
source§impl Client
impl Client
sourcepub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder
pub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder
Constructs a fluent builder for the DeleteRepository
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository to delete.
- On success, responds with
DeleteRepositoryOutput
with field(s):repository_id(Option<String>)
:The ID of the repository that was deleted.
- On failure, responds with
SdkError<DeleteRepositoryError>
source§impl Client
impl Client
sourcepub fn describe_merge_conflicts(&self) -> DescribeMergeConflictsFluentBuilder
pub fn describe_merge_conflicts(&self) -> DescribeMergeConflictsFluentBuilder
Constructs a fluent builder for the DescribeMergeConflicts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to get information about a merge conflict.
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
merge_option(MergeOptionTypeEnum)
/set_merge_option(Option<MergeOptionTypeEnum>)
:
required: trueThe merge option or strategy you want to use to merge the code.
max_merge_hunks(i32)
/set_max_merge_hunks(Option<i32>)
:
required: falseThe maximum number of merge hunks to include in the output.
file_path(impl Into<String>)
/set_file_path(Option<String>)
:
required: trueThe path of the target files used to describe the conflicts.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
- On success, responds with
DescribeMergeConflictsOutput
with field(s):conflict_metadata(Option<ConflictMetadata>)
:Contains metadata about the conflicts found in the merge.
merge_hunks(Vec::<MergeHunk>)
:A list of merge hunks of the differences between the files or lines.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
destination_commit_id(String)
:The commit ID of the destination commit specifier that was used in the merge evaluation.
source_commit_id(String)
:The commit ID of the source commit specifier that was used in the merge evaluation.
base_commit_id(Option<String>)
:The commit ID of the merge base.
- On failure, responds with
SdkError<DescribeMergeConflictsError>
source§impl Client
impl Client
sourcepub fn describe_pull_request_events(
&self
) -> DescribePullRequestEventsFluentBuilder
pub fn describe_pull_request_events( &self ) -> DescribePullRequestEventsFluentBuilder
Constructs a fluent builder for the DescribePullRequestEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.pull_request_event_type(PullRequestEventType)
/set_pull_request_event_type(Option<PullRequestEventType>)
:
required: falseOptional. The pull request event type about which you want to return information.
actor_arn(impl Into<String>)
/set_actor_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with more commits or changing the status of a pull request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.
- On success, responds with
DescribePullRequestEventsOutput
with field(s):pull_request_events(Vec::<PullRequestEvent>)
:Information about the pull request events.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
- On failure, responds with
SdkError<DescribePullRequestEventsError>
source§impl Client
impl Client
sourcepub fn disassociate_approval_rule_template_from_repository(
&self
) -> DisassociateApprovalRuleTemplateFromRepositoryFluentBuilder
pub fn disassociate_approval_rule_template_from_repository( &self ) -> DisassociateApprovalRuleTemplateFromRepositoryFluentBuilder
Constructs a fluent builder for the DisassociateApprovalRuleTemplateFromRepository
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the approval rule template to disassociate from a specified repository.
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository you want to disassociate from the template.
- On success, responds with
DisassociateApprovalRuleTemplateFromRepositoryOutput
- On failure, responds with
SdkError<DisassociateApprovalRuleTemplateFromRepositoryError>
source§impl Client
impl Client
sourcepub fn evaluate_pull_request_approval_rules(
&self
) -> EvaluatePullRequestApprovalRulesFluentBuilder
pub fn evaluate_pull_request_approval_rules( &self ) -> EvaluatePullRequestApprovalRulesFluentBuilder
Constructs a fluent builder for the EvaluatePullRequestApprovalRules
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request you want to evaluate.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: trueThe system-generated ID for the pull request revision. To retrieve the most recent revision ID for a pull request, use
GetPullRequest
.
- On success, responds with
EvaluatePullRequestApprovalRulesOutput
with field(s):evaluation(Option<Evaluation>)
:The result of the evaluation, including the names of the rules whose conditions have been met (if any), the names of the rules whose conditions have not been met (if any), whether the pull request is in the approved state, and whether the pull request approval rule has been set aside by an override.
- On failure, responds with
SdkError<EvaluatePullRequestApprovalRulesError>
source§impl Client
impl Client
sourcepub fn get_approval_rule_template(&self) -> GetApprovalRuleTemplateFluentBuilder
pub fn get_approval_rule_template(&self) -> GetApprovalRuleTemplateFluentBuilder
Constructs a fluent builder for the GetApprovalRuleTemplate
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the approval rule template for which you want to get information.
- On success, responds with
GetApprovalRuleTemplateOutput
with field(s):approval_rule_template(Option<ApprovalRuleTemplate>)
:The content and structure of the approval rule template.
- On failure, responds with
SdkError<GetApprovalRuleTemplateError>
source§impl Client
impl Client
sourcepub fn get_blob(&self) -> GetBlobFluentBuilder
pub fn get_blob(&self) -> GetBlobFluentBuilder
Constructs a fluent builder for the GetBlob
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the blob.
blob_id(impl Into<String>)
/set_blob_id(Option<String>)
:
required: trueThe ID of the blob, which is its SHA-1 pointer.
- On success, responds with
GetBlobOutput
with field(s):content(Blob)
:The content of the blob, usually a file.
- On failure, responds with
SdkError<GetBlobError>
source§impl Client
impl Client
sourcepub fn get_branch(&self) -> GetBranchFluentBuilder
pub fn get_branch(&self) -> GetBranchFluentBuilder
Constructs a fluent builder for the GetBranch
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: falseThe name of the repository that contains the branch for which you want to retrieve information.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: falseThe name of the branch for which you want to retrieve information.
- On success, responds with
GetBranchOutput
with field(s):branch(Option<BranchInfo>)
:The name of the branch.
- On failure, responds with
SdkError<GetBranchError>
source§impl Client
impl Client
sourcepub fn get_comment(&self) -> GetCommentFluentBuilder
pub fn get_comment(&self) -> GetCommentFluentBuilder
Constructs a fluent builder for the GetComment
operation.
- The fluent builder is configurable:
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueThe unique, system-generated ID of the comment. To get this ID, use
GetCommentsForComparedCommit
orGetCommentsForPullRequest
.
- On success, responds with
GetCommentOutput
with field(s):comment(Option<Comment>)
:The contents of the comment.
- On failure, responds with
SdkError<GetCommentError>
source§impl Client
impl Client
sourcepub fn get_comment_reactions(&self) -> GetCommentReactionsFluentBuilder
pub fn get_comment_reactions(&self) -> GetCommentReactionsFluentBuilder
Constructs a fluent builder for the GetCommentReactions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueThe ID of the comment for which you want to get reactions information.
reaction_user_arn(impl Into<String>)
/set_reaction_user_arn(Option<String>)
:
required: falseOptional. The Amazon Resource Name (ARN) of the user or identity for which you want to get reaction information.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.
- On success, responds with
GetCommentReactionsOutput
with field(s):reactions_for_comment(Vec::<ReactionForComment>)
:An array of reactions to the specified comment.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
- On failure, responds with
SdkError<GetCommentReactionsError>
source§impl Client
impl Client
sourcepub fn get_comments_for_compared_commit(
&self
) -> GetCommentsForComparedCommitFluentBuilder
pub fn get_comments_for_compared_commit( &self ) -> GetCommentsForComparedCommitFluentBuilder
Constructs a fluent builder for the GetCommentsForComparedCommit
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to compare commits.
before_commit_id(impl Into<String>)
/set_before_commit_id(Option<String>)
:
required: falseTo establish the directionality of the comparison, the full commit ID of the before commit.
after_commit_id(impl Into<String>)
/set_after_commit_id(Option<String>)
:
required: trueTo establish the directionality of the comparison, the full commit ID of the after commit.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but you can configure up to 500.
- On success, responds with
GetCommentsForComparedCommitOutput
with field(s):comments_for_compared_commit_data(Option<Vec::<CommentsForComparedCommit>>)
:A list of comment objects on the compared commit.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
- On failure, responds with
SdkError<GetCommentsForComparedCommitError>
source§impl Client
impl Client
sourcepub fn get_comments_for_pull_request(
&self
) -> GetCommentsForPullRequestFluentBuilder
pub fn get_comments_for_pull_request( &self ) -> GetCommentsForPullRequestFluentBuilder
Constructs a fluent builder for the GetCommentsForPullRequest
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: falseThe name of the repository that contains the pull request. Requirement is conditional:
repositoryName
must be specified whenbeforeCommitId
andafterCommitId
are included.before_commit_id(impl Into<String>)
/set_before_commit_id(Option<String>)
:
required: falseThe full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created. Requirement is conditional:
beforeCommitId
must be specified whenrepositoryName
is included.after_commit_id(impl Into<String>)
/set_after_commit_id(Option<String>)
:
required: falseThe full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made. Requirement is conditional:
afterCommitId
must be specified whenrepositoryName
is included.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.
- On success, responds with
GetCommentsForPullRequestOutput
with field(s):comments_for_pull_request_data(Option<Vec::<CommentsForPullRequest>>)
:An array of comment objects on the pull request.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
- On failure, responds with
SdkError<GetCommentsForPullRequestError>
source§impl Client
impl Client
sourcepub fn get_commit(&self) -> GetCommitFluentBuilder
pub fn get_commit(&self) -> GetCommitFluentBuilder
Constructs a fluent builder for the GetCommit
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository to which the commit was made.
commit_id(impl Into<String>)
/set_commit_id(Option<String>)
:
required: trueThe commit ID. Commit IDs are the full SHA ID of the commit.
- On success, responds with
GetCommitOutput
with field(s):commit(Option<Commit>)
:A commit data type object that contains information about the specified commit.
- On failure, responds with
SdkError<GetCommitError>
source§impl Client
impl Client
sourcepub fn get_differences(&self) -> GetDifferencesFluentBuilder
pub fn get_differences(&self) -> GetDifferencesFluentBuilder
Constructs a fluent builder for the GetDifferences
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to get differences.
before_commit_specifier(impl Into<String>)
/set_before_commit_specifier(Option<String>)
:
required: falseThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, the full commit ID). Optional. If not specified, all changes before the
afterCommitSpecifier
value are shown. If you do not usebeforeCommitSpecifier
in your request, consider limiting the results withmaxResults
.after_commit_specifier(impl Into<String>)
/set_after_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit.
before_path(impl Into<String>)
/set_before_path(Option<String>)
:
required: falseThe file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If
beforePath
andafterPath
are not specified, differences are shown for all paths.after_path(impl Into<String>)
/set_after_path(Option<String>)
:
required: falseThe file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences are shown for all paths.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
- On success, responds with
GetDifferencesOutput
with field(s):differences(Option<Vec::<Difference>>)
:A data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
- On failure, responds with
SdkError<GetDifferencesError>
source§impl Client
impl Client
sourcepub fn get_file(&self) -> GetFileFluentBuilder
pub fn get_file(&self) -> GetFileFluentBuilder
Constructs a fluent builder for the GetFile
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the file.
commit_specifier(impl Into<String>)
/set_commit_specifier(Option<String>)
:
required: falseThe fully quaified reference that identifies the commit that contains the file. For example, you can specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/main. If none is provided, the head commit is used.
file_path(impl Into<String>)
/set_file_path(Option<String>)
:
required: trueThe fully qualified path to the file, including the full name and extension of the file. For example, /examples/file.md is the fully qualified path to a file named file.md in a folder named examples.
- On success, responds with
GetFileOutput
with field(s):commit_id(String)
:The full commit ID of the commit that contains the content returned by GetFile.
blob_id(String)
:The blob ID of the object that represents the file content.
file_path(String)
:The fully qualified path to the specified file. Returns the name and extension of the file.
file_mode(FileModeTypeEnum)
:The extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not numeric values.
The file mode permissions returned by this API are not the standard file mode permission values, such as 100644, but rather extrapolated values. See the supported return values.
file_size(i64)
:The size of the contents of the file, in bytes.
file_content(Blob)
:The base-64 encoded binary data object that represents the content of the file.
- On failure, responds with
SdkError<GetFileError>
source§impl Client
impl Client
sourcepub fn get_folder(&self) -> GetFolderFluentBuilder
pub fn get_folder(&self) -> GetFolderFluentBuilder
Constructs a fluent builder for the GetFolder
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository.
commit_specifier(impl Into<String>)
/set_commit_specifier(Option<String>)
:
required: falseA fully qualified reference used to identify a commit that contains the version of the folder’s content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.
folder_path(impl Into<String>)
/set_folder_path(Option<String>)
:
required: trueThe fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.
- On success, responds with
GetFolderOutput
with field(s):commit_id(String)
:The full commit ID used as a reference for the returned version of the folder content.
folder_path(String)
:The fully qualified path of the folder whose contents are returned.
tree_id(Option<String>)
:The full SHA-1 pointer of the tree information for the commit that contains the folder.
sub_folders(Option<Vec::<Folder>>)
:The list of folders that exist under the specified folder, if any.
files(Option<Vec::<File>>)
:The list of files in the specified folder, if any.
symbolic_links(Option<Vec::<SymbolicLink>>)
:The list of symbolic links to other files and folders in the specified folder, if any.
sub_modules(Option<Vec::<SubModule>>)
:The list of submodules in the specified folder, if any.
- On failure, responds with
SdkError<GetFolderError>
source§impl Client
impl Client
sourcepub fn get_merge_commit(&self) -> GetMergeCommitFluentBuilder
pub fn get_merge_commit(&self) -> GetMergeCommitFluentBuilder
Constructs a fluent builder for the GetMergeCommit
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the merge commit about which you want to get information.
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
- On success, responds with
GetMergeCommitOutput
with field(s):source_commit_id(Option<String>)
:The commit ID of the source commit specifier that was used in the merge evaluation.
destination_commit_id(Option<String>)
:The commit ID of the destination commit specifier that was used in the merge evaluation.
base_commit_id(Option<String>)
:The commit ID of the merge base.
merged_commit_id(Option<String>)
:The commit ID for the merge commit created when the source branch was merged into the destination branch. If the fast-forward merge strategy was used, there is no merge commit.
- On failure, responds with
SdkError<GetMergeCommitError>
source§impl Client
impl Client
sourcepub fn get_merge_conflicts(&self) -> GetMergeConflictsFluentBuilder
pub fn get_merge_conflicts(&self) -> GetMergeConflictsFluentBuilder
Constructs a fluent builder for the GetMergeConflicts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where the pull request was created.
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
merge_option(MergeOptionTypeEnum)
/set_merge_option(Option<MergeOptionTypeEnum>)
:
required: trueThe merge option or strategy you want to use to merge the code.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
max_conflict_files(i32)
/set_max_conflict_files(Option<i32>)
:
required: falseThe maximum number of files to include in the output.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
- On success, responds with
GetMergeConflictsOutput
with field(s):mergeable(bool)
:A Boolean value that indicates whether the code is mergeable by the specified merge option.
destination_commit_id(String)
:The commit ID of the destination commit specifier that was used in the merge evaluation.
source_commit_id(String)
:The commit ID of the source commit specifier that was used in the merge evaluation.
base_commit_id(Option<String>)
:The commit ID of the merge base.
conflict_metadata_list(Vec::<ConflictMetadata>)
:A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE, this list is always empty.
next_token(Option<String>)
:An enumeration token that can be used in a request to return the next batch of the results.
- On failure, responds with
SdkError<GetMergeConflictsError>
source§impl Client
impl Client
sourcepub fn get_merge_options(&self) -> GetMergeOptionsFluentBuilder
pub fn get_merge_options(&self) -> GetMergeOptionsFluentBuilder
Constructs a fluent builder for the GetMergeOptions
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the commits about which you want to get merge options.
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
- On success, responds with
GetMergeOptionsOutput
with field(s):merge_options(Vec::<MergeOptionTypeEnum>)
:The merge option or strategy used to merge the code.
source_commit_id(String)
:The commit ID of the source commit specifier that was used in the merge evaluation.
destination_commit_id(String)
:The commit ID of the destination commit specifier that was used in the merge evaluation.
base_commit_id(String)
:The commit ID of the merge base.
- On failure, responds with
SdkError<GetMergeOptionsError>
source§impl Client
impl Client
sourcepub fn get_pull_request(&self) -> GetPullRequestFluentBuilder
pub fn get_pull_request(&self) -> GetPullRequestFluentBuilder
Constructs a fluent builder for the GetPullRequest
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.
- On success, responds with
GetPullRequestOutput
with field(s):pull_request(Option<PullRequest>)
:Information about the specified pull request.
- On failure, responds with
SdkError<GetPullRequestError>
source§impl Client
impl Client
sourcepub fn get_pull_request_approval_states(
&self
) -> GetPullRequestApprovalStatesFluentBuilder
pub fn get_pull_request_approval_states( &self ) -> GetPullRequestApprovalStatesFluentBuilder
Constructs a fluent builder for the GetPullRequestApprovalStates
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID for the pull request.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: trueThe system-generated ID for the pull request revision.
- On success, responds with
GetPullRequestApprovalStatesOutput
with field(s):approvals(Option<Vec::<Approval>>)
:Information about users who have approved the pull request.
- On failure, responds with
SdkError<GetPullRequestApprovalStatesError>
source§impl Client
impl Client
sourcepub fn get_pull_request_override_state(
&self
) -> GetPullRequestOverrideStateFluentBuilder
pub fn get_pull_request_override_state( &self ) -> GetPullRequestOverrideStateFluentBuilder
Constructs a fluent builder for the GetPullRequestOverrideState
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe ID of the pull request for which you want to get information about whether approval rules have been set aside (overridden).
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: trueThe system-generated ID of the revision for the pull request. To retrieve the most recent revision ID, use
GetPullRequest
.
- On success, responds with
GetPullRequestOverrideStateOutput
with field(s):overridden(bool)
:A Boolean value that indicates whether a pull request has had its rules set aside (TRUE) or whether all approval rules still apply (FALSE).
overrider(Option<String>)
:The Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.
- On failure, responds with
SdkError<GetPullRequestOverrideStateError>
source§impl Client
impl Client
sourcepub fn get_repository(&self) -> GetRepositoryFluentBuilder
pub fn get_repository(&self) -> GetRepositoryFluentBuilder
Constructs a fluent builder for the GetRepository
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository to get information about.
- On success, responds with
GetRepositoryOutput
with field(s):repository_metadata(Option<RepositoryMetadata>)
:Information about the repository.
- On failure, responds with
SdkError<GetRepositoryError>
source§impl Client
impl Client
sourcepub fn get_repository_triggers(&self) -> GetRepositoryTriggersFluentBuilder
pub fn get_repository_triggers(&self) -> GetRepositoryTriggersFluentBuilder
Constructs a fluent builder for the GetRepositoryTriggers
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository for which the trigger is configured.
- On success, responds with
GetRepositoryTriggersOutput
with field(s):configuration_id(Option<String>)
:The system-generated unique ID for the trigger.
triggers(Option<Vec::<RepositoryTrigger>>)
:The JSON block of configuration information for each trigger.
- On failure, responds with
SdkError<GetRepositoryTriggersError>
source§impl Client
impl Client
sourcepub fn list_approval_rule_templates(
&self
) -> ListApprovalRuleTemplatesFluentBuilder
pub fn list_approval_rule_templates( &self ) -> ListApprovalRuleTemplatesFluentBuilder
Constructs a fluent builder for the ListApprovalRuleTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results.
- On success, responds with
ListApprovalRuleTemplatesOutput
with field(s):approval_rule_template_names(Option<Vec::<String>>)
:The names of all the approval rule templates found in the Amazon Web Services Region for your Amazon Web Services account.
next_token(Option<String>)
:An enumeration token that allows the operation to batch the next results of the operation.
- On failure, responds with
SdkError<ListApprovalRuleTemplatesError>
source§impl Client
impl Client
sourcepub fn list_associated_approval_rule_templates_for_repository(
&self
) -> ListAssociatedApprovalRuleTemplatesForRepositoryFluentBuilder
pub fn list_associated_approval_rule_templates_for_repository( &self ) -> ListAssociatedApprovalRuleTemplatesForRepositoryFluentBuilder
Constructs a fluent builder for the ListAssociatedApprovalRuleTemplatesForRepository
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository for which you want to list all associated approval rule templates.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results.
- On success, responds with
ListAssociatedApprovalRuleTemplatesForRepositoryOutput
with field(s):approval_rule_template_names(Option<Vec::<String>>)
:The names of all approval rule templates associated with the repository.
next_token(Option<String>)
:An enumeration token that allows the operation to batch the next results of the operation.
- On failure, responds with
SdkError<ListAssociatedApprovalRuleTemplatesForRepositoryError>
source§impl Client
impl Client
sourcepub fn list_branches(&self) -> ListBranchesFluentBuilder
pub fn list_branches(&self) -> ListBranchesFluentBuilder
Constructs a fluent builder for the ListBranches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the branches.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that allows the operation to batch the results.
- On success, responds with
ListBranchesOutput
with field(s):branches(Option<Vec::<String>>)
:The list of branch names.
next_token(Option<String>)
:An enumeration token that returns the batch of the results.
- On failure, responds with
SdkError<ListBranchesError>
source§impl Client
impl Client
sourcepub fn list_file_commit_history(&self) -> ListFileCommitHistoryFluentBuilder
pub fn list_file_commit_history(&self) -> ListFileCommitHistoryFluentBuilder
Constructs a fluent builder for the ListFileCommitHistory
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository that contains the file.
commit_specifier(impl Into<String>)
/set_commit_specifier(Option<String>)
:
required: falseThe fully quaified reference that identifies the commit that contains the file. For example, you can specify a full commit ID, a tag, a branch name, or a reference such as
refs/heads/main
. If none is provided, the head commit is used.file_path(impl Into<String>)
/set_file_path(Option<String>)
:
required: trueThe full path of the file whose history you want to retrieve, including the name of the file.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that allows the operation to batch the results.
- On success, responds with
ListFileCommitHistoryOutput
with field(s):revision_dag(Vec::<FileVersion>)
:An array of FileVersion objects that form a directed acyclic graph (DAG) of the changes to the file made by the commits that changed the file.
next_token(Option<String>)
:An enumeration token that can be used to return the next batch of results.
- On failure, responds with
SdkError<ListFileCommitHistoryError>
source§impl Client
impl Client
sourcepub fn list_pull_requests(&self) -> ListPullRequestsFluentBuilder
pub fn list_pull_requests(&self) -> ListPullRequestsFluentBuilder
Constructs a fluent builder for the ListPullRequests
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository for which you want to list pull requests.
author_arn(impl Into<String>)
/set_author_arn(Option<String>)
:
required: falseOptional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.
pull_request_status(PullRequestStatusEnum)
/set_pull_request_status(Option<PullRequestStatusEnum>)
:
required: falseOptional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results.
- On success, responds with
ListPullRequestsOutput
with field(s):pull_request_ids(Vec::<String>)
:The system-generated IDs of the pull requests.
next_token(Option<String>)
:An enumeration token that allows the operation to batch the next results of the operation.
- On failure, responds with
SdkError<ListPullRequestsError>
source§impl Client
impl Client
sourcepub fn list_repositories(&self) -> ListRepositoriesFluentBuilder
pub fn list_repositories(&self) -> ListRepositoriesFluentBuilder
Constructs a fluent builder for the ListRepositories
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to CodeCommit, another page of 1,000 records is retrieved.
sort_by(SortByEnum)
/set_sort_by(Option<SortByEnum>)
:
required: falseThe criteria used to sort the results of a list repositories operation.
order(OrderEnum)
/set_order(Option<OrderEnum>)
:
required: falseThe order in which to sort the results of a list repositories operation.
- On success, responds with
ListRepositoriesOutput
with field(s):repositories(Option<Vec::<RepositoryNameIdPair>>)
:Lists the repositories called by the list repositories operation.
next_token(Option<String>)
:An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to CodeCommit, another page of 1,000 records is retrieved.
- On failure, responds with
SdkError<ListRepositoriesError>
source§impl Client
impl Client
sourcepub fn list_repositories_for_approval_rule_template(
&self
) -> ListRepositoriesForApprovalRuleTemplateFluentBuilder
pub fn list_repositories_for_approval_rule_template( &self ) -> ListRepositoriesForApprovalRuleTemplateFluentBuilder
Constructs a fluent builder for the ListRepositoriesForApprovalRuleTemplate
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the approval rule template for which you want to list repositories that are associated with that template.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseA non-zero, non-negative integer used to limit the number of returned results.
- On success, responds with
ListRepositoriesForApprovalRuleTemplateOutput
with field(s):repository_names(Option<Vec::<String>>)
:A list of repository names that are associated with the specified approval rule template.
next_token(Option<String>)
:An enumeration token that allows the operation to batch the next results of the operation.
- On failure, responds with
SdkError<ListRepositoriesForApprovalRuleTemplateError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseAn enumeration token that, when provided in a request, returns the next batch of the results.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:A list of tag key and value pairs associated with the specified resource.
next_token(Option<String>)
:An enumeration token that allows the operation to batch the next results of the operation.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn merge_branches_by_fast_forward(
&self
) -> MergeBranchesByFastForwardFluentBuilder
pub fn merge_branches_by_fast_forward( &self ) -> MergeBranchesByFastForwardFluentBuilder
Constructs a fluent builder for the MergeBranchesByFastForward
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to merge two branches.
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
target_branch(impl Into<String>)
/set_target_branch(Option<String>)
:
required: falseThe branch where the merge is applied.
- On success, responds with
MergeBranchesByFastForwardOutput
with field(s):commit_id(Option<String>)
:The commit ID of the merge in the destination or target branch.
tree_id(Option<String>)
:The tree ID of the merge in the destination or target branch.
- On failure, responds with
SdkError<MergeBranchesByFastForwardError>
source§impl Client
impl Client
sourcepub fn merge_branches_by_squash(&self) -> MergeBranchesBySquashFluentBuilder
pub fn merge_branches_by_squash(&self) -> MergeBranchesBySquashFluentBuilder
Constructs a fluent builder for the MergeBranchesBySquash
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to merge two branches.
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
target_branch(impl Into<String>)
/set_target_branch(Option<String>)
:
required: falseThe branch where the merge is applied.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
author_name(impl Into<String>)
/set_author_name(Option<String>)
:
required: falseThe name of the author who created the commit. This information is used as both the author and committer for the commit.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address of the person merging the branches. This information is used in the commit information for the merge.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message for the merge.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file is created for empty folders. The default is false.
conflict_resolution(ConflictResolution)
/set_conflict_resolution(Option<ConflictResolution>)
:
required: falseIf AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
- On success, responds with
MergeBranchesBySquashOutput
with field(s):commit_id(Option<String>)
:The commit ID of the merge in the destination or target branch.
tree_id(Option<String>)
:The tree ID of the merge in the destination or target branch.
- On failure, responds with
SdkError<MergeBranchesBySquashError>
source§impl Client
impl Client
sourcepub fn merge_branches_by_three_way(
&self
) -> MergeBranchesByThreeWayFluentBuilder
pub fn merge_branches_by_three_way( &self ) -> MergeBranchesByThreeWayFluentBuilder
Constructs a fluent builder for the MergeBranchesByThreeWay
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to merge two branches.
source_commit_specifier(impl Into<String>)
/set_source_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
destination_commit_specifier(impl Into<String>)
/set_destination_commit_specifier(Option<String>)
:
required: trueThe branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
target_branch(impl Into<String>)
/set_target_branch(Option<String>)
:
required: falseThe branch where the merge is applied.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
author_name(impl Into<String>)
/set_author_name(Option<String>)
:
required: falseThe name of the author who created the commit. This information is used as both the author and committer for the commit.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address of the person merging the branches. This information is used in the commit information for the merge.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message to include in the commit information for the merge.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a .gitkeep file is created for empty folders. The default is false.
conflict_resolution(ConflictResolution)
/set_conflict_resolution(Option<ConflictResolution>)
:
required: falseIf AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
- On success, responds with
MergeBranchesByThreeWayOutput
with field(s):commit_id(Option<String>)
:The commit ID of the merge in the destination or target branch.
tree_id(Option<String>)
:The tree ID of the merge in the destination or target branch.
- On failure, responds with
SdkError<MergeBranchesByThreeWayError>
source§impl Client
impl Client
sourcepub fn merge_pull_request_by_fast_forward(
&self
) -> MergePullRequestByFastForwardFluentBuilder
pub fn merge_pull_request_by_fast_forward( &self ) -> MergePullRequestByFastForwardFluentBuilder
Constructs a fluent builder for the MergePullRequestByFastForward
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where the pull request was created.
source_commit_id(impl Into<String>)
/set_source_commit_id(Option<String>)
:
required: falseThe full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
- On success, responds with
MergePullRequestByFastForwardOutput
with field(s):pull_request(Option<PullRequest>)
:Information about the specified pull request, including the merge.
- On failure, responds with
SdkError<MergePullRequestByFastForwardError>
source§impl Client
impl Client
sourcepub fn merge_pull_request_by_squash(
&self
) -> MergePullRequestBySquashFluentBuilder
pub fn merge_pull_request_by_squash( &self ) -> MergePullRequestBySquashFluentBuilder
Constructs a fluent builder for the MergePullRequestBySquash
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where the pull request was created.
source_commit_id(impl Into<String>)
/set_source_commit_id(Option<String>)
:
required: falseThe full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message to include in the commit information for the merge.
author_name(impl Into<String>)
/set_author_name(Option<String>)
:
required: falseThe name of the author who created the commit. This information is used as both the author and committer for the commit.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address of the person merging the branches. This information is used in the commit information for the merge.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a .gitkeep file is created for empty folders. The default is false.
conflict_resolution(ConflictResolution)
/set_conflict_resolution(Option<ConflictResolution>)
:
required: falseIf AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
- On success, responds with
MergePullRequestBySquashOutput
with field(s):pull_request(Option<PullRequest>)
:Returns information about a pull request.
- On failure, responds with
SdkError<MergePullRequestBySquashError>
source§impl Client
impl Client
sourcepub fn merge_pull_request_by_three_way(
&self
) -> MergePullRequestByThreeWayFluentBuilder
pub fn merge_pull_request_by_three_way( &self ) -> MergePullRequestByThreeWayFluentBuilder
Constructs a fluent builder for the MergePullRequestByThreeWay
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where the pull request was created.
source_commit_id(impl Into<String>)
/set_source_commit_id(Option<String>)
:
required: falseThe full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
conflict_detail_level(ConflictDetailLevelTypeEnum)
/set_conflict_detail_level(Option<ConflictDetailLevelTypeEnum>)
:
required: falseThe level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.
conflict_resolution_strategy(ConflictResolutionStrategyTypeEnum)
/set_conflict_resolution_strategy(Option<ConflictResolutionStrategyTypeEnum>)
:
required: falseSpecifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseThe commit message to include in the commit information for the merge.
author_name(impl Into<String>)
/set_author_name(Option<String>)
:
required: falseThe name of the author who created the commit. This information is used as both the author and committer for the commit.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseThe email address of the person merging the branches. This information is used in the commit information for the merge.
keep_empty_folders(bool)
/set_keep_empty_folders(Option<bool>)
:
required: falseIf the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a .gitkeep file is created for empty folders. The default is false.
conflict_resolution(ConflictResolution)
/set_conflict_resolution(Option<ConflictResolution>)
:
required: falseIf AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
- On success, responds with
MergePullRequestByThreeWayOutput
with field(s):pull_request(Option<PullRequest>)
:Returns information about a pull request.
- On failure, responds with
SdkError<MergePullRequestByThreeWayError>
source§impl Client
impl Client
sourcepub fn override_pull_request_approval_rules(
&self
) -> OverridePullRequestApprovalRulesFluentBuilder
pub fn override_pull_request_approval_rules( &self ) -> OverridePullRequestApprovalRulesFluentBuilder
Constructs a fluent builder for the OverridePullRequestApprovalRules
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request for which you want to override all approval rule requirements. To get this information, use
GetPullRequest
.revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: trueThe system-generated ID of the most recent revision of the pull request. You cannot override approval rules for anything but the most recent revision of a pull request. To get the revision ID, use GetPullRequest.
override_status(OverrideStatus)
/set_override_status(Option<OverrideStatus>)
:
required: trueWhether you want to set aside approval rule requirements for the pull request (OVERRIDE) or revoke a previous override and apply approval rule requirements (REVOKE). REVOKE status is not stored.
- On success, responds with
OverridePullRequestApprovalRulesOutput
- On failure, responds with
SdkError<OverridePullRequestApprovalRulesError>
source§impl Client
impl Client
sourcepub fn post_comment_for_compared_commit(
&self
) -> PostCommentForComparedCommitFluentBuilder
pub fn post_comment_for_compared_commit( &self ) -> PostCommentForComparedCommitFluentBuilder
Constructs a fluent builder for the PostCommentForComparedCommit
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to post a comment on the comparison between commits.
before_commit_id(impl Into<String>)
/set_before_commit_id(Option<String>)
:
required: falseTo establish the directionality of the comparison, the full commit ID of the before commit. Required for commenting on any commit unless that commit is the initial commit.
after_commit_id(impl Into<String>)
/set_after_commit_id(Option<String>)
:
required: trueTo establish the directionality of the comparison, the full commit ID of the after commit.
location(Location)
/set_location(Option<Location>)
:
required: falseThe location of the comparison where you want to comment.
content(impl Into<String>)
/set_content(Option<String>)
:
required: trueThe content of the comment you want to make.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
- On success, responds with
PostCommentForComparedCommitOutput
with field(s):repository_name(Option<String>)
:The name of the repository where you posted a comment on the comparison between commits.
before_commit_id(Option<String>)
:In the directionality you established, the full commit ID of the before commit.
after_commit_id(Option<String>)
:In the directionality you established, the full commit ID of the after commit.
before_blob_id(Option<String>)
:In the directionality you established, the blob ID of the before blob.
after_blob_id(Option<String>)
:In the directionality you established, the blob ID of the after blob.
location(Option<Location>)
:The location of the comment in the comparison between the two commits.
comment(Option<Comment>)
:The content of the comment you posted.
- On failure, responds with
SdkError<PostCommentForComparedCommitError>
source§impl Client
impl Client
sourcepub fn post_comment_for_pull_request(
&self
) -> PostCommentForPullRequestFluentBuilder
pub fn post_comment_for_pull_request( &self ) -> PostCommentForPullRequestFluentBuilder
Constructs a fluent builder for the PostCommentForPullRequest
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to post a comment on a pull request.
before_commit_id(impl Into<String>)
/set_before_commit_id(Option<String>)
:
required: trueThe full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.
after_commit_id(impl Into<String>)
/set_after_commit_id(Option<String>)
:
required: trueThe full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.
location(Location)
/set_location(Option<Location>)
:
required: falseThe location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.
content(impl Into<String>)
/set_content(Option<String>)
:
required: trueThe content of your comment on the change.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
- On success, responds with
PostCommentForPullRequestOutput
with field(s):repository_name(Option<String>)
:The name of the repository where you posted a comment on a pull request.
pull_request_id(Option<String>)
:The system-generated ID of the pull request.
before_commit_id(Option<String>)
:The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.
after_commit_id(Option<String>)
:The full commit ID of the commit in the destination branch where the pull request is merged.
before_blob_id(Option<String>)
:In the directionality of the pull request, the blob ID of the before blob.
after_blob_id(Option<String>)
:In the directionality of the pull request, the blob ID of the after blob.
location(Option<Location>)
:The location of the change where you posted your comment.
comment(Option<Comment>)
:The content of the comment you posted.
- On failure, responds with
SdkError<PostCommentForPullRequestError>
source§impl Client
impl Client
sourcepub fn post_comment_reply(&self) -> PostCommentReplyFluentBuilder
pub fn post_comment_reply(&self) -> PostCommentReplyFluentBuilder
Constructs a fluent builder for the PostCommentReply
operation.
- The fluent builder is configurable:
in_reply_to(impl Into<String>)
/set_in_reply_to(Option<String>)
:
required: trueThe system-generated ID of the comment to which you want to reply. To get this ID, use
GetCommentsForComparedCommit
orGetCommentsForPullRequest
.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: falseA unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
content(impl Into<String>)
/set_content(Option<String>)
:
required: trueThe contents of your reply to a comment.
- On success, responds with
PostCommentReplyOutput
with field(s):comment(Option<Comment>)
:Information about the reply to a comment.
- On failure, responds with
SdkError<PostCommentReplyError>
source§impl Client
impl Client
sourcepub fn put_comment_reaction(&self) -> PutCommentReactionFluentBuilder
pub fn put_comment_reaction(&self) -> PutCommentReactionFluentBuilder
Constructs a fluent builder for the PutCommentReaction
operation.
- The fluent builder is configurable:
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueThe ID of the comment to which you want to add or update a reaction.
reaction_value(impl Into<String>)
/set_reaction_value(Option<String>)
:
required: trueThe emoji reaction you want to add or update. To remove a reaction, provide a value of blank or null. You can also provide the value of none. For information about emoji reaction values supported in CodeCommit, see the CodeCommit User Guide.
- On success, responds with
PutCommentReactionOutput
- On failure, responds with
SdkError<PutCommentReactionError>
source§impl Client
impl Client
sourcepub fn put_file(&self) -> PutFileFluentBuilder
pub fn put_file(&self) -> PutFileFluentBuilder
Constructs a fluent builder for the PutFile
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to add or update the file.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:
required: trueThe name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.
file_content(Blob)
/set_file_content(Option<Blob>)
:
required: trueThe content of the file, in binary object format.
file_path(impl Into<String>)
/set_file_path(Option<String>)
:
required: trueThe name of the file you want to add or update, including the relative path to the file in the repository.
If the path does not currently exist in the repository, the path is created as part of adding the file.
file_mode(FileModeTypeEnum)
/set_file_mode(Option<FileModeTypeEnum>)
:
required: falseThe file mode permissions of the blob. Valid file mode permissions are listed here.
parent_commit_id(impl Into<String>)
/set_parent_commit_id(Option<String>)
:
required: falseThe full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.
The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:
required: falseA message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.
email(impl Into<String>)
/set_email(Option<String>)
:
required: falseAn email address for the person adding or updating the file.
- On success, responds with
PutFileOutput
with field(s):commit_id(String)
:The full SHA ID of the commit that contains this file change.
blob_id(String)
:The ID of the blob, which is its SHA-1 pointer.
tree_id(String)
:The full SHA-1 pointer of the tree information for the commit that contains this file change.
- On failure, responds with
SdkError<PutFileError>
source§impl Client
impl Client
sourcepub fn put_repository_triggers(&self) -> PutRepositoryTriggersFluentBuilder
pub fn put_repository_triggers(&self) -> PutRepositoryTriggersFluentBuilder
Constructs a fluent builder for the PutRepositoryTriggers
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository where you want to create or update the trigger.
triggers(RepositoryTrigger)
/set_triggers(Option<Vec::<RepositoryTrigger>>)
:
required: trueThe JSON block of configuration information for each trigger.
- On success, responds with
PutRepositoryTriggersOutput
with field(s):configuration_id(Option<String>)
:The system-generated unique ID for the create or update operation.
- On failure, responds with
SdkError<PutRepositoryTriggersError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource to which you want to add or update tags.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe key-value pair to use when tagging this repository.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn test_repository_triggers(&self) -> TestRepositoryTriggersFluentBuilder
pub fn test_repository_triggers(&self) -> TestRepositoryTriggersFluentBuilder
Constructs a fluent builder for the TestRepositoryTriggers
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository in which to test the triggers.
triggers(RepositoryTrigger)
/set_triggers(Option<Vec::<RepositoryTrigger>>)
:
required: trueThe list of triggers to test.
- On success, responds with
TestRepositoryTriggersOutput
with field(s):successful_executions(Option<Vec::<String>>)
:The list of triggers that were successfully tested. This list provides the names of the triggers that were successfully tested, separated by commas.
failed_executions(Option<Vec::<RepositoryTriggerExecutionFailure>>)
:The list of triggers that were not tested. This list provides the names of the triggers that could not be tested, separated by commas.
- On failure, responds with
SdkError<TestRepositoryTriggersError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource to which you want to remove tags.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag key for each tag that you want to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_approval_rule_template_content(
&self
) -> UpdateApprovalRuleTemplateContentFluentBuilder
pub fn update_approval_rule_template_content( &self ) -> UpdateApprovalRuleTemplateContentFluentBuilder
Constructs a fluent builder for the UpdateApprovalRuleTemplateContent
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the approval rule template where you want to update the content of the rule.
new_rule_content(impl Into<String>)
/set_new_rule_content(Option<String>)
:
required: trueThe content that replaces the existing content of the rule. Content statements must be complete. You cannot provide only the changes.
existing_rule_content_sha256(impl Into<String>)
/set_existing_rule_content_sha256(Option<String>)
:
required: falseThe SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using
GetPullRequest
.
- On success, responds with
UpdateApprovalRuleTemplateContentOutput
with field(s):approval_rule_template(Option<ApprovalRuleTemplate>)
:Returns information about an approval rule template.
- On failure, responds with
SdkError<UpdateApprovalRuleTemplateContentError>
source§impl Client
impl Client
sourcepub fn update_approval_rule_template_description(
&self
) -> UpdateApprovalRuleTemplateDescriptionFluentBuilder
pub fn update_approval_rule_template_description( &self ) -> UpdateApprovalRuleTemplateDescriptionFluentBuilder
Constructs a fluent builder for the UpdateApprovalRuleTemplateDescription
operation.
- The fluent builder is configurable:
approval_rule_template_name(impl Into<String>)
/set_approval_rule_template_name(Option<String>)
:
required: trueThe name of the template for which you want to update the description.
approval_rule_template_description(impl Into<String>)
/set_approval_rule_template_description(Option<String>)
:
required: trueThe updated description of the approval rule template.
- On success, responds with
UpdateApprovalRuleTemplateDescriptionOutput
with field(s):approval_rule_template(Option<ApprovalRuleTemplate>)
:The structure and content of the updated approval rule template.
- On failure, responds with
SdkError<UpdateApprovalRuleTemplateDescriptionError>
source§impl Client
impl Client
sourcepub fn update_approval_rule_template_name(
&self
) -> UpdateApprovalRuleTemplateNameFluentBuilder
pub fn update_approval_rule_template_name( &self ) -> UpdateApprovalRuleTemplateNameFluentBuilder
Constructs a fluent builder for the UpdateApprovalRuleTemplateName
operation.
- The fluent builder is configurable:
old_approval_rule_template_name(impl Into<String>)
/set_old_approval_rule_template_name(Option<String>)
:
required: trueThe current name of the approval rule template.
new_approval_rule_template_name(impl Into<String>)
/set_new_approval_rule_template_name(Option<String>)
:
required: trueThe new name you want to apply to the approval rule template.
- On success, responds with
UpdateApprovalRuleTemplateNameOutput
with field(s):approval_rule_template(Option<ApprovalRuleTemplate>)
:The structure and content of the updated approval rule template.
- On failure, responds with
SdkError<UpdateApprovalRuleTemplateNameError>
source§impl Client
impl Client
sourcepub fn update_comment(&self) -> UpdateCommentFluentBuilder
pub fn update_comment(&self) -> UpdateCommentFluentBuilder
Constructs a fluent builder for the UpdateComment
operation.
- The fluent builder is configurable:
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueThe system-generated ID of the comment you want to update. To get this ID, use
GetCommentsForComparedCommit
orGetCommentsForPullRequest
.content(impl Into<String>)
/set_content(Option<String>)
:
required: trueThe updated content to replace the existing content of the comment.
- On success, responds with
UpdateCommentOutput
with field(s):comment(Option<Comment>)
:Information about the updated comment.
- On failure, responds with
SdkError<UpdateCommentError>
source§impl Client
impl Client
sourcepub fn update_default_branch(&self) -> UpdateDefaultBranchFluentBuilder
pub fn update_default_branch(&self) -> UpdateDefaultBranchFluentBuilder
Constructs a fluent builder for the UpdateDefaultBranch
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository for which you want to set or change the default branch.
default_branch_name(impl Into<String>)
/set_default_branch_name(Option<String>)
:
required: trueThe name of the branch to set as the default branch.
- On success, responds with
UpdateDefaultBranchOutput
- On failure, responds with
SdkError<UpdateDefaultBranchError>
source§impl Client
impl Client
sourcepub fn update_pull_request_approval_rule_content(
&self
) -> UpdatePullRequestApprovalRuleContentFluentBuilder
pub fn update_pull_request_approval_rule_content( &self ) -> UpdatePullRequestApprovalRuleContentFluentBuilder
Constructs a fluent builder for the UpdatePullRequestApprovalRuleContent
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request.
approval_rule_name(impl Into<String>)
/set_approval_rule_name(Option<String>)
:
required: trueThe name of the approval rule you want to update.
existing_rule_content_sha256(impl Into<String>)
/set_existing_rule_content_sha256(Option<String>)
:
required: falseThe SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using
GetPullRequest
.new_rule_content(impl Into<String>)
/set_new_rule_content(Option<String>)
:
required: trueThe updated content for the approval rule.
When you update the content of the approval rule, you can specify approvers in an approval pool in one of two ways:
-
CodeCommitApprovers: This option only requires an Amazon Web Services account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the Amazon Web Services account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:
-
An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
-
A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)
This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).
-
-
Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.
For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.
-
- On success, responds with
UpdatePullRequestApprovalRuleContentOutput
with field(s):approval_rule(Option<ApprovalRule>)
:Information about the updated approval rule.
- On failure, responds with
SdkError<UpdatePullRequestApprovalRuleContentError>
source§impl Client
impl Client
sourcepub fn update_pull_request_approval_state(
&self
) -> UpdatePullRequestApprovalStateFluentBuilder
pub fn update_pull_request_approval_state( &self ) -> UpdatePullRequestApprovalStateFluentBuilder
Constructs a fluent builder for the UpdatePullRequestApprovalState
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: trueThe system-generated ID of the revision.
approval_state(ApprovalState)
/set_approval_state(Option<ApprovalState>)
:
required: trueThe approval state to associate with the user on the pull request.
- On success, responds with
UpdatePullRequestApprovalStateOutput
- On failure, responds with
SdkError<UpdatePullRequestApprovalStateError>
source§impl Client
impl Client
sourcepub fn update_pull_request_description(
&self
) -> UpdatePullRequestDescriptionFluentBuilder
pub fn update_pull_request_description( &self ) -> UpdatePullRequestDescriptionFluentBuilder
Constructs a fluent builder for the UpdatePullRequestDescription
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.description(impl Into<String>)
/set_description(Option<String>)
:
required: trueThe updated content of the description for the pull request. This content replaces the existing description.
- On success, responds with
UpdatePullRequestDescriptionOutput
with field(s):pull_request(Option<PullRequest>)
:Information about the updated pull request.
- On failure, responds with
SdkError<UpdatePullRequestDescriptionError>
source§impl Client
impl Client
sourcepub fn update_pull_request_status(&self) -> UpdatePullRequestStatusFluentBuilder
pub fn update_pull_request_status(&self) -> UpdatePullRequestStatusFluentBuilder
Constructs a fluent builder for the UpdatePullRequestStatus
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.pull_request_status(PullRequestStatusEnum)
/set_pull_request_status(Option<PullRequestStatusEnum>)
:
required: trueThe status of the pull request. The only valid operations are to update the status from
OPEN
toOPEN
,OPEN
toCLOSED
or fromCLOSED
toCLOSED
.
- On success, responds with
UpdatePullRequestStatusOutput
with field(s):pull_request(Option<PullRequest>)
:Information about the pull request.
- On failure, responds with
SdkError<UpdatePullRequestStatusError>
source§impl Client
impl Client
sourcepub fn update_pull_request_title(&self) -> UpdatePullRequestTitleFluentBuilder
pub fn update_pull_request_title(&self) -> UpdatePullRequestTitleFluentBuilder
Constructs a fluent builder for the UpdatePullRequestTitle
operation.
- The fluent builder is configurable:
pull_request_id(impl Into<String>)
/set_pull_request_id(Option<String>)
:
required: trueThe system-generated ID of the pull request. To get this ID, use
ListPullRequests
.title(impl Into<String>)
/set_title(Option<String>)
:
required: trueThe updated title of the pull request. This replaces the existing title.
- On success, responds with
UpdatePullRequestTitleOutput
with field(s):pull_request(Option<PullRequest>)
:Information about the updated pull request.
- On failure, responds with
SdkError<UpdatePullRequestTitleError>
source§impl Client
impl Client
sourcepub fn update_repository_description(
&self
) -> UpdateRepositoryDescriptionFluentBuilder
pub fn update_repository_description( &self ) -> UpdateRepositoryDescriptionFluentBuilder
Constructs a fluent builder for the UpdateRepositoryDescription
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository to set or change the comment or description for.
repository_description(impl Into<String>)
/set_repository_description(Option<String>)
:
required: falseThe new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.
- On success, responds with
UpdateRepositoryDescriptionOutput
- On failure, responds with
SdkError<UpdateRepositoryDescriptionError>
source§impl Client
impl Client
sourcepub fn update_repository_encryption_key(
&self
) -> UpdateRepositoryEncryptionKeyFluentBuilder
pub fn update_repository_encryption_key( &self ) -> UpdateRepositoryEncryptionKeyFluentBuilder
Constructs a fluent builder for the UpdateRepositoryEncryptionKey
operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)
/set_repository_name(Option<String>)
:
required: trueThe name of the repository for which you want to update the KMS encryption key used to encrypt and decrypt the repository.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: trueThe ID of the encryption key. You can view the ID of an encryption key in the KMS console, or use the KMS APIs to programmatically retrieve a key ID. For more information about acceptable values for keyID, see KeyId in the Decrypt API description in the Key Management Service API Reference.
- On success, responds with
UpdateRepositoryEncryptionKeyOutput
with field(s):repository_id(Option<String>)
:The ID of the repository.
kms_key_id(Option<String>)
:The ID of the encryption key.
original_kms_key_id(Option<String>)
:The ID of the encryption key formerly used to encrypt and decrypt the repository.
- On failure, responds with
SdkError<UpdateRepositoryEncryptionKeyError>
source§impl Client
impl Client
sourcepub fn update_repository_name(&self) -> UpdateRepositoryNameFluentBuilder
pub fn update_repository_name(&self) -> UpdateRepositoryNameFluentBuilder
Constructs a fluent builder for the UpdateRepositoryName
operation.
- The fluent builder is configurable:
old_name(impl Into<String>)
/set_old_name(Option<String>)
:
required: trueThe current name of the repository.
new_name(impl Into<String>)
/set_new_name(Option<String>)
:
required: trueThe new name for the repository.
- On success, responds with
UpdateRepositoryNameOutput
- On failure, responds with
SdkError<UpdateRepositoryNameError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more