Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14156867.6 KB

Returns complete information about one link.

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.

post/GetLink

Request body

Identifierstring required

The ARN of the link to retrieve information for.

IncludeTagsboolean
<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>

Response

Success

Arnstring

The ARN of the link.

Idstring

The random ID string that Amazon Web Services generated as part of the link ARN.

Labelstring

The label that you assigned to this link, with the variables resolved to their actual values.

LabelTemplatestring

The exact label template that was specified when the link was created, with the template variables not resolved.

ResourceTypesString[]

The resource types supported by this link.

SinkArnstring

The ARN of the sink that is used for this link.

Tagsobject

The tags assigned to the link.