GetResourceSyncStatus
Returns the status of the sync with the Git repository for a specific AWS resource.
Request Syntax
{
"ResourceName": "string",
"SyncType": "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.
- ResourceName
-
The name of the AWS resource for the sync status with the Git repository.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$Required: Yes
- SyncType
-
The sync type for the sync status with the Git repository.
Type: String
Valid Values:
CFN_STACK_SYNCRequired: Yes
Response Syntax
{
"DesiredState": {
"Branch": "string",
"Directory": "string",
"OwnerId": "string",
"ProviderType": "string",
"RepositoryName": "string",
"Sha": "string"
},
"LatestSuccessfulSync": {
"Events": [
{
"Event": "string",
"ExternalId": "string",
"Time": number,
"Type": "string"
}
],
"InitialRevision": {
"Branch": "string",
"Directory": "string",
"OwnerId": "string",
"ProviderType": "string",
"RepositoryName": "string",
"Sha": "string"
},
"StartedAt": number,
"Status": "string",
"Target": "string",
"TargetRevision": {
"Branch": "string",
"Directory": "string",
"OwnerId": "string",
"ProviderType": "string",
"RepositoryName": "string",
"Sha": "string"
}
},
"LatestSync": {
"Events": [
{
"Event": "string",
"ExternalId": "string",
"Time": number,
"Type": "string"
}
],
"InitialRevision": {
"Branch": "string",
"Directory": "string",
"OwnerId": "string",
"ProviderType": "string",
"RepositoryName": "string",
"Sha": "string"
},
"StartedAt": number,
"Status": "string",
"Target": "string",
"TargetRevision": {
"Branch": "string",
"Directory": "string",
"OwnerId": "string",
"ProviderType": "string",
"RepositoryName": "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 desired state of the AWS resource for the sync status with the Git repository.
Type: Revision object
- LatestSuccessfulSync
-
The latest successful sync for the sync status with the Git repository.
Type: ResourceSyncAttempt object
- LatestSync
-
The latest sync for the sync status with the Git repository, whether successful or not.
Type: ResourceSyncAttempt object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
Received an internal server exception. Try again later.
HTTP Status Code: 400
- InvalidInputException
-
The input is not valid. Verify that the action is typed correctly.
HTTP Status Code: 400
- ResourceNotFoundException
-
Resource not found. Verify the connection resource ARN and try again.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
