Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1450250256.2 KB

Updates the configuration of an existing Gateway Instance.

put/v1/gateway-instances/{gatewayInstanceArn}

Path parameters

gatewayInstanceArnstring required

The Amazon Resource Name (ARN) of the instance that you want to update.

Request body

bridgePlacement'AVAILABLE' | 'LOCKED'

The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.

Response

Success

BridgePlacement'AVAILABLE' | 'LOCKED'

The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.

GatewayInstanceArnstring

The Amazon Resource Name (ARN) of the instance.