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

UpdateServiceNetworkVpcAssociation

Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Request Syntax


PATCH /servicenetworkvpcassociations/serviceNetworkVpcAssociationIdentifier HTTP/1.1
Content-type: application/json

{
   "securityGroupIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

serviceNetworkVpcAssociationIdentifier

The ID or Amazon Resource Name (ARN) of the association.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

securityGroupIds

The IDs of the security groups.

Type: Array of strings

Array Members: Minimum number of 1 item. 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: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdBy": "string",
   "id": "string",
   "securityGroupIds": [ "string" ],
   "status": "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 association.

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}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$

createdBy

The account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$

id

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

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

securityGroupIds

The IDs of the security groups.

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. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change in the status.

Type: String

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

ConflictException

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

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