GetServiceInstanceSyncStatus
Get the status of the synced service instance.
Request Syntax
{
"serviceInstanceName": "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.
- serviceInstanceName
-
The name of the service instance that you want the sync status input for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[0-9A-Za-z]+[0-9A-Za-z_\-]*$Required: Yes
- serviceName
-
The name of the service that the service instance belongs to.
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
{
"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 service instance sync desired state that's returned by AWS Proton
Type: Revision object
- latestSuccessfulSync
-
The detailed data of the latest successful sync with the service instance.
Type: ResourceSyncAttempt object
- latestSync
-
The detailed data of the latest sync with the service instance.
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:
