Creates an association between an approval rule template and a specified repository. Then, the next time a pull request is created in the repository where the destination reference (if specified) matches the destination reference (branch) for the pull request, an approval rule that matches the template conditions is automatically created for that pull request. If no destination references are specified in the template, an approval rule that matches the template contents is created for all pull requests in that repository.
#batch_describe_merge_conflicts(options = {}) ⇒ Types::BatchDescribeMergeConflictsOutputReturns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.
#batch_get_commits(options = {}) ⇒ Types::BatchGetCommitsOutputReturns information about the contents of one or more commits in a repository.
#batch_get_repositories(options = {}) ⇒ Types::BatchGetRepositoriesOutputReturns information about one or more repositories.
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.
#create_approval_rule_template(options = {}) ⇒ Types::CreateApprovalRuleTemplateOutputCreates a template for approval rules that can then be associated with one or more repositories in your AWS account. When you associate a template with a repository, AWS CodeCommit creates an approval rule that matches the conditions of the template for all pull requests that meet the conditions of the template. For more information, see AssociateApprovalRuleTemplateWithRepository.
#create_branch(options = {}) ⇒ StructCreates a branch in a repository and points the branch to a commit.
Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.
#create_unreferenced_merge_commit(options = {}) ⇒ Types::CreateUnreferencedMergeCommitOutputCreates an unreferenced commit that represents the result of merging two branches using a specified merge strategy. This can help you determine the outcome of a potential merge. This API cannot be used with the fast-forward merge strategy because that strategy does not create a merge commit.
This unreferenced merge commit can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.
#delete_approval_rule_template(options = {}) ⇒ Types::DeleteApprovalRuleTemplateOutputDeletes a specified approval rule template. Deleting a template does not remove approval rules on pull requests already created with the template.
#delete_branch(options = {}) ⇒ Types::DeleteBranchOutputDeletes a branch from a repository, unless that branch is the default branch for the repository.
Deletes the content of a comment made on a change, file, or commit in a repository.
#delete_file(options = {}) ⇒ Types::DeleteFileOutputDeletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file still exists in the commits earlier to the commit that contains the deletion.
#delete_pull_request_approval_rule(options = {}) ⇒ Types::DeletePullRequestApprovalRuleOutputDeletes an approval rule from a specified pull request. Approval rules can be deleted from a pull request only if the pull request is open, and if the approval rule was created specifically for a pull request and not generated from an approval rule template associated with the repository where the pull request was created. You cannot delete an approval rule from a merged or closed pull request.
#delete_repository(options = {}) ⇒ Types::DeleteRepositoryOutputDeletes a repository. If a specified repository was already deleted, a null repository ID is returned.
Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository fail.
#describe_merge_conflicts(options = {}) ⇒ Types::DescribeMergeConflictsOutputReturns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy. If the merge option for the attempted merge is specified as FAST_FORWARD_MERGE, an exception is thrown.
#disassociate_approval_rule_template_from_repository(options = {}) ⇒ StructRemoves the association between a template and a repository so that approval rules based on the template are not automatically created when pull requests are created in the specified repository. This does not delete any approval rules previously created for pull requests through the template association.
#get_blob(options = {}) ⇒ Types::GetBlobOutputReturns the base-64 encoded content of an individual blob in a repository.
#get_branch(options = {}) ⇒ Types::GetBranchOutputReturns information about a repository branch, including its name and the last commit ID.
Returns the content of a comment made on a change, file, or commit in a repository.
Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.
Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.
Returns information about comments made on the comparison between two commits.
Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.
Returns comments made on a pull request.
Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.
#get_commit(options = {}) ⇒ Types::GetCommitOutputReturns information about a commit, including commit message and committer information.
#get_differences(options = {}) ⇒ Types::GetDifferencesOutputReturns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference). Results can be limited to a specified path.
#get_file(options = {}) ⇒ Types::GetFileOutputReturns the base-64 encoded contents of a specified file and its metadata.
#get_folder(options = {}) ⇒ Types::GetFolderOutputReturns the contents of a specified folder in a repository.
#get_merge_conflicts(options = {}) ⇒ Types::GetMergeConflictsOutputReturns information about merge conflicts between the before and after commit IDs for a pull request in a repository.
#get_merge_options(options = {}) ⇒ Types::GetMergeOptionsOutputReturns information about the merge options available for merging two specified branches. For details about why a merge option is not available, use GetMergeConflicts or DescribeMergeConflicts.
#get_pull_request_approval_states(options = {}) ⇒ Types::GetPullRequestApprovalStatesOutputGets information about the approval states for a specified pull request. Approval states only apply to pull requests that have one or more approval rules applied to them.
#get_pull_request_override_state(options = {}) ⇒ Types::GetPullRequestOverrideStateOutputReturns information about whether approval rules have been set aside (overridden) for a pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.
#get_repository(options = {}) ⇒ Types::GetRepositoryOutputReturns information about a 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.
#list_approval_rule_templates(options = {}) ⇒ Types::ListApprovalRuleTemplatesOutputLists all approval rule templates in the specified AWS Region in your AWS account. If an AWS Region is not specified, the AWS Region where you are signed in is used.
#list_pull_requests(options = {}) ⇒ Types::ListPullRequestsOutputReturns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.
#merge_pull_request_by_fast_forward(options = {}) ⇒ Types::MergePullRequestByFastForwardOutputAttempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge strategy. If the merge is successful, it closes the pull request.
#merge_pull_request_by_squash(options = {}) ⇒ Types::MergePullRequestBySquashOutputAttempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the squash merge strategy. If the merge is successful, it closes the pull request.
#merge_pull_request_by_three_way(options = {}) ⇒ Types::MergePullRequestByThreeWayOutputAttempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the three-way merge strategy. If the merge is successful, it closes the pull request.
#override_pull_request_approval_rules(options = {}) ⇒ StructSets aside (overrides) all approval rule requirements for a specified pull request.
Posts a comment on the comparison between two commits.
Posts a comment on a pull request.
Posts a comment in reply to an existing comment on a comparison between commits or a pull request.
Adds or updates a reaction to a specified comment for the user whose identity is used to make the request. You can only add or update a reaction for yourself. You cannot add, modify, or delete a reaction for another user.
#put_file(options = {}) ⇒ Types::PutFileOutputAdds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.
#tag_resource(options = {}) ⇒ StructAdds or updates tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.
#test_repository_triggers(options = {}) ⇒ Types::TestRepositoryTriggersOutputTests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test sends data from the last commit. If no data is available, sample data is generated.
#untag_resource(options = {}) ⇒ Struct #update_approval_rule_template_content(options = {}) ⇒ Types::UpdateApprovalRuleTemplateContentOutputUpdates the content of an approval rule template. You can change the number of required approvals, the membership of the approval rule, and whether an approval pool is defined.
Replaces the contents of a comment.
#update_default_branch(options = {}) ⇒ StructSets or changes the default branch name for the specified repository.
If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.
#update_pull_request_approval_rule_content(options = {}) ⇒ Types::UpdatePullRequestApprovalRuleContentOutputUpdates the structure of an approval rule created specifically for a pull request. For example, you can change the number of required approvers and the approval pool for approvers.
#update_pull_request_approval_state(options = {}) ⇒ StructUpdates the state of a user's approval on a pull request. The user is derived from the signed-in account when the request is made.
#update_repository_description(options = {}) ⇒ StructSets or changes the comment or description for a 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.
#update_repository_name(options = {}) ⇒ StructRenames a repository. The repository name must be unique across the calling AWS account. Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix .git is prohibited. For more information about the limits on repository names, see Limits in the AWS CodeCommit User Guide.
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ BooleanWaiters polls an API operation until a resource enters a desired state.
Basic UsageWaiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
ConfigurationYou can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
Callbacks
You can be notified before each polling attempt and before each delay. If you throw :success
or :failure
from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
Handling Errors
When a waiter is successful, it returns true
. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name Client Method Default Delay: Default Max Attempts:RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4