APIGateway / Client / create_vpc_link

create_vpc_link#

APIGateway.Client.create_vpc_link(**kwargs)#

Creates a VPC link, under the caller’s account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

Request Syntax

response = client.create_vpc_link(
    name='string',
    description='string',
    targetArns=[
        'string',
    ],
    tags={
        'string': 'string'
    }
)

Parameters:

name (string) –
[REQUIRED]

The name used to label and identify the VPC link.
description (string) – The description of the VPC link.
targetArns (list) –
[REQUIRED]

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
- (string) –
tags (dict) –
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'description': 'string',
    'targetArns': [
        'string',
    ],
    'status': 'AVAILABLE'|'PENDING'|'DELETING'|'FAILED',
    'statusMessage': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
- id (string) –
  
  The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- name (string) –
  
  The name used to label and identify the VPC link.
- description (string) –
  
  The description of the VPC link.
- targetArns (list) –
  
  The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
  - (string) –
- status (string) –
  
  The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
- statusMessage (string) –
  
  A description about the VPC link status.
- tags (dict) –
  
  The collection of tags. Each tag element is associated with a given resource.
  - (string) –
    - (string) –

create_vpc_link#

Request Syntax

Response Syntax

Response Structure

Exceptions