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

UpdateResourceGateway

Updates the specified resource gateway.

Request Syntax


PATCH /resourcegateways/resourceGatewayIdentifier HTTP/1.1
Content-type: application/json

{
   "securityGroupIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

resourceGatewayIdentifier

The ID or ARN of the resource gateway.

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ^((rgw-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}))$

Required: Yes

Request Body

The request accepts the following data in JSON format.

securityGroupIds

The IDs of the security groups associated with the resource gateway.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "ipAddressType": "string",
   "name": "string",
   "securityGroupIds": [ "string" ],
   "status": "string",
   "subnetIds": [ "string" ],
   "vpcId": "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.

arn

The Amazon Resource Name (ARN) of the resource gateway.

Type: String

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

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}$

id

The ID of the resource gateway.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^rgw-[0-9a-z]{17}$

ipAddressType

The type of IP address used by the resource gateway.

Type: String

Valid Values: IPV4 | IPV6

name

The name of the resource gateway.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: ^(?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

securityGroupIds

The IDs of the security groups associated with the resource gateway.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$

status

The status of the resource gateway.

Type: String

subnetIds

The IDs of the VPC subnets for the resource gateway.

Type: Array of strings

Length Constraints: Minimum length of 5. Maximum length of 200.

vpcId

The ID of the VPC for the resource gateway.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400