get_merge_options
async
¶
get_merge_options(
repository_name: RepositoryName,
source_commit_specifier: CommitName,
destination_commit_specifier: CommitName,
*,
config_overrides: Optional[AsyncCodeCommitClientConfig] = None,
conflict_detail_level: Optional[ConflictDetailLevelTypeEnum] = None,
conflict_resolution_strategy: Optional[ConflictResolutionStrategyTypeEnum] = None,
) -> GetMergeOptionsOutput
Returns 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.
Parameters:
-
repository_name(RepositoryName) –The name of the repository that contains the commits about which you want to get merge options.
-
source_commit_specifier(CommitName) –The 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(CommitName) –The 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(Optional[ConflictDetailLevelTypeEnum], default:None) –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.
-
conflict_resolution_strategy(Optional[ConflictResolutionStrategyTypeEnum], default:None) –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.
Raises:
-
CommitDoesNotExistException–The specified commit does not exist or no commit was specified, and the specified repository has no default branch.
-
CommitRequiredException–A commit was not specified.
-
EncryptionIntegrityChecksFailedException–An encryption integrity check failed.
-
EncryptionKeyAccessDeniedException–An encryption key could not be accessed.
-
EncryptionKeyDisabledException–The encryption key is disabled.
-
EncryptionKeyNotFoundException–No encryption key was found.
-
EncryptionKeyUnavailableException–The encryption key is not available.
-
InvalidCommitException–The specified commit is not valid.
-
InvalidConflictDetailLevelException–The specified conflict detail level is not valid.
-
InvalidConflictResolutionStrategyException–The specified conflict resolution strategy is not valid.
-
InvalidRepositoryNameException–A specified repository name is not valid.
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.
-
MaximumFileContentToLoadExceededException–The number of files to load exceeds the allowed limit.
-
MaximumItemsToCompareExceededException–The number of items to compare between the source or destination branches and the merge base has exceeded the maximum allowed.
-
RepositoryDoesNotExistException–The specified repository does not exist.
-
RepositoryNameRequiredException–A repository name is required, but was not specified.
-
TipsDivergenceExceededException–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
git diffor a diff tool. -
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_codecommit/_services/async_code_commit.py
3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 | |