Amazon Web Services, Inc.

Amazon VPC Lattice

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide

Endpoints 73

Rule

  • GETList rules/services/:serviceIdentifier/listeners/:listenerIdentifier/rules?maxResults=0&nextToken=stringLists the rules for the specified listener.
  • POSTCreate rule/services/:serviceIdentifier/listeners/:listenerIdentifier/rulesCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a…
  • GETGet rule/services/:serviceIdentifier/listeners/:listenerIdentifier/rules/:ruleIdentifierRetrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see…
  • DELETEDelete rule/services/:serviceIdentifier/listeners/:listenerIdentifier/rules/:ruleIdentifierDeletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a…
  • PATCHUpdate rule/services/:serviceIdentifier/listeners/:listenerIdentifier/rules/:ruleIdentifierUpdates a specified rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener .

Access log subscription

  • GETList access log subscriptions/accesslogsubscriptions?resourceIdentifier=string&maxResults=0&nextToken=stringLists the access log subscriptions for the specified service network or service.
  • POSTCreate access log subscription/accesslogsubscriptionsEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit…
  • GETGet access log subscription/accesslogsubscriptions/:accessLogSubscriptionIdentifierRetrieves information about the specified access log subscription.
  • DELETEDelete access log subscription/accesslogsubscriptions/:accessLogSubscriptionIdentifierDeletes the specified access log subscription.
  • PATCHUpdate access log subscription/accesslogsubscriptions/:accessLogSubscriptionIdentifierUpdates the specified access log subscription.

Listener

  • GETList listeners/services/:serviceIdentifier/listeners?maxResults=0&nextToken=stringLists the listeners for the specified service.
  • POSTCreate listener/services/:serviceIdentifier/listenersCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that…
  • GETGet listener/services/:serviceIdentifier/listeners/:listenerIdentifierRetrieves information about the specified listener for the specified service.
  • DELETEDelete listener/services/:serviceIdentifier/listeners/:listenerIdentifierDeletes the specified listener.
  • PATCHUpdate listener/services/:serviceIdentifier/listeners/:listenerIdentifierUpdates the specified listener for the specified service.

Resource configuration

  • GETList resource configurations/resourceconfigurations?resourceGatewayIdentifier=string&resourceConfigurationGroupIdentifier=string&domainVerificationIdentifier=string&maxResults=0&nextToken=stringLists the resource configurations owned by or shared with this account.
  • POSTCreate resource configuration/resourceconfigurationsCreates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a…
  • GETGet resource configuration/resourceconfigurations/:resourceConfigurationIdentifierRetrieves information about the specified resource configuration.
  • DELETEDelete resource configuration/resourceconfigurations/:resourceConfigurationIdentifierDeletes the specified resource configuration.
  • PATCHUpdate resource configuration/resourceconfigurations/:resourceConfigurationIdentifierUpdates the specified resource configuration.

Resource gateway

  • GETList resource gateways/resourcegateways?maxResults=0&nextToken=stringLists the resource gateways that you own or that were shared with you.
  • POSTCreate resource gateway/resourcegatewaysA resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from…
  • GETGet resource gateway/resourcegateways/:resourceGatewayIdentifierRetrieves information about the specified resource gateway.
  • DELETEDelete resource gateway/resourcegateways/:resourceGatewayIdentifierDeletes the specified resource gateway.
  • PATCHUpdate resource gateway/resourcegateways/:resourceGatewayIdentifierUpdates the specified resource gateway.

Service

  • GETList services/services?maxResults=0&nextToken=stringLists the services owned by the caller account or shared with the caller account.
  • POSTCreate service/servicesCreates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private…
  • GETGet service/services/:serviceIdentifierRetrieves information about the specified service.
  • DELETEDelete service/services/:serviceIdentifierDeletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such…
  • PATCHUpdate service/services/:serviceIdentifierUpdates the specified service.

Service network

  • GETList service networks/servicenetworks?maxResults=0&nextToken=stringLists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network.
  • POSTCreate service network/servicenetworksCreates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.…
  • GETGet service network/servicenetworks/:serviceNetworkIdentifierRetrieves information about the specified service network.
  • DELETEDelete service network/servicenetworks/:serviceNetworkIdentifierDeletes a service network. You can only delete the service network if there are no services, VPCs, resource configurations, or service network endpoints…
  • PATCHUpdate service network/servicenetworks/:serviceNetworkIdentifierUpdates the specified service network.

Service network resource association

  • GETList service network resource associations/servicenetworkresourceassociations?serviceNetworkIdentifier=string&resourceConfigurationIdentifier=string&maxResults=0&nextToken=string&includeChildren=trueLists the associations between a service network and a resource configuration.
  • POSTCreate service network resource association/servicenetworkresourceassociationsAssociates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the…
  • GETGet service network resource association/servicenetworkresourceassociations/:serviceNetworkResourceAssociationIdentifierRetrieves information about the specified association between a service network and a resource configuration.
  • DELETEDelete service network resource association/servicenetworkresourceassociations/:serviceNetworkResourceAssociationIdentifierDeletes the association between a service network and a resource configuration.

