Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSyncConfigurations

Returns a list of sync configurations for a specified repository.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "RepositoryLinkId": "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.

MaxResults

A non-zero, non-negative integer used to limit the number of returned results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

NextToken

An enumeration token that allows the operation to batch the results of the operation.

Type: String

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

Pattern: ^.*$

Required: No

RepositoryLinkId

The ID of the repository link for the requested list of sync configurations.

Type: String

Pattern: ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

Required: Yes

SyncType

The sync type for the requested list of sync configurations.

Type: String

Valid Values: CFN_STACK_SYNC

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "SyncConfigurations": [ 
      { 
         "Branch": "string",
         "ConfigFile": "string",
         "OwnerId": "string",
         "ProviderType": "string",
         "PublishDeploymentStatus": "string",
         "PullRequestComment": "string",
         "RepositoryLinkId": "string",
         "RepositoryName": "string",
         "ResourceName": "string",
         "RoleArn": "string",
         "SyncType": "string",
         "TriggerResourceUpdateOn": "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

An enumeration token that allows the operation to batch the next results of the operation.

Type: String

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

Pattern: ^.*$

SyncConfigurations

The list of repository sync definitions returned by the request.

Type: Array of SyncConfiguration objects

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: 400

InternalServerException

Received an internal server exception. Try again later.

HTTP Status Code: 400

InvalidInputException

The input is not valid. Verify that the action is typed correctly.

HTTP Status Code: 400

ResourceNotFoundException

Resource not found. Verify the connection resource ARN and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400