Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateSyncConfiguration

Updates the sync configuration for your connection and a specified external Git repository.

Request Syntax


{
   "Branch": "string",
   "ConfigFile": "string",
   "PublishDeploymentStatus": "string",
   "PullRequestComment": "string",
   "RepositoryLinkId": "string",
   "ResourceName": "string",
   "RoleArn": "string",
   "SyncType": "string",
   "TriggerResourceUpdateOn": "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 branch for the sync configuration to be updated.

Type: String

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

Pattern: ^.*$

Required: No

ConfigFile

The configuration file for the sync configuration to be updated.

Type: String

Required: No

PublishDeploymentStatus

Whether to enable or disable publishing of deployment status to source providers.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

PullRequestComment

TA toggle that specifies whether to enable or disable pull request comments for the sync configuration to be updated.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

RepositoryLinkId

The ID of the repository link for the sync configuration to be updated.

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

ResourceName

The name of the AWS resource for the sync configuration to be updated.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$

Required: Yes

RoleArn

The ARN of the IAM role for the sync configuration to be updated.

Type: String

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

Pattern: arn:aws(-[\w]+)*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: No

SyncType

The sync type for the sync configuration to be updated.

Type: String

Valid Values: CFN_STACK_SYNC

Required: Yes

TriggerResourceUpdateOn

When to trigger Git sync to begin the stack update.

Type: String

Valid Values: ANY_CHANGE | FILE_CHANGE

Required: No

Response Syntax


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

SyncConfiguration

The information returned for the sync configuration to be updated.

Type: SyncConfiguration object

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

ConcurrentModificationException

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

UpdateOutOfSyncException

The update is out of sync. Try syncing again.

HTTP Status Code: 400