Class: Aws::CodeGuruReviewer::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb

Overview

An API client for CodeGuruReviewer. To construct a client, you need to configure a :region and :credentials.

client = Aws::CodeGuruReviewer::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "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.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 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.

  • :http_continue_timeout (Float) — default: 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.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



309
310
311
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 309

def initialize(*args)
  super
end

Instance Method Details

#associate_repository(params = {}) ⇒ Types::AssociateRepositoryResponse

Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.

If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide.

You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.

Examples:

Request syntax with placeholder values


resp = client.associate_repository({
  repository: { # required
    code_commit: {
      name: "Name", # required
    },
    bitbucket: {
      name: "Name", # required
      connection_arn: "ConnectionArn", # required
      owner: "Owner", # required
    },
    git_hub_enterprise_server: {
      name: "Name", # required
      connection_arn: "ConnectionArn", # required
      owner: "Owner", # required
    },
  },
  client_request_token: "ClientRequestToken",
})

Response structure


resp.repository_association.association_id #=> String
resp.repository_association.association_arn #=> String
resp.repository_association.connection_arn #=> String
resp.repository_association.name #=> String
resp.repository_association.owner #=> String
resp.repository_association.provider_type #=> String, one of "CodeCommit", "GitHub", "Bitbucket", "GitHubEnterpriseServer"
resp.repository_association.state #=> String, one of "Associated", "Associating", "Failed", "Disassociating"
resp.repository_association.state_reason #=> String
resp.repository_association.last_updated_time_stamp #=> Time
resp.repository_association.created_time_stamp #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :repository (required, Types::Repository)

    The repository to associate.

  • :client_request_token (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.

    If you use the AWS CLI or one of the AWS SDKs to call this operation, you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, you must generate a ClientRequestToken yourself for new versions and include that value in the request.

    You typically interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.

    Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



418
419
420
421
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 418

def associate_repository(params = {}, options = {})
  req = build_request(:associate_repository, params)
  req.send_request(options)
end

#describe_code_review(params = {}) ⇒ Types::DescribeCodeReviewResponse

Returns the metadata associated with the code review along with its status.

Examples:

Request syntax with placeholder values


resp = client.describe_code_review({
  code_review_arn: "Arn", # required
})

Response structure


resp.code_review.name #=> String
resp.code_review.code_review_arn #=> String
resp.code_review.repository_name #=> String
resp.code_review.owner #=> String
resp.code_review.provider_type #=> String, one of "CodeCommit", "GitHub", "Bitbucket", "GitHubEnterpriseServer"
resp.code_review.state #=> String, one of "Completed", "Pending", "Failed", "Deleting"
resp.code_review.state_reason #=> String
resp.code_review.created_time_stamp #=> Time
resp.code_review.last_updated_time_stamp #=> Time
resp.code_review.type #=> String, one of "PullRequest"
resp.code_review.pull_request_id #=> String
resp.code_review.source_code_type.commit_diff.source_commit #=> String
resp.code_review.source_code_type.commit_diff.destination_commit #=> String
resp.code_review.metrics.metered_lines_of_code_count #=> Integer
resp.code_review.metrics.findings_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :code_review_arn (required, String)

    The Amazon Resource Name (ARN) of the CodeReview object.

Returns:

See Also:



465
466
467
468
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 465

def describe_code_review(params = {}, options = {})
  req = build_request(:describe_code_review, params)
  req.send_request(options)
end

#describe_recommendation_feedback(params = {}) ⇒ Types::DescribeRecommendationFeedbackResponse

Describes the customer feedback for a CodeGuru Reviewer recommendation.

Examples:

Request syntax with placeholder values


resp = client.describe_recommendation_feedback({
  code_review_arn: "Arn", # required
  recommendation_id: "RecommendationId", # required
  user_id: "UserId",
})

Response structure


resp.recommendation_feedback.code_review_arn #=> String
resp.recommendation_feedback.recommendation_id #=> String
resp.recommendation_feedback.reactions #=> Array
resp.recommendation_feedback.reactions[0] #=> String, one of "ThumbsUp", "ThumbsDown"
resp.recommendation_feedback.user_id #=> String
resp.recommendation_feedback.created_time_stamp #=> Time
resp.recommendation_feedback.last_updated_time_stamp #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :code_review_arn (required, String)

    The Amazon Resource Name (ARN) of the CodeReview object.

  • :recommendation_id (required, String)

    The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.

  • :user_id (String)

    Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.

    The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

Returns:

See Also:



523
524
525
526
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 523

def describe_recommendation_feedback(params = {}, options = {})
  req = build_request(:describe_recommendation_feedback, params)
  req.send_request(options)
end

#describe_repository_association(params = {}) ⇒ Types::DescribeRepositoryAssociationResponse

Returns a RepositoryAssociation object that contains information about the requested repository association.

Examples:

Request syntax with placeholder values


resp = client.describe_repository_association({
  association_arn: "Arn", # required
})

Response structure


resp.repository_association.association_id #=> String
resp.repository_association.association_arn #=> String
resp.repository_association.connection_arn #=> String
resp.repository_association.name #=> String
resp.repository_association.owner #=> String
resp.repository_association.provider_type #=> String, one of "CodeCommit", "GitHub", "Bitbucket", "GitHubEnterpriseServer"
resp.repository_association.state #=> String, one of "Associated", "Associating", "Failed", "Disassociating"
resp.repository_association.state_reason #=> String
resp.repository_association.last_updated_time_stamp #=> Time
resp.repository_association.created_time_stamp #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :association_arn (required, String)

    The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.

Returns:

See Also:



570
571
572
573
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 570

def describe_repository_association(params = {}, options = {})
  req = build_request(:describe_repository_association, params)
  req.send_request(options)
end

#disassociate_repository(params = {}) ⇒ Types::DisassociateRepositoryResponse

Removes the association between Amazon CodeGuru Reviewer and a repository.

Examples:

Request syntax with placeholder values


resp = client.disassociate_repository({
  association_arn: "Arn", # required
})

Response structure


resp.repository_association.association_id #=> String
resp.repository_association.association_arn #=> String
resp.repository_association.connection_arn #=> String
resp.repository_association.name #=> String
resp.repository_association.owner #=> String
resp.repository_association.provider_type #=> String, one of "CodeCommit", "GitHub", "Bitbucket", "GitHubEnterpriseServer"
resp.repository_association.state #=> String, one of "Associated", "Associating", "Failed", "Disassociating"
resp.repository_association.state_reason #=> String
resp.repository_association.last_updated_time_stamp #=> Time
resp.repository_association.created_time_stamp #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



613
614
615
616
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 613

def disassociate_repository(params = {}, options = {})
  req = build_request(:disassociate_repository, params)
  req.send_request(options)
end

#list_code_reviews(params = {}) ⇒ Types::ListCodeReviewsResponse

Lists all the code reviews that the customer has created in the past 90 days.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_code_reviews({
  provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket, GitHubEnterpriseServer
  states: ["Completed"], # accepts Completed, Pending, Failed, Deleting
  repository_names: ["Name"],
  type: "PullRequest", # required, accepts PullRequest
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.code_review_summaries #=> Array
resp.code_review_summaries[0].name #=> String
resp.code_review_summaries[0].code_review_arn #=> String
resp.code_review_summaries[0].repository_name #=> String
resp.code_review_summaries[0].owner #=> String
resp.code_review_summaries[0].provider_type #=> String, one of "CodeCommit", "GitHub", "Bitbucket", "GitHubEnterpriseServer"
resp.code_review_summaries[0].state #=> String, one of "Completed", "Pending", "Failed", "Deleting"
resp.code_review_summaries[0].created_time_stamp #=> Time
resp.code_review_summaries[0].last_updated_time_stamp #=> Time
resp.code_review_summaries[0].type #=> String, one of "PullRequest"
resp.code_review_summaries[0].pull_request_id #=> String
resp.code_review_summaries[0].metrics_summary.metered_lines_of_code_count #=> Integer
resp.code_review_summaries[0].metrics_summary.findings_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :provider_types (Array<String>)

    List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

  • :states (Array<String>)

    List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.

    The valid code review states are:

    • Completed: The code review is complete.

    • Pending: The code review started and has not completed or failed.

    • Failed: The code review failed.

    • Deleting: The code review is being deleted.

  • :repository_names (Array<String>)

    List of repository names for filtering that needs to be applied before displaying the result.

  • :type (required, String)

    The type of code reviews to list in the response.

  • :max_results (Integer)

    The maximum number of results that are returned per call. The default is 100.

  • :next_token (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

See Also:



697
698
699
700
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 697

def list_code_reviews(params = {}, options = {})
  req = build_request(:list_code_reviews, params)
  req.send_request(options)
end

#list_recommendation_feedback(params = {}) ⇒ Types::ListRecommendationFeedbackResponse

Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recommendation_feedback({
  next_token: "NextToken",
  max_results: 1,
  code_review_arn: "Arn", # required
  user_ids: ["UserId"],
  recommendation_ids: ["RecommendationId"],
})

Response structure


resp.recommendation_feedback_summaries #=> Array
resp.recommendation_feedback_summaries[0].recommendation_id #=> String
resp.recommendation_feedback_summaries[0].reactions #=> Array
resp.recommendation_feedback_summaries[0].reactions[0] #=> String, one of "ThumbsUp", "ThumbsDown"
resp.recommendation_feedback_summaries[0].user_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

  • :max_results (Integer)

    The maximum number of results that are returned per call. The default is 100.

  • :code_review_arn (required, String)

    The Amazon Resource Name (ARN) of the CodeReview object.

  • :user_ids (Array<String>)

    An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.

    The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

  • :recommendation_ids (Array<String>)

    Used to query the recommendation feedback for a given recommendation.

Returns:

See Also:



773
774
775
776
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 773

def list_recommendation_feedback(params = {}, options = {})
  req = build_request(:list_recommendation_feedback, params)
  req.send_request(options)
end

#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResponse

Returns the list of all recommendations for a completed code review.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recommendations({
  next_token: "NextToken",
  max_results: 1,
  code_review_arn: "Arn", # required
})

Response structure


resp.recommendation_summaries #=> Array
resp.recommendation_summaries[0].file_path #=> String
resp.recommendation_summaries[0].recommendation_id #=> String
resp.recommendation_summaries[0].start_line #=> Integer
resp.recommendation_summaries[0].end_line #=> Integer
resp.recommendation_summaries[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    Pagination token.

  • :max_results (Integer)

    The maximum number of results that are returned per call. The default is 100.

  • :code_review_arn (required, String)

    The Amazon Resource Name (ARN) of the CodeReview object.

Returns:

See Also:



823
824
825
826
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 823

def list_recommendations(params = {}, options = {})
  req = build_request(:list_recommendations, params)
  req.send_request(options)
end

#list_repository_associations(params = {}) ⇒ Types::ListRepositoryAssociationsResponse

Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType , Name , State , and Owner .

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_repository_associations({
  provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket, GitHubEnterpriseServer
  states: ["Associated"], # accepts Associated, Associating, Failed, Disassociating
  names: ["Name"],
  owners: ["Owner"],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.repository_association_summaries #=> Array
resp.repository_association_summaries[0].association_arn #=> String
resp.repository_association_summaries[0].connection_arn #=> String
resp.repository_association_summaries[0].last_updated_time_stamp #=> Time
resp.repository_association_summaries[0].association_id #=> String
resp.repository_association_summaries[0].name #=> String
resp.repository_association_summaries[0].owner #=> String
resp.repository_association_summaries[0].provider_type #=> String, one of "CodeCommit", "GitHub", "Bitbucket", "GitHubEnterpriseServer"
resp.repository_association_summaries[0].state #=> String, one of "Associated", "Associating", "Failed", "Disassociating"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :provider_types (Array<String>)

    List of provider types to use as a filter.

  • :states (Array<String>)

    List of repository association states to use as a filter.

    The valid repository association states are:

    • Associated: The repository association is complete.

    • Associating: CodeGuru Reviewer is:

      • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

        If your repository ProviderType is GitHub or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

      • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

    • Failed: The repository failed to associate or disassociate.

    • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

  • :names (Array<String>)

    List of repository names to use as a filter.

  • :owners (Array<String>)

    List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket, this is name of the account that was used to associate the repository.

  • :max_results (Integer)

    The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

  • :next_token (String)

    The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

See Also:



938
939
940
941
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 938

def list_repository_associations(params = {}, options = {})
  req = build_request(:list_repository_associations, params)
  req.send_request(options)
end

#put_recommendation_feedback(params = {}) ⇒ Struct

Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.

Examples:

Request syntax with placeholder values


resp = client.put_recommendation_feedback({
  code_review_arn: "Arn", # required
  recommendation_id: "RecommendationId", # required
  reactions: ["ThumbsUp"], # required, accepts ThumbsUp, ThumbsDown
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :code_review_arn (required, String)

    The Amazon Resource Name (ARN) of the CodeReview object.

  • :recommendation_id (required, String)

    The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.

  • :reactions (required, Array<String>)

    List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



976
977
978
979
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/client.rb', line 976

def put_recommendation_feedback(params = {}, options = {})
  req = build_request(:put_recommendation_feedback, params)
  req.send_request(options)
end