Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473359323.2 KB

Associates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

As a result of this operation, the association is created in the service network account and the association owner account.

post/servicenetworkserviceassociations

Request body

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

serviceIdentifierstring required

The ID or ARN of the service.

serviceNetworkIdentifierstring required

The ID or ARN of the service network. You must use an ARN if the resources are in different accounts.

tagsobject

The tags for the association.

Response

Success

idstring

The ID of the association.

status'CREATE_IN_PROGRESS' | 'ACTIVE' | 'DELETE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_FAILED'

The association status.

arnstring

The Amazon Resource Name (ARN) of the association.

createdBystring

The account that created the association.

customDomainNamestring

The custom domain name of the service.