GetRepository
Get detail data for a linked repository.
Request Syntax
{
"name": "string
",
"provider": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- name
-
The repository name, for example
myrepos/myrepo
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*
Required: Yes
- provider
-
The repository provider.
Type: String
Valid Values:
GITHUB | GITHUB_ENTERPRISE | BITBUCKET
Required: Yes
Response Syntax
{
"repository": {
"arn": "string",
"connectionArn": "string",
"encryptionKey": "string",
"name": "string",
"provider": "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.
- repository
-
The repository link's detail data that's returned by AWS Proton.
Type: Repository object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
There isn't sufficient access for performing this action.
HTTP Status Code: 400
- InternalServerException
-
The request failed to register with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: