Own AWS? Customize your docs with AI search, analytics, and more.

POST

/codereviews

http://codeguru-reviewer.{region}.amazonaws.com/codereviews

Use to create a code review with a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html">CodeReviewType</a> of <code>RepositoryAnalysis</code>. This type of code review analyzes all code under a specified branch in an associated repository. <code>PullRequest</code> code reviews are automatically triggered by a pull request.

Access Token Required: API Key

Body Params

Namestringrequired

The name of the code review. The name of each code review in your Amazon Web Services account must be unique.

Typeobjectrequired

The type of a code review. There are two code review types: <ul> <li> <code>PullRequest</code> - A code review that is automatically triggered by a pull request on an associated repository. </li> <li> <code>RepositoryAnalysis</code> - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview">CreateCodeReview</a>. </li> </ul>

ClientRequestTokenstring

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

RepositoryAssociationArnstringrequired

The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object. You can retrieve this ARN by calling <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html">ListRepositoryAssociations</a>. A code review can only be created on an associated repository. This is the ARN of the associated repository.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeguru-reviewer.{region}.amazonaws.com/codereviews' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/codereviews

http://codeguru-reviewer.{region}.amazonaws.com/codereviews

Access Token Required: API Key

Body Params

Namestringrequired

The name of the code review. The name of each code review in your Amazon Web Services account must be unique.

Typeobjectrequired

ClientRequestTokenstring

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

RepositoryAssociationArnstringrequired

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeguru-reviewer.{region}.amazonaws.com/codereviews' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/codereviews

http://codeguru-reviewer.{region}.amazonaws.com/codereviews

Access Token Required: API Key

Body Params

Namestringrequired

The name of the code review. The name of each code review in your Amazon Web Services account must be unique.

Typeobjectrequired

ClientRequestTokenstring

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

RepositoryAssociationArnstringrequired

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeguru-reviewer.{region}.amazonaws.com/codereviews' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/codereviews

http://codeguru-reviewer.{region}.amazonaws.com/codereviews

Access Token Required: API Key

Body Params

Namestringrequired

The name of the code review. The name of each code review in your Amazon Web Services account must be unique.

Typeobjectrequired

ClientRequestTokenstring

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

RepositoryAssociationArnstringrequired

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeguru-reviewer.{region}.amazonaws.com/codereviews' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}