Proton / Client / update_template_sync_config

update_template_sync_config#

Proton.Client.update_template_sync_config(**kwargs)#

Update template sync configuration parameters, except for the templateName and templateType. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

See also: AWS API Documentation

Request Syntax

response = client.update_template_sync_config(
    branch='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    subdirectory='string',
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)
Parameters:

  • branch (string) –

    [REQUIRED]

    The repository branch for your template.

  • repositoryName (string) –

    [REQUIRED]

    The repository name (for example, myrepos/myrepo).

  • repositoryProvider (string) –

    [REQUIRED]

    The repository provider.

  • subdirectory (string) – A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.

  • templateName (string) –

    [REQUIRED]

    The synced template name.

  • templateType (string) –

    [REQUIRED]

    The synced template type.

Return type:

dict

Returns:

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

  • (dict) –

    • templateSyncConfig (dict) –

      The template sync configuration detail data that’s returned by Proton.

      • branch (string) –

        The repository branch.

      • repositoryName (string) –

        The repository name (for example, myrepos/myrepo).

      • repositoryProvider (string) –

        The repository provider.

      • subdirectory (string) –

        A subdirectory path to your template bundle version.

      • templateName (string) –

        The template name.

      • templateType (string) –

        The template type.

Exceptions

  • Proton.Client.exceptions.ValidationException

  • Proton.Client.exceptions.AccessDeniedException

  • Proton.Client.exceptions.ThrottlingException

  • Proton.Client.exceptions.ConflictException

  • Proton.Client.exceptions.ResourceNotFoundException

  • Proton.Client.exceptions.InternalServerException