Amazon CodeGuru Reviewer 2019-09-19
- Client: Aws\CodeGuruReviewer\CodeGuruReviewerClient
- Service ID: codeguru-reviewer
- Version: 2019-09-19
This page describes the parameters and results for the operations of the Amazon CodeGuru Reviewer (2019-09-19), and shows how to use the Aws\CodeGuruReviewer\CodeGuruReviewerClient object to call the described operations. This documentation is specific to the 2019-09-19 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateRepository ( array $params = [] )
Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer.
- DescribeRepositoryAssociation ( array $params = [] )
Describes a repository association.
- DisassociateRepository ( array $params = [] )
Removes the association between Amazon CodeGuru Reviewer and a repository.
- ListRepositoryAssociations ( array $params = [] )
Lists repository associations.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateRepository
$result = $client->associateRepository([/* ... */]); $promise = $client->associateRepositoryAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateRepository([
'ClientRequestToken' => '<string>',
'Repository' => [ // REQUIRED
'CodeCommit' => [
'Name' => '<string>', // REQUIRED
],
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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.
- Repository
-
- Required: Yes
- Type: Repository structure
The repository to associate.
Result Syntax
[
'RepositoryAssociation' => [
'AssociationArn' => '<string>',
'AssociationId' => '<string>',
'CreatedTimeStamp' => <DateTime>,
'LastUpdatedTimeStamp' => <DateTime>,
'Name' => '<string>',
'Owner' => '<string>',
'ProviderType' => 'CodeCommit|GitHub',
'State' => 'Associated|Associating|Failed|Disassociating',
'StateReason' => '<string>',
],
]
Result Details
Members
- RepositoryAssociation
-
- Type: RepositoryAssociation structure
Information about the repository association.
Errors
-
The server encountered an internal error and is unable to complete the request.
-
The input fails to satisfy the specified constraints.
-
You do not have sufficient access to perform this action.
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
-
The request was denied due to request throttling.
DescribeRepositoryAssociation
$result = $client->describeRepositoryAssociation([/* ... */]); $promise = $client->describeRepositoryAssociationAsync([/* ... */]);
Describes a repository association.
Parameter Syntax
$result = $client->describeRepositoryAssociation([
'AssociationArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RepositoryAssociation' => [
'AssociationArn' => '<string>',
'AssociationId' => '<string>',
'CreatedTimeStamp' => <DateTime>,
'LastUpdatedTimeStamp' => <DateTime>,
'Name' => '<string>',
'Owner' => '<string>',
'ProviderType' => 'CodeCommit|GitHub',
'State' => 'Associated|Associating|Failed|Disassociating',
'StateReason' => '<string>',
],
]
Result Details
Members
- RepositoryAssociation
-
- Type: RepositoryAssociation structure
Information about the repository association.
Errors
-
The resource specified in the request was not found.
-
The server encountered an internal error and is unable to complete the request.
-
The input fails to satisfy the specified constraints.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
DisassociateRepository
$result = $client->disassociateRepository([/* ... */]); $promise = $client->disassociateRepositoryAsync([/* ... */]);
Removes the association between Amazon CodeGuru Reviewer and a repository.
Parameter Syntax
$result = $client->disassociateRepository([
'AssociationArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RepositoryAssociation' => [
'AssociationArn' => '<string>',
'AssociationId' => '<string>',
'CreatedTimeStamp' => <DateTime>,
'LastUpdatedTimeStamp' => <DateTime>,
'Name' => '<string>',
'Owner' => '<string>',
'ProviderType' => 'CodeCommit|GitHub',
'State' => 'Associated|Associating|Failed|Disassociating',
'StateReason' => '<string>',
],
]
Result Details
Members
- RepositoryAssociation
-
- Type: RepositoryAssociation structure
Information about the disassociated repository.
Errors
-
The resource specified in the request was not found.
-
The server encountered an internal error and is unable to complete the request.
-
The input fails to satisfy the specified constraints.
-
You do not have sufficient access to perform this action.
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
-
The request was denied due to request throttling.
ListRepositoryAssociations
$result = $client->listRepositoryAssociations([/* ... */]); $promise = $client->listRepositoryAssociationsAsync([/* ... */]);
Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.
Parameter Syntax
$result = $client->listRepositoryAssociations([
'MaxResults' => <integer>,
'Names' => ['<string>', ...],
'NextToken' => '<string>',
'Owners' => ['<string>', ...],
'ProviderTypes' => ['<string>', ...],
'States' => ['<string>', ...],
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of repository association results returned by
ListRepositoryAssociationsin paginated output. When this parameter is used,ListRepositoryAssociationsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListRepositoryAssociationsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListRepositoryAssociationsreturns up to 100 results and anextTokenvalue if applicable. - Names
-
- Type: Array of strings
List of names to use as a filter.
- NextToken
-
- Type: string
The
nextTokenvalue returned from a previous paginatedListRepositoryAssociationsrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.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.
- Owners
-
- Type: Array of strings
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.
- ProviderTypes
-
- Type: Array of strings
List of provider types to use as a filter.
- States
-
- Type: Array of strings
List of states to use as a filter.
Result Syntax
[
'NextToken' => '<string>',
'RepositoryAssociationSummaries' => [
[
'AssociationArn' => '<string>',
'AssociationId' => '<string>',
'LastUpdatedTimeStamp' => <DateTime>,
'Name' => '<string>',
'Owner' => '<string>',
'ProviderType' => 'CodeCommit|GitHub',
'State' => 'Associated|Associating|Failed|Disassociating',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The
nextTokenvalue to include in a futureListRecommendationsrequest. When the results of aListRecommendationsrequest exceedmaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return. - RepositoryAssociationSummaries
-
- Type: Array of RepositoryAssociationSummary structures
A list of repository associations that meet the criteria of the request.
Errors
-
The server encountered an internal error and is unable to complete the request.
-
The input fails to satisfy the specified constraints.
-
The request was denied due to request throttling.
Shapes
AccessDeniedException
CodeCommitRepository
Description
Information about an AWS CodeCommit repository.
Members
ConflictException
Description
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
Members
InternalServerException
Description
The server encountered an internal error and is unable to complete the request.
Members
NotFoundException
Repository
Description
Information about a repository.
Members
- CodeCommit
-
- Type: CodeCommitRepository structure
Information about an AWS CodeCommit repository.
RepositoryAssociation
Description
Information about a repository association.
Members
- AssociationArn
-
- Type: string
The Amazon Resource Name (ARN) identifying the repository association.
- AssociationId
-
- Type: string
The id of the repository association.
- CreatedTimeStamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time, in milliseconds since the epoch, when the repository association was created.
- LastUpdatedTimeStamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time, in milliseconds since the epoch, when the repository association was last updated.
- Name
-
- Type: string
The name of the repository.
- Owner
-
- Type: string
The owner of the repository.
- ProviderType
-
- Type: string
The provider type of the repository association.
- State
-
- Type: string
The state of the repository association.
- StateReason
-
- Type: string
A description of why the repository association is in the current state.
RepositoryAssociationSummary
Description
Information about a repository association.
Members
- AssociationArn
-
- Type: string
The Amazon Resource Name (ARN) identifying the repository association.
- AssociationId
-
- Type: string
The repository association ID.
- LastUpdatedTimeStamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time, in milliseconds since the epoch, since the repository association was last updated.
- Name
-
- Type: string
The name of the repository association.
- Owner
-
- Type: string
The owner of the repository association.
- ProviderType
-
- Type: string
The provider type of the repository association.
- State
-
- Type: 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.
