merge_pull_request_by_squash async ¶

async def merge_pull_request_by_squash(
    self,
    pull_request_id: "capo_codecommit.types.pull_request_id.PullRequestId",
    repository_name: "capo_codecommit.types.repository_name.RepositoryName",
    *,
    config_overrides: Optional[AsyncCodeCommitClientConfig] = None,
    source_commit_id: Optional["capo_codecommit.types.object_id.ObjectId"] = None,
    conflict_detail_level: Optional[
        "capo_codecommit.types.conflict_detail_level_type_enum.ConflictDetailLevelTypeEnum"
    ] = None,
    conflict_resolution_strategy: Optional[
        "capo_codecommit.types.conflict_resolution_strategy_type_enum.ConflictResolutionStrategyTypeEnum"
    ] = None,
    commit_message: Optional["capo_codecommit.types.message.Message"] = None,
    author_name: Optional["capo_codecommit.types.name.Name"] = None,
    email: Optional["capo_codecommit.types.email.Email"] = None,
    keep_empty_folders: Optional[
        "capo_codecommit.types.keep_empty_folders.KeepEmptyFolders"
    ] = None,
    conflict_resolution: Optional[
        "capo_codecommit.types.conflict_resolution.ConflictResolution"
    ] = None,
) -> "capo_codecommit.types.merge_pull_request_by_squash_output.MergePullRequestBySquashOutput":
    """<p>Attempts 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.</p>

    Args:
        pull_request_id: <p>The system-generated ID of the pull request. To get this ID, use <a>ListPullRequests</a>.</p>
        repository_name: <p>The name of the repository where the pull request was created.</p>
        source_commit_id: <p>The 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.</p>
        conflict_detail_level: <p>The 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.</p>
        conflict_resolution_strategy: <p>Specifies 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.</p>
        commit_message: <p>The commit message to include in the commit information for the merge.</p>
        author_name: <p>The name of the author who created the commit. This information is used as both the author and committer for the commit.</p>
        email: <p>The email address of the person merging the branches. This information is used in the commit information for the merge.</p>
        keep_empty_folders: <p>If 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.</p>
        conflict_resolution: <p>If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.</p>

    Raises:
        capo_codecommit.errors.commit_message_length_exceeded_exception.CommitMessageLengthExceededException: <p>The commit message is too long. Provide a shorter string. </p>
        capo_codecommit.errors.concurrent_reference_update_exception.ConcurrentReferenceUpdateException: <p>The merge cannot be completed because the target branch has been modified. Another user might have modified the target branch while the merge was in progress. Wait a few minutes, and then try again.</p>
        capo_codecommit.errors.encryption_integrity_checks_failed_exception.EncryptionIntegrityChecksFailedException: <p>An encryption integrity check failed.</p>
        capo_codecommit.errors.encryption_key_access_denied_exception.EncryptionKeyAccessDeniedException: <p>An encryption key could not be accessed.</p>
        capo_codecommit.errors.encryption_key_disabled_exception.EncryptionKeyDisabledException: <p>The encryption key is disabled.</p>
        capo_codecommit.errors.encryption_key_not_found_exception.EncryptionKeyNotFoundException: <p>No encryption key was found.</p>
        capo_codecommit.errors.encryption_key_unavailable_exception.EncryptionKeyUnavailableException: <p>The encryption key is not available.</p>
        capo_codecommit.errors.file_content_size_limit_exceeded_exception.FileContentSizeLimitExceededException: <p>The file cannot be added because it is too large. The maximum file size is 6 MB, and the combined file content change size is 7 MB. Consider making these changes using a Git client.</p>
        capo_codecommit.errors.folder_content_size_limit_exceeded_exception.FolderContentSizeLimitExceededException: <p>The commit cannot be created because at least one of the overall changes in the commit results in a folder whose contents exceed the limit of 6 MB. Either reduce the number and size of your changes, or split the changes across multiple folders.</p>
        capo_codecommit.errors.invalid_commit_id_exception.InvalidCommitIdException: <p>The specified commit ID is not valid.</p>
        capo_codecommit.errors.invalid_conflict_detail_level_exception.InvalidConflictDetailLevelException: <p>The specified conflict detail level is not valid.</p>
        capo_codecommit.errors.invalid_conflict_resolution_exception.InvalidConflictResolutionException: <p>The specified conflict resolution list is not valid.</p>
        capo_codecommit.errors.invalid_conflict_resolution_strategy_exception.InvalidConflictResolutionStrategyException: <p>The specified conflict resolution strategy is not valid.</p>
        capo_codecommit.errors.invalid_email_exception.InvalidEmailException: <p>The specified email address either contains one or more characters that are not allowed, or it exceeds the maximum number of characters allowed for an email address.</p>
        capo_codecommit.errors.invalid_file_mode_exception.InvalidFileModeException: <p>The specified file mode permission is not valid. For a list of valid file mode permissions, see <a>PutFile</a>. </p>
        capo_codecommit.errors.invalid_path_exception.InvalidPathException: <p>The specified path is not valid.</p>
        capo_codecommit.errors.invalid_pull_request_id_exception.InvalidPullRequestIdException: <p>The pull request ID is not valid. Make sure that you have provided the full ID and that the pull request is in the specified repository, and then try again.</p>
        capo_codecommit.errors.invalid_replacement_content_exception.InvalidReplacementContentException: <p>Automerge was specified for resolving the conflict, but the replacement type is not valid or content is missing. </p>
        capo_codecommit.errors.invalid_replacement_type_exception.InvalidReplacementTypeException: <p>Automerge was specified for resolving the conflict, but the specified replacement type is not valid.</p>
        capo_codecommit.errors.invalid_repository_name_exception.InvalidRepositoryNameException: <p>A specified repository name is not valid.</p> <note> <p>This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</p> </note>
        capo_codecommit.errors.manual_merge_required_exception.ManualMergeRequiredException: <p>The pull request cannot be merged automatically into the destination branch. You must manually merge the branches and resolve any conflicts.</p>
        capo_codecommit.errors.maximum_conflict_resolution_entries_exceeded_exception.MaximumConflictResolutionEntriesExceededException: <p>The number of allowed conflict resolution entries was exceeded.</p>
        capo_codecommit.errors.maximum_file_content_to_load_exceeded_exception.MaximumFileContentToLoadExceededException: <p>The number of files to load exceeds the allowed limit.</p>
        capo_codecommit.errors.maximum_items_to_compare_exceeded_exception.MaximumItemsToCompareExceededException: <p>The number of items to compare between the source or destination branches and the merge base has exceeded the maximum allowed.</p>
        capo_codecommit.errors.multiple_conflict_resolution_entries_exception.MultipleConflictResolutionEntriesException: <p>More than one conflict resolution entries exists for the conflict. A conflict can have only one conflict resolution entry.</p>
        capo_codecommit.errors.name_length_exceeded_exception.NameLengthExceededException: <p>The user name is not valid because it has exceeded the character limit for author names. </p>
        capo_codecommit.errors.path_required_exception.PathRequiredException: <p>The folderPath for a location cannot be null.</p>
        capo_codecommit.errors.pull_request_already_closed_exception.PullRequestAlreadyClosedException: <p>The pull request status cannot be updated because it is already closed.</p>
        capo_codecommit.errors.pull_request_approval_rules_not_satisfied_exception.PullRequestApprovalRulesNotSatisfiedException: <p>The pull request cannot be merged because one or more approval rules applied to the pull request have conditions that have not been met.</p>
        capo_codecommit.errors.pull_request_does_not_exist_exception.PullRequestDoesNotExistException: <p>The pull request ID could not be found. Make sure that you have specified the correct repository name and pull request ID, and then try again.</p>
        capo_codecommit.errors.pull_request_id_required_exception.PullRequestIdRequiredException: <p>A pull request ID is required, but none was provided.</p>
        capo_codecommit.errors.replacement_content_required_exception.ReplacementContentRequiredException: <p>USE_NEW_CONTENT was specified, but no replacement content has been provided.</p>
        capo_codecommit.errors.replacement_type_required_exception.ReplacementTypeRequiredException: <p>A replacement type is required.</p>
        capo_codecommit.errors.repository_does_not_exist_exception.RepositoryDoesNotExistException: <p>The specified repository does not exist.</p>
        capo_codecommit.errors.repository_name_required_exception.RepositoryNameRequiredException: <p>A repository name is required, but was not specified.</p>
        capo_codecommit.errors.repository_not_associated_with_pull_request_exception.RepositoryNotAssociatedWithPullRequestException: <p>The repository does not contain any pull requests with that pull request ID. Use GetPullRequest to verify the correct repository name for the pull request ID.</p>
        capo_codecommit.errors.tip_of_source_reference_is_different_exception.TipOfSourceReferenceIsDifferentException: <p>The tip of the source branch in the destination repository does not match the tip of the source branch specified in your request. The pull request might have been updated. Make sure that you have the latest changes.</p>
        capo_codecommit.errors.tips_divergence_exceeded_exception.TipsDivergenceExceededException: <p>The divergence between the tips of the provided commit specifiers is too great to determine whether there might be any merge conflicts. Locally compare the specifiers using <code>git diff</code> or a diff tool.</p>
        capo_codecommit.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codecommit.types.merge_pull_request_by_squash_input.MergePullRequestBySquashInput]",
    ) -> AsyncOperationResponse[
        "capo_codecommit.types.merge_pull_request_by_squash_output.MergePullRequestBySquashOutput"
    ]:
        import capo_codecommit._operations.code_commit_20150413.merge_pull_request_by_squash

        (
            output,
            http_response,
        ) = await capo_codecommit._operations.code_commit_20150413.merge_pull_request_by_squash.async_merge_pull_request_by_squash(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("MergePullRequestBySquash")
    )
    input_: capo_codecommit.types.merge_pull_request_by_squash_input.MergePullRequestBySquashInput = {
        "pull_request_id": pull_request_id,
        "repository_name": repository_name,
    }
    if source_commit_id is not None:
        input_["source_commit_id"] = source_commit_id
    if conflict_detail_level is not None:
        input_["conflict_detail_level"] = conflict_detail_level
    if conflict_resolution_strategy is not None:
        input_["conflict_resolution_strategy"] = conflict_resolution_strategy
    if commit_message is not None:
        input_["commit_message"] = commit_message
    if author_name is not None:
        input_["author_name"] = author_name
    if email is not None:
        input_["email"] = email
    if keep_empty_folders is not None:
        input_["keep_empty_folders"] = keep_empty_folders
    if conflict_resolution is not None:
        input_["conflict_resolution"] = conflict_resolution

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output