DescribeRepositoryAssociation - Amazon CodeGuru Reviewer

DescribeRepositoryAssociation

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

Request Syntax

GET /associations/AssociationArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AssociationArn

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

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:association:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "RepositoryAssociation": { "AssociationArn": "string", "AssociationId": "string", "ConnectionArn": "string", "CreatedTimeStamp": number, "KMSKeyDetails": { "EncryptionOption": "string", "KMSKeyId": "string" }, "LastUpdatedTimeStamp": number, "Name": "string", "Owner": "string", "ProviderType": "string", "S3RepositoryDetails": { "BucketName": "string", "CodeArtifacts": { "BuildArtifactsObjectKey": "string", "SourceCodeArtifactsObjectKey": "string" } }, "State": "string", "StateReason": "string" }, "Tags": { "string" : "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RepositoryAssociation

Information about the repository association.

Type: RepositoryAssociation object

Tags

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.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

NotFoundException

The resource specified in the request was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: