Class: Aws::CodeGuruReviewer::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

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

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

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

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

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

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :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:

  • :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.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :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 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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :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 ClientStubs#stub_responses. See ClientStubs for more information.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::CodeGuruReviewer::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CodeGuruReviewer::EndpointParameters`

  • :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_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_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. 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`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



434
435
436
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 434

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1617
1618
1619
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1617

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1620
1621
1622
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1620

def errors_module
  Errors
end

Instance Method Details

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

Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services 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 or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.

Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to connect to CodeGuru Reviewer. For more information, see [Associate a repository] in the *Amazon CodeGuru Reviewer User Guide.*

<note markdown=“1”> You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services 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.*

</note>

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html [2]: docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html [3]: docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html

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
    },
    s3_bucket: {
      name: "Name", # required
      bucket_name: "S3BucketName", # required
    },
  },
  client_request_token: "ClientRequestToken",
  tags: {
    "TagKey" => "TagValue",
  },
  kms_key_details: {
    kms_key_id: "KMSKeyId",
    encryption_option: "AWS_OWNED_CMK", # accepts AWS_OWNED_CMK, CUSTOMER_MANAGED_CMK
  },
})

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", "S3Bucket"
resp.repository_association.state #=> String, one of "Associated", "Associating", "Failed", "Disassociating", "Disassociated"
resp.repository_association.state_reason #=> String
resp.repository_association.last_updated_time_stamp #=> Time
resp.repository_association.created_time_stamp #=> Time
resp.repository_association.kms_key_details.kms_key_id #=> String
resp.repository_association.kms_key_details.encryption_option #=> String, one of "AWS_OWNED_CMK", "CUSTOMER_MANAGED_CMK"
resp.repository_association.s3_repository_details.bucket_name #=> String
resp.repository_association.s3_repository_details.code_artifacts.source_code_artifacts_object_key #=> String
resp.repository_association.s3_repository_details.code_artifacts.build_artifacts_object_key #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :repository (required, Types::Repository) —

    The repository to associate.

  • :client_request_token (String) —

    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.**

  • :tags (Hash<String,String>) —

    An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts:

    • A *tag key* (for example, ‘CostCenter`, `Environment`, `Project`, or `Secret`). Tag keys are case sensitive.

    • An optional field known as a *tag value* (for example, ‘111122223333`, `Production`, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.

  • :kms_key_details (Types::KMSKeyDetails) —

    A ‘KMSKeyDetails` object that contains:

    • The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (‘AWS_OWNED_CMK`) or customer managed (`CUSTOMER_MANAGED_CMK`).

    • The ID of the Amazon Web Services KMS key that is associated with this repository association.

Returns:

See Also:



566
567
568
569
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 566

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1475

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::CodeGuruReviewer')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-codegurureviewer'
  context[:gem_version] = '1.53.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_code_review(params = {}) ⇒ Types::CreateCodeReviewResponse

Use to create a code review with a [CodeReviewType] of ‘RepositoryAnalysis`. This type of code review analyzes all code under a specified branch in an associated repository. `PullRequest` code reviews are automatically triggered by a pull request.

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html

Examples:

Request syntax with placeholder values


resp = client.create_code_review({
  name: "CodeReviewName", # required
  repository_association_arn: "AssociationArn", # required
  type: { # required
    repository_analysis: { # required
      repository_head: {
        branch_name: "BranchName", # required
      },
      source_code_type: {
        commit_diff: {
          source_commit: "CommitId",
          destination_commit: "CommitId",
          merge_base_commit: "CommitId",
        },
        repository_head: {
          branch_name: "BranchName", # required
        },
        branch_diff: {
          source_branch_name: "BranchName", # required
          destination_branch_name: "BranchName", # required
        },
        s3_bucket_repository: {
          name: "Name", # required
          details: {
            bucket_name: "S3BucketName",
            code_artifacts: {
              source_code_artifacts_object_key: "SourceCodeArtifactsObjectKey", # required
              build_artifacts_object_key: "BuildArtifactsObjectKey",
            },
          },
        },
        request_metadata: {
          request_id: "RequestId",
          requester: "Requester",
          event_info: {
            name: "EventName",
            state: "EventState",
          },
          vendor_name: "GitHub", # accepts GitHub, GitLab, NativeS3
        },
      },
    },
    analysis_types: ["Security"], # accepts Security, CodeQuality
  },
  client_request_token: "ClientRequestToken",
})

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", "S3Bucket"
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", "RepositoryAnalysis"
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.source_code_type.commit_diff.merge_base_commit #=> String
resp.code_review.source_code_type.repository_head.branch_name #=> String
resp.code_review.source_code_type.branch_diff.source_branch_name #=> String
resp.code_review.source_code_type.branch_diff.destination_branch_name #=> String
resp.code_review.source_code_type.s3_bucket_repository.name #=> String
resp.code_review.source_code_type.s3_bucket_repository.details.bucket_name #=> String
resp.code_review.source_code_type.s3_bucket_repository.details.code_artifacts.source_code_artifacts_object_key #=> String
resp.code_review.source_code_type.s3_bucket_repository.details.code_artifacts.build_artifacts_object_key #=> String
resp.code_review.source_code_type.request_metadata.request_id #=> String
resp.code_review.source_code_type.request_metadata.requester #=> String
resp.code_review.source_code_type.request_metadata.event_info.name #=> String
resp.code_review.source_code_type.request_metadata.event_info.state #=> String
resp.code_review.source_code_type.request_metadata.vendor_name #=> String, one of "GitHub", "GitLab", "NativeS3"
resp.code_review.association_arn #=> String
resp.code_review.metrics.metered_lines_of_code_count #=> Integer
resp.code_review.metrics.suppressed_lines_of_code_count #=> Integer
resp.code_review.metrics.findings_count #=> Integer
resp.code_review.analysis_types #=> Array
resp.code_review.analysis_types[0] #=> String, one of "Security", "CodeQuality"
resp.code_review.config_file_state #=> String, one of "Present", "Absent", "PresentWithErrors"

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



706
707
708
709
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 706

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

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

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

The following waiters are defined for this operation (see #wait_until for detailed usage):

* code_review_completed

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", "S3Bucket"
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", "RepositoryAnalysis"
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.source_code_type.commit_diff.merge_base_commit #=> String
resp.code_review.source_code_type.repository_head.branch_name #=> String
resp.code_review.source_code_type.branch_diff.source_branch_name #=> String
resp.code_review.source_code_type.branch_diff.destination_branch_name #=> String
resp.code_review.source_code_type.s3_bucket_repository.name #=> String
resp.code_review.source_code_type.s3_bucket_repository.details.bucket_name #=> String
resp.code_review.source_code_type.s3_bucket_repository.details.code_artifacts.source_code_artifacts_object_key #=> String
resp.code_review.source_code_type.s3_bucket_repository.details.code_artifacts.build_artifacts_object_key #=> String
resp.code_review.source_code_type.request_metadata.request_id #=> String
resp.code_review.source_code_type.request_metadata.requester #=> String
resp.code_review.source_code_type.request_metadata.event_info.name #=> String
resp.code_review.source_code_type.request_metadata.event_info.state #=> String
resp.code_review.source_code_type.request_metadata.vendor_name #=> String, one of "GitHub", "GitLab", "NativeS3"
resp.code_review.association_arn #=> String
resp.code_review.metrics.metered_lines_of_code_count #=> Integer
resp.code_review.metrics.suppressed_lines_of_code_count #=> Integer
resp.code_review.metrics.findings_count #=> Integer
resp.code_review.analysis_types #=> Array
resp.code_review.analysis_types[0] #=> String, one of "Security", "CodeQuality"
resp.code_review.config_file_state #=> String, one of "Present", "Absent", "PresentWithErrors"

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



776
777
778
779
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 776

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):

Returns:

See Also:



834
835
836
837
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 834

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.

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html

The following waiters are defined for this operation (see #wait_until for detailed usage):

* repository_association_succeeded

Examples:

Request syntax with placeholder values


resp = client.describe_repository_association({
  association_arn: "AssociationArn", # 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", "S3Bucket"
resp.repository_association.state #=> String, one of "Associated", "Associating", "Failed", "Disassociating", "Disassociated"
resp.repository_association.state_reason #=> String
resp.repository_association.last_updated_time_stamp #=> Time
resp.repository_association.created_time_stamp #=> Time
resp.repository_association.kms_key_details.kms_key_id #=> String
resp.repository_association.kms_key_details.encryption_option #=> String, one of "AWS_OWNED_CMK", "CUSTOMER_MANAGED_CMK"
resp.repository_association.s3_repository_details.bucket_name #=> String
resp.repository_association.s3_repository_details.code_artifacts.source_code_artifacts_object_key #=> String
resp.repository_association.s3_repository_details.code_artifacts.build_artifacts_object_key #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



896
897
898
899
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 896

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: "AssociationArn", # 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", "S3Bucket"
resp.repository_association.state #=> String, one of "Associated", "Associating", "Failed", "Disassociating", "Disassociated"
resp.repository_association.state_reason #=> String
resp.repository_association.last_updated_time_stamp #=> Time
resp.repository_association.created_time_stamp #=> Time
resp.repository_association.kms_key_details.kms_key_id #=> String
resp.repository_association.kms_key_details.encryption_option #=> String, one of "AWS_OWNED_CMK", "CUSTOMER_MANAGED_CMK"
resp.repository_association.s3_repository_details.bucket_name #=> String
resp.repository_association.s3_repository_details.code_artifacts.source_code_artifacts_object_key #=> String
resp.repository_association.s3_repository_details.code_artifacts.build_artifacts_object_key #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



949
950
951
952
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 949

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, S3Bucket
  states: ["Completed"], # accepts Completed, Pending, Failed, Deleting
  repository_names: ["Name"],
  type: "PullRequest", # required, accepts PullRequest, RepositoryAnalysis
  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", "S3Bucket"
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", "RepositoryAnalysis"
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.suppressed_lines_of_code_count #=> Integer
resp.code_review_summaries[0].metrics_summary.findings_count #=> Integer
resp.code_review_summaries[0].source_code_type.commit_diff.source_commit #=> String
resp.code_review_summaries[0].source_code_type.commit_diff.destination_commit #=> String
resp.code_review_summaries[0].source_code_type.commit_diff.merge_base_commit #=> String
resp.code_review_summaries[0].source_code_type.repository_head.branch_name #=> String
resp.code_review_summaries[0].source_code_type.branch_diff.source_branch_name #=> String
resp.code_review_summaries[0].source_code_type.branch_diff.destination_branch_name #=> String
resp.code_review_summaries[0].source_code_type.s3_bucket_repository.name #=> String
resp.code_review_summaries[0].source_code_type.s3_bucket_repository.details.bucket_name #=> String
resp.code_review_summaries[0].source_code_type.s3_bucket_repository.details.code_artifacts.source_code_artifacts_object_key #=> String
resp.code_review_summaries[0].source_code_type.s3_bucket_repository.details.code_artifacts.build_artifacts_object_key #=> String
resp.code_review_summaries[0].source_code_type.request_metadata.request_id #=> String
resp.code_review_summaries[0].source_code_type.request_metadata.requester #=> String
resp.code_review_summaries[0].source_code_type.request_metadata.event_info.name #=> String
resp.code_review_summaries[0].source_code_type.request_metadata.event_info.state #=> String
resp.code_review_summaries[0].source_code_type.request_metadata.vendor_name #=> String, one of "GitHub", "GitLab", "NativeS3"
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=` 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=` 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:



1049
1050
1051
1052
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1049

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.

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html

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.

    [1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html

  • :user_ids (Array<String>) —

    An Amazon Web Services 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 Amazon Web Services account ID or an Amazon Resource Name (ARN). For more information, see [ Specifying a Principal] in the *Amazon Web Services Identity and Access Management User Guide*.

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying

  • :recommendation_ids (Array<String>) —

    Used to query the recommendation feedback for a given recommendation.

Returns:

See Also:



1126
1127
1128
1129
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1126

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.recommendation_summaries[0].recommendation_category #=> String, one of "AWSBestPractices", "AWSCloudFormationIssues", "DuplicateCode", "CodeMaintenanceIssues", "ConcurrencyIssues", "InputValidations", "PythonBestPractices", "JavaBestPractices", "ResourceLeaks", "SecurityIssues", "CodeInconsistencies"
resp.recommendation_summaries[0].rule_metadata.rule_id #=> String
resp.recommendation_summaries[0].rule_metadata.rule_name #=> String
resp.recommendation_summaries[0].rule_metadata.short_description #=> String
resp.recommendation_summaries[0].rule_metadata.long_description #=> String
resp.recommendation_summaries[0].rule_metadata.rule_tags #=> Array
resp.recommendation_summaries[0].rule_metadata.rule_tags[0] #=> String
resp.recommendation_summaries[0].severity #=> String, one of "Info", "Low", "Medium", "High", "Critical"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1184
1185
1186
1187
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1184

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].

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html [2]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType [3]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name [4]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State [5]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-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, S3Bucket
  states: ["Associated"], # accepts Associated, Associating, Failed, Disassociating, Disassociated
  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", "S3Bucket"
resp.repository_association_summaries[0].state #=> String, one of "Associated", "Associating", "Failed", "Disassociating", "Disassociated"
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.

        <note markdown=“1”> If your repository ‘ProviderType` is `GitHub`, `GitHub Enterprise Server`, 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.

        </note>

      • 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.

    • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see [Using tags to control access to associated repositories] in the *Amazon CodeGuru Reviewer User Guide*.

    [1]: docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html

  • :names (Array<String>) —

    List of repository names to use as a filter.

  • :owners (Array<String>) —

    List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, 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.

    <note markdown=“1”> 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.

    </note>

Returns:

See Also:



1313
1314
1315
1316
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1313

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns the list of tags associated with an associated repository resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AssociationArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1350
1351
1352
1353
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1350

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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.

    [1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html

  • :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:



1388
1389
1390
1391
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1388

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

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to an associated repository.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AssociationArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1432
1433
1434
1435
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1432

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag from an associated repository.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AssociationArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1466
1467
1468
1469
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1466

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

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

## Basic Usage

A waiter will call an API operation until:

  • It is successful

  • It enters a terminal state

  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

## Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

## Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.

| waiter_name | params | :delay | :max_attempts | | ——————————– | —————————————- | ——– | ————- | | code_review_completed | #describe_code_review | 10 | 180 | | repository_association_succeeded | #describe_repository_association | 10 | 30 |

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns ‘true` if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1582

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1590
1591
1592
 
# File 'lib/aws-sdk-codegurureviewer/client.rb', line 1590

def waiter_names
  waiters.keys
end