ListRepositorySyncDefinitions - AWS Proton

ListRepositorySyncDefinitions

List repository sync definitions with detail data.

Request Syntax

{ "nextToken": "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.

nextToken

A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.

Type: String

Length Constraints: Fixed length of 0.

Required: No

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 sync type. The only supported value is TEMPLATE_SYNC.

Type: String

Valid Values: TEMPLATE_SYNC

Required: Yes

Response Syntax

{ "nextToken": "string", "syncDefinitions": [ { "branch": "string", "directory": "string", "parent": "string", "target": "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.

nextToken

A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.

Type: String

Length Constraints: Fixed length of 0.

syncDefinitions

An array of repository sync definitions.

Type: Array of RepositorySyncDefinition objects

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

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: