Skip to content

GetLinkInput

Source code in docs_src/capo_oam/types/get_link_input.py 
14
15
16
17
18
class GetLinkInput(TypedDict, closed=True):
    identifier: "capo_oam.types.resource_identifier.ResourceIdentifier"
    """<p>The ARN of the link to retrieve information for.</p>"""
    include_tags: NotRequired["capo_oam.types.include_tags.IncludeTags"]
    """<p>Specifies whether to include the tags associated with the link in the response. When <code>IncludeTags</code> is set to <code>true</code> and the caller has the required permission, <code>oam:ListTagsForResource</code>, the API will return the tags for the specified resource. If the caller doesn't have the required permission, <code>oam:ListTagsForResource</code>, the API will raise an exception.</p> <p>The default value is <code>false</code>.</p>"""

identifier: ResourceIdentifier

The ARN of the link to retrieve information for.

include_tags: NotRequired[IncludeTags]

Specifies whether to include the tags associated with the link in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.

The default value is false.