CodeConnections / Client / list_sync_configurations
list_sync_configurations#
- CodeConnections.Client.list_sync_configurations(**kwargs)#
Returns a list of sync configurations for a specified repository.
See also: AWS API Documentation
Request Syntax
response = client.list_sync_configurations( MaxResults=123, NextToken='string', RepositoryLinkId='string', SyncType='CFN_STACK_SYNC' )
- Parameters:
MaxResults (integer) – A non-zero, non-negative integer used to limit the number of returned results.
NextToken (string) – An enumeration token that allows the operation to batch the results of the operation.
RepositoryLinkId (string) –
[REQUIRED]
The ID of the repository link for the requested list of sync configurations.
SyncType (string) –
[REQUIRED]
The sync type for the requested list of sync configurations.
- Return type:
dict
- Returns:
Response Syntax
{ 'SyncConfigurations': [ { 'Branch': 'string', 'ConfigFile': 'string', 'OwnerId': 'string', 'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged', 'RepositoryLinkId': 'string', 'RepositoryName': 'string', 'ResourceName': 'string', 'RoleArn': 'string', 'SyncType': 'CFN_STACK_SYNC', 'PublishDeploymentStatus': 'ENABLED'|'DISABLED', 'TriggerResourceUpdateOn': 'ANY_CHANGE'|'FILE_CHANGE', 'PullRequestComment': 'ENABLED'|'DISABLED' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
SyncConfigurations (list) –
The list of repository sync definitions returned by the request.
(dict) –
Information, such as repository, branch, provider, and resource names for a specific sync configuration.
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.
PublishDeploymentStatus (string) –
Whether to enable or disable publishing of deployment status to source providers.
TriggerResourceUpdateOn (string) –
When to trigger Git sync to begin the stack update.
PullRequestComment (string) –
A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
NextToken (string) –
An enumeration token that allows the operation to batch the next results of the operation.
Exceptions
CodeConnections.Client.exceptions.AccessDeniedException
CodeConnections.Client.exceptions.InternalServerException
CodeConnections.Client.exceptions.InvalidInputException
CodeConnections.Client.exceptions.ResourceNotFoundException
CodeConnections.Client.exceptions.ThrottlingException