update_vpc_link¶
Operation¶
update_vpc_link
¶
update_vpc_link(request: UpdateVpcLinkInput | UpdateVpcLinkInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateVpcLinkInputDict]) -> UpdateVpcLinkOutput
Updates an existing VpcLink of a specified identifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateVpcLinkInput | UpdateVpcLinkInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateVpcLinkInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateVpcLinkOutput
|
An instance of |
update_vpc_link
async
¶
update_vpc_link(request: UpdateVpcLinkInput | UpdateVpcLinkInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateVpcLinkInputDict]) -> UpdateVpcLinkOutput
Updates an existing VpcLink of a specified identifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateVpcLinkInput | UpdateVpcLinkInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateVpcLinkInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateVpcLinkOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateVpcLinkInputDict
¶
Bases: TypedDict
Dictionary form of UpdateVpcLinkInput.
Attributes¶
patch_operations
instance-attribute
¶
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None
For more information about supported patch operations, see Patch Operations.
UpdateVpcLinkInput
dataclass
¶
Bases: _SerdeShape
Updates an existing VpcLink of a specified identifier.
Attributes¶
patch_operations
class-attribute
instance-attribute
¶
patch_operations: list[PatchOperation] | None = ...
For more information about supported patch operations, see Patch Operations.
Output¶
UpdateVpcLinkOutput
dataclass
¶
Bases: _SerdeShape
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
Attributes¶
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the VPC link.
id
class-attribute
instance-attribute
¶
id: str | None = ...
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name used to label and identify the VPC link.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
status
class-attribute
instance-attribute
¶
status: str | None = ...
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.
status_message
class-attribute
instance-attribute
¶
status_message: str | None = ...
A description about the VPC link status.
tags
class-attribute
instance-attribute
¶
The collection of tags. Each tag element is associated with a given resource.