1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
#![allow(deprecated)]
#![allow(unknown_lints)]
#![allow(clippy::module_inception)]
#![allow(clippy::upper_case_acronyms)]
#![allow(clippy::large_enum_variant)]
#![allow(clippy::wrong_self_convention)]
#![allow(clippy::should_implement_trait)]
#![allow(clippy::disallowed_names)]
#![allow(clippy::vec_init_then_push)]
#![allow(clippy::type_complexity)]
#![allow(clippy::needless_return)]
#![allow(clippy::derive_partial_eq_without_eq)]
#![allow(clippy::result_large_err)]
#![allow(clippy::unnecessary_map_on_constructor)]
#![allow(rustdoc::bare_urls)]
#![allow(rustdoc::redundant_explicit_links)]
#![forbid(unsafe_code)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
//! This is the _CodeCommit API Reference_. This reference provides descriptions of the operations and data types for CodeCommit API along with usage examples.
//!
//! You can use the CodeCommit API to work with the following objects:
//!
//! Repositories, by calling the following:
//! - BatchGetRepositories, which returns information about one or more repositories associated with your Amazon Web Services account.
//! - CreateRepository, which creates an CodeCommit repository.
//! - DeleteRepository, which deletes an CodeCommit repository.
//! - GetRepository, which returns information about a specified repository.
//! - ListRepositories, which lists all CodeCommit repositories associated with your Amazon Web Services account.
//! - UpdateRepositoryDescription, which sets or updates the description of the repository.
//! - UpdateRepositoryEncryptionKey, which updates the Key Management Service encryption key used to encrypt and decrypt a repository.
//! - UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository can access it until you send them the new HTTPS or SSH URL to use.
//!
//! Branches, by calling the following:
//! - CreateBranch, which creates a branch in a specified repository.
//! - DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.
//! - GetBranch, which returns information about a specified branch.
//! - ListBranches, which lists all branches for a specified repository.
//! - UpdateDefaultBranch, which changes the default branch for a repository.
//!
//! Files, by calling the following:
//! - DeleteFile, which deletes the content of a specified file from a specified branch.
//! - GetBlob, which returns the base-64 encoded content of an individual Git blob object in a repository.
//! - GetFile, which returns the base-64 encoded content of a specified file.
//! - GetFolder, which returns the contents of a specified folder or directory.
//! - ListFileCommitHistory, which retrieves a list of commits and changes to a specified file.
//! - PutFile, which adds or modifies a single file in a specified repository and branch.
//!
//! Commits, by calling the following:
//! - BatchGetCommits, which returns information about one or more commits in a repository.
//! - CreateCommit, which creates a commit for changes to a repository.
//! - GetCommit, which returns information about a commit, including commit messages and author and committer information.
//! - GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference).
//!
//! Merges, by calling the following:
//! - BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.
//! - CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.
//! - DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.
//! - GetMergeCommit, which returns information about the merge between a source and destination commit.
//! - GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.
//! - GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.
//! - MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.
//! - MergeBranchesBySquash, which merges two branches using the squash merge option.
//! - MergeBranchesByThreeWay, which merges two branches using the three-way merge option.
//!
//! Pull requests, by calling the following:
//! - CreatePullRequest, which creates a pull request in a specified repository.
//! - CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.
//! - DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.
//! - DescribePullRequestEvents, which returns information about one or more pull request events.
//! - EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.
//! - GetCommentsForPullRequest, which returns information about comments on a specified pull request.
//! - GetPullRequest, which returns information about a specified pull request.
//! - GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.
//! - GetPullRequestOverrideState, which returns information about whether approval rules have been set aside (overriden) 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.
//! - ListPullRequests, which lists all pull requests for a repository.
//! - MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge option.
//! - MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the squash merge option.
//! - MergePullRequestByThreeWay, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the three-way merge option.
//! - OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.
//! - PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.
//! - UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.
//! - UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.
//! - UpdatePullRequestDescription, which updates the description of a pull request.
//! - UpdatePullRequestStatus, which updates the status of a pull request.
//! - UpdatePullRequestTitle, which updates the title of a pull request.
//!
//! Approval rule templates, by calling the following:
//! - AssociateApprovalRuleTemplateWithRepository, which associates a template with a specified repository. After the template is associated with a repository, CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repository.
//! - BatchAssociateApprovalRuleTemplateWithRepositories, which associates a template with one or more specified repositories. After the template is associated with a repository, CodeCommit creates approval rules that match the template conditions on every pull request created in the specified repositories.
//! - BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the association between a template and specified repositories so that approval rules based on the template are not automatically created when pull requests are created in those repositories.
//! - CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account.
//! - DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.
//! - DisassociateApprovalRuleTemplateFromRepository, which removes 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.
//! - GetApprovalRuleTemplate, which returns information about an approval rule template.
//! - ListApprovalRuleTemplates, which lists all approval rule templates in the Amazon Web Services Region in your Amazon Web Services account.
//! - ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.
//! - ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.
//! - UpdateApprovalRuleTemplateDescription, which updates the description of an approval rule template.
//! - UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.
//! - UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.
//!
//! Comments in a repository, by calling the following:
//! - DeleteCommentContent, which deletes the content of a comment on a commit in a repository.
//! - GetComment, which returns information about a comment on a commit.
//! - GetCommentReactions, which returns information about emoji reactions to comments.
//! - GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers in a repository.
//! - PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.
//! - PostCommentReply, which creates a reply to a comment.
//! - PutCommentReaction, which creates or updates an emoji reaction to a comment.
//! - UpdateComment, which updates the content of a comment on a commit in a repository.
//!
//! Tags used to tag resources in CodeCommit (not Git tags), by calling the following:
//! - ListTagsForResource, which gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.
//! - TagResource, which adds or updates tags for a resource in CodeCommit.
//! - UntagResource, which removes tags for a resource in CodeCommit.
//!
//! Triggers, by calling the following:
//! - GetRepositoryTriggers, which returns information about triggers configured for a repository.
//! - PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers.
//! - TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target.
//!
//! For information about how to use CodeCommit, see the [CodeCommit User Guide](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html).
//!
//! ## Getting Started
//!
//! > Examples are available for many services and operations, check out the
//! > [examples folder in GitHub](https://github.com/awslabs/aws-sdk-rust/tree/main/examples).
//!
//! The SDK provides one crate per AWS service. You must add [Tokio](https://crates.io/crates/tokio)
//! as a dependency within your Rust project to execute asynchronous code. To add `aws-sdk-codecommit` to
//! your project, add the following to your **Cargo.toml** file:
//!
//! ```toml
//! [dependencies]
//! aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
//! aws-sdk-codecommit = "1.21.0"
//! tokio = { version = "1", features = ["full"] }
//! ```
//!
//! Then in code, a client can be created with the following:
//!
//! ```rust,no_run
//! use aws_sdk_codecommit as codecommit;
//!
//! #[::tokio::main]
//! async fn main() -> Result<(), codecommit::Error> {
//! let config = aws_config::load_from_env().await;
//! let client = aws_sdk_codecommit::Client::new(&config);
//!
//! // ... make some calls with the client
//!
//! Ok(())
//! }
//! ```
//!
//! See the [client documentation](https://docs.rs/aws-sdk-codecommit/latest/aws_sdk_codecommit/client/struct.Client.html)
//! for information on what calls can be made, and the inputs and outputs for each of those calls.
//!
//! ## Using the SDK
//!
//! Until the SDK is released, we will be adding information about using the SDK to the
//! [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html). Feel free to suggest
//! additional sections for the guide by opening an issue and describing what you are trying to do.
//!
//! ## Getting Help
//!
//! * [GitHub discussions](https://github.com/awslabs/aws-sdk-rust/discussions) - For ideas, RFCs & general questions
//! * [GitHub issues](https://github.com/awslabs/aws-sdk-rust/issues/new/choose) - For bug reports & feature requests
//! * [Generated Docs (latest version)](https://awslabs.github.io/aws-sdk-rust/)
//! * [Usage examples](https://github.com/awslabs/aws-sdk-rust/tree/main/examples)
//!
//!
//! # Crate Organization
//!
//! The entry point for most customers will be [`Client`], which exposes one method for each API
//! offered by AWS CodeCommit. The return value of each of these methods is a "fluent builder",
//! where the different inputs for that API are added by builder-style function call chaining,
//! followed by calling `send()` to get a [`Future`](std::future::Future) that will result in
//! either a successful output or a [`SdkError`](crate::error::SdkError).
//!
//! Some of these API inputs may be structs or enums to provide more complex structured information.
//! These structs and enums live in [`types`](crate::types). There are some simpler types for
//! representing data such as date times or binary blobs that live in [`primitives`](crate::primitives).
//!
//! All types required to configure a client via the [`Config`](crate::Config) struct live
//! in [`config`](crate::config).
//!
//! The [`operation`](crate::operation) module has a submodule for every API, and in each submodule
//! is the input, output, and error type for that API, as well as builders to construct each of those.
//!
//! There is a top-level [`Error`](crate::Error) type that encompasses all the errors that the
//! client can return. Any other error type can be converted to this `Error` type via the
//! [`From`](std::convert::From) trait.
//!
//! The other modules within this crate are not required for normal usage.
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use error_meta::Error;
#[doc(inline)]
pub use config::Config;
/// Client for calling AWS CodeCommit.
/// ## 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:
/// ```rust,no_run
/// # async fn wrapper() {
/// 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:
///
/// ```rust,no_run
/// # async fn wrapper() {
/// 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.
///
/// [`Config`]: crate::Config
/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
/// [`aws-config` docs]: https://docs.rs/aws-config/*
/// [`aws-config`]: https://crates.io/crates/aws-config
/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
/// # Using the `Client`
///
/// A client has a function for every operation that can be performed by the service.
/// For example, the [`AssociateApprovalRuleTemplateWithRepository`](crate::operation::associate_approval_rule_template_with_repository) 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:
///
/// ```rust,ignore
/// 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`](crate::client::customize) module for more
/// information.
pub mod client;
/// Configuration for AWS CodeCommit.
pub mod config;
/// Common errors and error handling utilities.
pub mod error;
mod error_meta;
/// Information about this crate.
pub mod meta;
/// All operations that this crate can perform.
pub mod operation;
/// Primitives such as `Blob` or `DateTime` used by other types.
pub mod primitives;
/// Data structures used by operation inputs/outputs.
pub mod types;
mod auth_plugin;
pub(crate) mod client_idempotency_token;
mod idempotency_token;
pub(crate) mod protocol_serde;
mod serialization_settings;
mod endpoint_lib;
mod lens;
mod serde_util;
mod json_errors;
#[doc(inline)]
pub use client::Client;