Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SynchronizeGatewayTargets

The gateway targets.

Request Syntax


PUT /gateways/gatewayIdentifier/synchronizeTargets HTTP/1.1
Content-type: application/json

{
   "targetIdList": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

gatewayIdentifier

The gateway Identifier.

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

targetIdList

The target ID list.

Type: Array of strings

Array Members: Fixed number of 1 item.

Pattern: [0-9a-zA-Z]{10}

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "targets": [ 
      { 
         "createdAt": "string",
         "credentialProviderConfigurations": [ 
            { 
               "credentialProvider": { ... },
               "credentialProviderType": "string"
            }
         ],
         "description": "string",
         "gatewayArn": "string",
         "lastSynchronizedAt": "string",
         "name": "string",
         "status": "string",
         "statusReasons": [ "string" ],
         "targetConfiguration": { ... },
         "targetId": "string",
         "updatedAt": "string"
      }
   ]
}

Response Elements

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

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

targets

The gateway targets for synchronization.

Type: Array of GatewayTarget objects

Errors

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

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400