Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateServiceSyncConfig

Create the AWS Proton Ops configuration file.

Request Syntax


{
   "branch": "string",
   "filePath": "string",
   "repositoryName": "string",
   "repositoryProvider": "string",
   "serviceName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

branch

The repository branch for your AWS Proton Ops file.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes

filePath

The path to the AWS Proton Ops file.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: Yes

repositoryName

The repository name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*

Required: Yes

repositoryProvider

The provider type for your repository.

Type: String

Valid Values: GITHUB | GITHUB_ENTERPRISE | BITBUCKET

Required: Yes

serviceName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax


{
   "serviceSyncConfig": { 
      "branch": "string",
      "filePath": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "serviceName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

serviceSyncConfig

The detailed data of the AWS Proton Ops file.

Type: ServiceSyncConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton User Guide.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400