Service network service association

  • GETList service network service associations/servicenetworkserviceassociations?serviceNetworkIdentifier=string&serviceIdentifier=string&maxResults=0&nextToken=stringLists the associations between a service network and a service. You can filter the list either by service or service network. You must provide either the…
  • POSTCreate service network service association/servicenetworkserviceassociationsAssociates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User…
  • GETGet service network service association/servicenetworkserviceassociations/:serviceNetworkServiceAssociationIdentifierRetrieves information about the specified association between a service network and a service.
  • DELETEDelete service network service association/servicenetworkserviceassociations/:serviceNetworkServiceAssociationIdentifierDeletes the association between a service and a service network. This operation fails if an association is still in progress.

Service network vpc association

  • GETList service network vpc associations/servicenetworkvpcassociations?serviceNetworkIdentifier=string&vpcIdentifier=string&maxResults=0&nextToken=stringLists the associations between a service network and a VPC. You can filter the list either by VPC or service network. You must provide either the ID of the…
  • POSTCreate service network vpc association/servicenetworkvpcassociationsAssociates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and…
  • GETGet service network vpc association/servicenetworkvpcassociations/:serviceNetworkVpcAssociationIdentifierRetrieves information about the specified association between a service network and a VPC.
  • DELETEDelete service network vpc association/servicenetworkvpcassociations/:serviceNetworkVpcAssociationIdentifierDisassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.
  • PATCHUpdate service network vpc association/servicenetworkvpcassociations/:serviceNetworkVpcAssociationIdentifierUpdates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to have…

Target group

  • GETList target groups/targetgroups?maxResults=0&nextToken=string&vpcIdentifier=string&targetGroupType=stringLists your target groups. You can narrow your search by using the filters below in your request.
  • POSTCreate target group/targetgroupsCreates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used…
  • GETGet target group/targetgroups/:targetGroupIdentifierRetrieves information about the specified target group.
  • DELETEDelete target group/targetgroups/:targetGroupIdentifierDeletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.
  • PATCHUpdate target group/targetgroups/:targetGroupIdentifierUpdates the specified target group.
  • POSTDeregister targets/targetgroups/:targetGroupIdentifier/deregistertargetsDeregisters the specified targets from the specified target group.
  • POSTList targets/targetgroups/:targetGroupIdentifier/listtargets?maxResults=0&nextToken=stringLists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter…
  • POSTRegister targets/targetgroups/:targetGroupIdentifier/registertargetsRegisters the targets with the target group. If it's a Lambda target, you can only have one target in a target group.

Domain verification

  • GETGet domain verification/domainverifications/:domainVerificationIdentifierRetrieves information about a domain verification.ß
  • DELETEDelete domain verification/domainverifications/:domainVerificationIdentifierDeletes the specified domain verification.
  • GETList domain verifications/domainverifications?maxResults=0&nextToken=stringLists the domain verifications.
  • POSTStart domain verification/domainverificationsStarts the domain verification process for a custom domain name.

Resource endpoint association

  • DELETEDelete resource endpoint association/resourceendpointassociations/:resourceEndpointAssociationIdentifierDisassociates the resource configuration from the resource VPC endpoint.
  • GETList resource endpoint associations/resourceendpointassociations?resourceConfigurationIdentifier=string&resourceEndpointAssociationIdentifier=string&vpcEndpointId=string&vpcEndpointOwner=string&maxResults=0&nextToken=stringLists the associations for the specified VPC endpoint.
  • PATCHBatch update rule/services/:serviceIdentifier/listeners/:listenerIdentifier/rulesUpdates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping…
  • GETGet auth policy/authpolicy/:resourceIdentifierRetrieves information about the auth policy for the specified service or service network.
  • PUTPut auth policy/authpolicy/:resourceIdentifierCreates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines. For more information, see Auth policies in the Amazon…
  • DELETEDelete auth policy/authpolicy/:resourceIdentifierDeletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth…
  • GETGet resource policy/resourcepolicy/:resourceArnRetrieves information about the specified resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a…
  • PUTPut resource policy/resourcepolicy/:resourceArnAttaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon…
  • DELETEDelete resource policy/resourcepolicy/:resourceArnDeletes the specified resource policy.
  • GETList service network vpc endpoint associations/servicenetworkvpcendpointassociations?serviceNetworkIdentifier=string&maxResults=0&nextToken=stringLists the associations between a service network and a VPC endpoint.
  • GETList tags for resource/tags/:resourceArnLists the tags for the specified resource.
  • POSTTag resource/tags/:resourceArnAdds the specified tags to the specified resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource.

API details

Base URL
https://vpc-lattice.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
73 operations on 33 pathsGET 29POST 16DELETE 16PATCH 10PUT 2
Main resources
Target group 8Access log subscription 5Listener 5Resource configuration 5Resource gateway 5Rule 5Service 5Service network 5Service network vpc association 5Domain verification 4
Description format
AWS Smithy model, API version 2022-11-30

How to test the Amazon VPC Lattice in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon VPC Lattice collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List rules” (GET /services/:serviceIdentifier/listeners/:listenerIdentifier/rules?maxResults=0&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon VPC Lattice?

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple… It is listed under Developer tools and has 73 endpoints.

Who publishes the Amazon VPC Lattice?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon VPC Lattice?

Requests go to https://vpc-lattice.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon VPC Lattice?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon VPC Lattice have?

73 operations on 33 paths (29 GET, 16 POST, 16 DELETE, 10 PATCH, 2 PUT). The largest groups are Target group, Access log subscription, Listener, Resource configuration.

Is forking the Amazon VPC Lattice free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.