Proton / Client / create_service_sync_config

create_service_sync_config

Proton.Client.create_service_sync_config(**kwargs)

Create the Proton Ops configuration file.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• branch (string) –

  [REQUIRED]

  The repository branch for your Proton Ops file.

• filePath (string) –

  [REQUIRED]

  The path to the Proton Ops file.

• repositoryName (string) –

  [REQUIRED]

  The repository name.

• repositoryProvider (string) –

  [REQUIRED]

  The provider type for your repository.

• 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

• Proton.Client.exceptions.ServiceQuotaExceededException

• Proton.Client.exceptions.ValidationException

• Proton.Client.exceptions.AccessDeniedException

• Proton.Client.exceptions.ThrottlingException

• Proton.Client.exceptions.ConflictException

• Proton.Client.exceptions.InternalServerException