GetRepositorySyncStatus - AWS Proton

GetRepositorySyncStatus

Get the sync status of a repository used for AWS Proton template sync. For more information about template sync, see .

Note

A repository sync status isn't tied to the AWS Proton Repository resource (or any other AWS Proton resource). Therefore, tags on an AWS Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).

For more information about ABAC, see ABAC in the AWS Proton User Guide.

Request Syntax

{ "branch": "string", "repositoryName": "string", "repositoryProvider": "string", "syncType": "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.

branch

The repository branch.

Type: String

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

Required: Yes

repositoryName

The repository name.

Type: String

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

Pattern: [A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*

Required: Yes

repositoryProvider

The repository provider.

Type: String

Valid Values: GITHUB | GITHUB_ENTERPRISE | BITBUCKET

Required: Yes

syncType

The repository sync type.

Type: String

Valid Values: TEMPLATE_SYNC

Required: Yes

Response Syntax

{ "latestSync": { "events": [ { "event": "string", "externalId": "string", "time": number, "type": "string" } ], "startedAt": number, "status": "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.

latestSync

The repository sync status detail data that's returned by AWS Proton.

Type: RepositorySyncAttempt 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: