ListServiceNetworkVpcAssociations - Amazon VPC Lattice

ListServiceNetworkVpcAssociations

Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.

Request Syntax

GET /servicenetworkvpcassociations?maxResults=maxResults&nextToken=nextToken&serviceNetworkIdentifier=serviceNetworkIdentifier&vpcIdentifier=vpcIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

A pagination token for the next page of results.

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

serviceNetworkIdentifier

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

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

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

vpcIdentifier

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

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "items": [ { "arn": "string", "createdAt": "string", "createdBy": "string", "id": "string", "lastUpdatedAt": "string", "serviceNetworkArn": "string", "serviceNetworkId": "string", "serviceNetworkName": "string", "status": "string", "vpcId": "string" } ], "nextToken": "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.

items

Information about the associations.

Type: Array of ServiceNetworkVpcAssociationSummary objects

nextToken

If there are additional results, a pagination token for the next page of results.

Type: String

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

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: