CodeStarconnections / Client / update_sync_configuration
update_sync_configuration#
- CodeStarconnections.Client.update_sync_configuration(**kwargs)#
Updates the sync configuration for your connection and a specified external Git repository.
See also: AWS API Documentation
Request Syntax
response = client.update_sync_configuration( Branch='string', ConfigFile='string', RepositoryLinkId='string', ResourceName='string', RoleArn='string', SyncType='CFN_STACK_SYNC' )
- Parameters:
Branch (string) – The branch for the sync configuration to be updated.
ConfigFile (string) – The configuration file for the sync configuration to be updated.
RepositoryLinkId (string) – The ID of the repository link for the sync configuration to be updated.
ResourceName (string) –
[REQUIRED]
The name of the Amazon Web Services resource for the sync configuration to be updated.
RoleArn (string) – The ARN of the IAM role for the sync configuration to be updated.
SyncType (string) –
[REQUIRED]
The sync type for the sync configuration to be updated.
- Return type:
dict
- Returns:
Response Syntax
{ 'SyncConfiguration': { 'Branch': 'string', 'ConfigFile': 'string', 'OwnerId': 'string', 'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged', 'RepositoryLinkId': 'string', 'RepositoryName': 'string', 'ResourceName': 'string', 'RoleArn': 'string', 'SyncType': 'CFN_STACK_SYNC' } }
Response Structure
(dict) –
SyncConfiguration (dict) –
The information returned for the sync configuration to be updated.
Branch (string) –
The branch associated with a specific sync configuration.
ConfigFile (string) –
The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.
OwnerId (string) –
The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
ProviderType (string) –
The connection provider type associated with a specific sync configuration, such as GitHub.
RepositoryLinkId (string) –
The ID of the repository link associated with a specific sync configuration.
RepositoryName (string) –
The name of the repository associated with a specific sync configuration.
ResourceName (string) –
The name of the connection resource associated with a specific sync configuration.
RoleArn (string) –
The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
SyncType (string) –
The type of sync for a specific sync configuration.
Exceptions
CodeStarconnections.Client.exceptions.AccessDeniedException
CodeStarconnections.Client.exceptions.ConcurrentModificationException
CodeStarconnections.Client.exceptions.InternalServerException
CodeStarconnections.Client.exceptions.InvalidInputException
CodeStarconnections.Client.exceptions.ResourceNotFoundException
CodeStarconnections.Client.exceptions.ThrottlingException
CodeStarconnections.Client.exceptions.UpdateOutOfSyncException