GetTemplateSyncStatus - AWS Proton
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

GetTemplateSyncStatus

Get the status of a template sync.

Request Syntax

{
   "templateName": "string",
   "templateType": "string",
   "templateVersion": "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.

templateName

The template name.

Type: String

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

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

Required: Yes

templateType

The template type.

Type: String

Valid Values: ENVIRONMENT | SERVICE

Required: Yes

templateVersion

The template major version.

Type: String

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

Pattern: ^(0|([1-9]{1}\d*))$

Required: Yes

Response Syntax

{
   "desiredState": { 
      "branch": "string",
      "directory": "string",
      "repositoryName": "string",
      "repositoryProvider": "string",
      "sha": "string"
   },
   "latestSuccessfulSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "initialRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      },
      "startedAt": number,
      "status": "string",
      "target": "string",
      "targetRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      }
   },
   "latestSync": { 
      "events": [ 
         { 
            "event": "string",
            "externalId": "string",
            "time": number,
            "type": "string"
         }
      ],
      "initialRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "string"
      },
      "startedAt": number,
      "status": "string",
      "target": "string",
      "targetRevision": { 
         "branch": "string",
         "directory": "string",
         "repositoryName": "string",
         "repositoryProvider": "string",
         "sha": "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.

desiredState

The template sync desired state that's returned by AWS Proton.

Type: Revision object

latestSuccessfulSync

The details of the last successful sync that's returned by AWS Proton.

Type: ResourceSyncAttempt object

latestSync

The details of the last sync that's returned by AWS Proton.

Type: ResourceSyncAttempt 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

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: