lib/aws-sdk-codecommit/client.rb in aws-sdk-codecommit-1.31.0 vs lib/aws-sdk-codecommit/client.rb in aws-sdk-codecommit-1.32.0

- old
+ new

@@ -30,15 +30,15 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:codecommit) module Aws::CodeCommit # An API client for CodeCommit. To construct a client, you need to configure a `:region` and `:credentials`. # - # client = Aws::CodeCommit::Client.new( - # region: region_name, - # credentials: credentials, - # # ... - # ) + # client = Aws::CodeCommit::Client.new( + # region: region_name, + # credentials: credentials, + # # ... + # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. @@ -103,11 +103,11 @@ # timeouts. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, - # a default `:region` is search for in the following locations: + # a default `:region` is searched for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` @@ -159,11 +159,11 @@ # to default service endpoint when available. # # @option options [String] :endpoint # The client endpoint is normally constructed from the `:region` # option. You should only configure an `:endpoint` when connecting - # to test endpoints. This should be avalid HTTP(S) URI. + # to test endpoints. This should be a valid HTTP(S) URI. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # @@ -227,20 +227,24 @@ # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: - # * `legacy` - The pre-existing retry behavior. This is default value if - # no retry mode is provided. - # * `standard` - A standardized set of retry rules across the AWS SDKs. - # This includes support for retry quotas, which limit the number of - # unsuccessful retries a client can make. - # * `adaptive` - An experimental retry mode that includes all the - # functionality of `standard` mode along with automatic client side - # throttling. This is a provisional mode that may change behavior - # in the future. # + # * `legacy` - The pre-existing retry behavior. This is default value if + # no retry mode is provided. + # + # * `standard` - A standardized set of retry rules across the AWS SDKs. + # This includes support for retry quotas, which limit the number of + # unsuccessful retries a client can make. + # + # * `adaptive` - An experimental retry mode that includes all the + # functionality of `standard` mode along with automatic client side + # throttling. This is a provisional mode that may change behavior + # in the future. + # + # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (false) @@ -273,12 +277,11 @@ # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can - # safely be set - # per-request on the session yielded by {#session_for}. + # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idle before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. @@ -286,11 +289,11 @@ # @option options [Float] :http_continue_timeout (1) The number of # seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has # "Expect" header set to "100-continue". Defaults to `nil` which # disables this behaviour. This value can safely be set per - # request on the session yielded by {#session_for}. + # request on the session. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, @@ -1563,10 +1566,12 @@ # * {Types::DescribeMergeConflictsOutput#next_token #next_token} => String # * {Types::DescribeMergeConflictsOutput#destination_commit_id #destination_commit_id} => String # * {Types::DescribeMergeConflictsOutput#source_commit_id #source_commit_id} => String # * {Types::DescribeMergeConflictsOutput#base_commit_id #base_commit_id} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_merge_conflicts({ # repository_name: "RepositoryName", # required # destination_commit_specifier: "CommitName", # required @@ -1652,10 +1657,12 @@ # @return [Types::DescribePullRequestEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribePullRequestEventsOutput#pull_request_events #pull_request_events} => Array<Types::PullRequestEvent> # * {Types::DescribePullRequestEventsOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_pull_request_events({ # pull_request_id: "PullRequestId", # required # pull_request_event_type: "PULL_REQUEST_CREATED", # accepts PULL_REQUEST_CREATED, PULL_REQUEST_STATUS_CHANGED, PULL_REQUEST_SOURCE_REFERENCE_UPDATED, PULL_REQUEST_MERGE_STATE_CHANGED, PULL_REQUEST_APPROVAL_RULE_CREATED, PULL_REQUEST_APPROVAL_RULE_UPDATED, PULL_REQUEST_APPROVAL_RULE_DELETED, PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN, PULL_REQUEST_APPROVAL_STATE_CHANGED @@ -1940,10 +1947,12 @@ # @return [Types::GetCommentsForComparedCommitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetCommentsForComparedCommitOutput#comments_for_compared_commit_data #comments_for_compared_commit_data} => Array<Types::CommentsForComparedCommit> # * {Types::GetCommentsForComparedCommitOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_comments_for_compared_commit({ # repository_name: "RepositoryName", # required # before_commit_id: "CommitId", @@ -2012,10 +2021,12 @@ # @return [Types::GetCommentsForPullRequestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetCommentsForPullRequestOutput#comments_for_pull_request_data #comments_for_pull_request_data} => Array<Types::CommentsForPullRequest> # * {Types::GetCommentsForPullRequestOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_comments_for_pull_request({ # pull_request_id: "PullRequestId", # required # repository_name: "RepositoryName", @@ -2142,10 +2153,12 @@ # @return [Types::GetDifferencesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDifferencesOutput#differences #differences} => Array<Types::Difference> # * {Types::GetDifferencesOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_differences({ # repository_name: "RepositoryName", # required # before_commit_specifier: "CommitName", @@ -2402,10 +2415,12 @@ # * {Types::GetMergeConflictsOutput#source_commit_id #source_commit_id} => String # * {Types::GetMergeConflictsOutput#base_commit_id #base_commit_id} => String # * {Types::GetMergeConflictsOutput#conflict_metadata_list #conflict_metadata_list} => Array<Types::ConflictMetadata> # * {Types::GetMergeConflictsOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_merge_conflicts({ # repository_name: "RepositoryName", # required # destination_commit_specifier: "CommitName", # required @@ -2748,10 +2763,12 @@ # @return [Types::ListApprovalRuleTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListApprovalRuleTemplatesOutput#approval_rule_template_names #approval_rule_template_names} => Array<String> # * {Types::ListApprovalRuleTemplatesOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_approval_rule_templates({ # next_token: "NextToken", # max_results: 1, @@ -2790,10 +2807,12 @@ # @return [Types::ListAssociatedApprovalRuleTemplatesForRepositoryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListAssociatedApprovalRuleTemplatesForRepositoryOutput#approval_rule_template_names #approval_rule_template_names} => Array<String> # * {Types::ListAssociatedApprovalRuleTemplatesForRepositoryOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_associated_approval_rule_templates_for_repository({ # repository_name: "RepositoryName", # required # next_token: "NextToken", @@ -2826,10 +2845,12 @@ # @return [Types::ListBranchesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListBranchesOutput#branches #branches} => Array<String> # * {Types::ListBranchesOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_branches({ # repository_name: "RepositoryName", # required # next_token: "NextToken", @@ -2876,10 +2897,12 @@ # @return [Types::ListPullRequestsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPullRequestsOutput#pull_request_ids #pull_request_ids} => Array<String> # * {Types::ListPullRequestsOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_pull_requests({ # repository_name: "RepositoryName", # required # author_arn: "Arn", @@ -2922,10 +2945,12 @@ # @return [Types::ListRepositoriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListRepositoriesOutput#repositories #repositories} => Array<Types::RepositoryNameIdPair> # * {Types::ListRepositoriesOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_repositories({ # next_token: "NextToken", # sort_by: "repositoryName", # accepts repositoryName, lastModifiedDate @@ -2966,10 +2991,12 @@ # @return [Types::ListRepositoriesForApprovalRuleTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListRepositoriesForApprovalRuleTemplateOutput#repository_names #repository_names} => Array<String> # * {Types::ListRepositoriesForApprovalRuleTemplateOutput#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.list_repositories_for_approval_rule_template({ # approval_rule_template_name: "ApprovalRuleTemplateName", # required # next_token: "NextToken", @@ -4723,10 +4750,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-codecommit' - context[:gem_version] = '1.31.0' + context[:gem_version] = '1.32.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated