AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.CodeGuruReviewer

Inherits:
AWS.Service show all
Identifier:
codegurureviewer
API Version:
2019-09-19
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This section provides documentation for the Amazon CodeGuru Reviewer API operations.

Sending a Request Using CodeGuruReviewer

var codegurureviewer = new AWS.CodeGuruReviewer();
codegurureviewer.associateRepository(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeGuruReviewer object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codegurureviewer = new AWS.CodeGuruReviewer({apiVersion: '2019-09-19'});

You can also set the API version globally in AWS.config.apiVersions using the codegurureviewer service identifier:

AWS.config.apiVersions = {
  codegurureviewer: '2019-09-19',
  // other service API versions
};

var codegurureviewer = new AWS.CodeGuruReviewer();

Version:

  • 2019-09-19

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeGuruReviewer(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CodeGuruReviewer object

var codegurureviewer = new AWS.CodeGuruReviewer({apiVersion: '2019-09-19'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CodeGuruReviewer.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.CodeGuruReviewer.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CodeGuruReviewer.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateRepository(params = {}, callback) ⇒ AWS.Request

Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request. You can view recommendations in the AWS CodeCommit repository.

You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.

Service Reference:

Examples:

Calling the associateRepository operation

var params = {
  Repository: { /* required */
    CodeCommit: {
      Name: 'STRING_VALUE' /* required */
    }
  },
  ClientRequestToken: 'STRING_VALUE'
};
codegurureviewer.associateRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Repository — (map)

      The repository to associate.

      • CodeCommit — (map)

        Information about an AWS CodeCommit repository.

        • Namerequired — (String)

          The name of the AWS CodeCommit repository.

    • ClientRequestToken — (String)

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

      If you want 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 SDK to call this operation, then 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, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

      You typically only need to 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.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryAssociation — (map)

        Information about the repository association.

        • AssociationId — (String)

          The id of the repository association.

        • AssociationArn — (String)

          The Amazon Resource Name (ARN) identifying the repository association.

        • Name — (String)

          The name of the repository.

        • Owner — (String)

          The owner of the repository.

        • ProviderType — (String)

          The provider type of the repository association.

          Possible values include:
          • "CodeCommit"
          • "GitHub"
        • State — (String)

          The state of the repository association.

          Possible values include:
          • "Associated"
          • "Associating"
          • "Failed"
          • "Disassociating"
        • StateReason — (String)

          A description of why the repository association is in the current state.

        • LastUpdatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, when the repository association was last updated.

        • CreatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, when the repository association was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRepositoryAssociation(params = {}, callback) ⇒ AWS.Request

Describes a repository association.

Service Reference:

Examples:

Calling the describeRepositoryAssociation operation

var params = {
  AssociationArn: 'STRING_VALUE' /* required */
};
codegurureviewer.describeRepositoryAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssociationArn — (String)

      The Amazon Resource Name (ARN) identifying the association.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryAssociation — (map)

        Information about the repository association.

        • AssociationId — (String)

          The id of the repository association.

        • AssociationArn — (String)

          The Amazon Resource Name (ARN) identifying the repository association.

        • Name — (String)

          The name of the repository.

        • Owner — (String)

          The owner of the repository.

        • ProviderType — (String)

          The provider type of the repository association.

          Possible values include:
          • "CodeCommit"
          • "GitHub"
        • State — (String)

          The state of the repository association.

          Possible values include:
          • "Associated"
          • "Associating"
          • "Failed"
          • "Disassociating"
        • StateReason — (String)

          A description of why the repository association is in the current state.

        • LastUpdatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, when the repository association was last updated.

        • CreatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, when the repository association was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateRepository(params = {}, callback) ⇒ AWS.Request

Removes the association between Amazon CodeGuru Reviewer and a repository.

Service Reference:

Examples:

Calling the disassociateRepository operation

var params = {
  AssociationArn: 'STRING_VALUE' /* required */
};
codegurureviewer.disassociateRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssociationArn — (String)

      The Amazon Resource Name (ARN) identifying the association.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryAssociation — (map)

        Information about the disassociated repository.

        • AssociationId — (String)

          The id of the repository association.

        • AssociationArn — (String)

          The Amazon Resource Name (ARN) identifying the repository association.

        • Name — (String)

          The name of the repository.

        • Owner — (String)

          The owner of the repository.

        • ProviderType — (String)

          The provider type of the repository association.

          Possible values include:
          • "CodeCommit"
          • "GitHub"
        • State — (String)

          The state of the repository association.

          Possible values include:
          • "Associated"
          • "Associating"
          • "Failed"
          • "Disassociating"
        • StateReason — (String)

          A description of why the repository association is in the current state.

        • LastUpdatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, when the repository association was last updated.

        • CreatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, when the repository association was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRepositoryAssociations(params = {}, callback) ⇒ AWS.Request

Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.

Service Reference:

Examples:

Calling the listRepositoryAssociations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE',
  Owners: [
    'STRING_VALUE',
    /* more items */
  ],
  ProviderTypes: [
    CodeCommit | GitHub,
    /* more items */
  ],
  States: [
    Associated | Associating | Failed | Disassociating,
    /* more items */
  ]
};
codegurureviewer.listRepositoryAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProviderTypes — (Array<String>)

      List of provider types to use as a filter.

    • States — (Array<String>)

      List of states to use as a filter.

    • Names — (Array<String>)

      List of names to use as a filter.

    • Owners — (Array<String>)

      List of owners to use as a filter. For AWS CodeCommit, the owner is the AWS account id. For GitHub, it is the GitHub account name.

    • MaxResults — (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 along 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, then ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

    • NextToken — (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: This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryAssociationSummaries — (Array<map>)

        A list of repository associations that meet the criteria of the request.

        • AssociationArn — (String)

          The Amazon Resource Name (ARN) identifying the repository association.

        • LastUpdatedTimeStamp — (Date)

          The time, in milliseconds since the epoch, since the repository association was last updated.

        • AssociationId — (String)

          The repository association ID.

        • Name — (String)

          The name of the repository association.

        • Owner — (String)

          The owner of the repository association.

        • ProviderType — (String)

          The provider type of the repository association.

          Possible values include:
          • "CodeCommit"
          • "GitHub"
        • State — (String)

          The state of the repository association.

          Associated

          Amazon CodeGuru Reviewer is associated with the repository.

          Associating

          The association is in progress.

          Failed

          The association failed. For more information about troubleshooting (or why it failed), see [troubleshooting topic].

          Disassociating

          Amazon CodeGuru Reviewer is in the process of disassociating with the repository.

          Possible values include:
          • "Associated"
          • "Associating"
          • "Failed"
          • "Disassociating"
      • NextToken — (String)

        The nextToken value to include in a future ListRecommendations request. When the results of a ListRecommendations request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.