Proton / Client / update_service_sync_config

update_service_sync_config

Proton.Client.update_service_sync_config(**kwargs)

Update the Proton Ops config file.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.update_service_sync_config(
    branch='string',
    filePath='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    serviceName='string'
)
Parameters:

  • branch (string) –

    [REQUIRED]

    The name of the code repository branch where the Proton Ops file is found.

  • filePath (string) –

    [REQUIRED]

    The path to the Proton Ops file.

  • repositoryName (string) –

    [REQUIRED]

    The name of the repository where the Proton Ops file is found.

  • repositoryProvider (string) –

    [REQUIRED]

    The name of the repository provider where the Proton Ops file is found.

  • serviceName (string) –

    [REQUIRED]

    The name of the service the Proton Ops file is for.

Return type:

dict

Returns:

Response Syntax

{
    'serviceSyncConfig': {
        'branch': 'string',
        'filePath': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'serviceName': 'string'
    }
}

Response Structure

  • (dict) –

    • serviceSyncConfig (dict) –

      The detailed data of the Proton Ops file.

      • branch (string) –

        The name of the code repository branch that holds the service code Proton will sync with.

      • filePath (string) –

        The file path to the service sync configuration file.

      • repositoryName (string) –

        The name of the code repository that holds the service code Proton will sync with.

      • repositoryProvider (string) –

        The name of the repository provider that holds the repository Proton will sync with.

      • serviceName (string) –

        The name of the service that the service instance is added to.

Exceptions