APIGateway / Client / update_vpc_link

update_vpc_link#

APIGateway.Client.update_vpc_link(**kwargs)#

Updates an existing VpcLink of a specified identifier.

Request Syntax

response = client.update_vpc_link(
    vpcLinkId='string',
    patchOperations=[
        {
            'op': 'add'|'remove'|'replace'|'move'|'copy'|'test',
            'path': 'string',
            'value': 'string',
            'from': 'string'
        },
    ]
)

Parameters:

vpcLinkId (string) –
[REQUIRED]

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
patchOperations (list) –
For more information about supported patch operations, see Patch Operations.
- (dict) –
  
  For more information about supported patch operations, see Patch Operations.
  - op (string) –
    
    An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..
  - path (string) –
    
    The op operation’s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {“name”:”value”}, the path for this property is /name. If the name property value is a JSON object (e.g., {“name”: {“child/name”: “child-value”}}), the path for the child/name property will be /name/child~1name. Any slash (“/”) character appearing in path names must be escaped with “~1”, as shown in the example above. Each op operation can have only one path associated with it.
  - value (string) –
    
    The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ‘{“a”: …}’.
  - from (string) –
    
    The copy update operation’s source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with “op”:”copy”, “from”:”/canarySettings/deploymentId” and “path”:”/deploymentId”.

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) –

update_vpc_link#

Request Syntax

Response Syntax

Response Structure

Exceptions