GetLinkCommand

Suggest an Edit

Returns complete information about one link.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OAMClient, GetLinkCommand } from "@aws-sdk/client-oam"; // ES Modules import
// const { OAMClient, GetLinkCommand } = require("@aws-sdk/client-oam"); // CommonJS import
const client = new OAMClient(config);
const input = { // GetLinkInput
  Identifier: "STRING_VALUE", // required
};
const command = new GetLinkCommand(input);
const response = await client.send(command);
// { // GetLinkOutput
//   Arn: "STRING_VALUE",
//   Id: "STRING_VALUE",
//   Label: "STRING_VALUE",
//   LabelTemplate: "STRING_VALUE",
//   ResourceTypes: [ // ResourceTypesOutput
//     "STRING_VALUE",
//   ],
//   SinkArn: "STRING_VALUE",
//   Tags: { // TagMapOutput
//     "<keys>": "STRING_VALUE",
//   },
//   LinkConfiguration: { // LinkConfiguration
//     LogGroupConfiguration: { // LogGroupConfiguration
//       Filter: "STRING_VALUE", // required
//     },
//     MetricConfiguration: { // MetricConfiguration
//       Filter: "STRING_VALUE", // required
//     },
//   },
// };

GetLinkCommand Input

See GetLinkCommandInput for more details

Parameter
Type
Description
Identifier
Required
string | undefined

The ARN of the link to retrieve information for.

GetLinkCommand Output

See GetLinkCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The ARN of the link.

Id
string | undefined

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

Label
string | undefined

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

LabelTemplate
string | undefined

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

LinkConfiguration
LinkConfiguration | undefined

This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

ResourceTypes
string[] | undefined

The resource types supported by this link.

SinkArn
string | undefined

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

Tags
Record<string, string> | undefined

The tags assigned to the link.

Throws

Name
Fault
Details
InternalServiceFault
server

Unexpected error while processing the request. Retry the request.

InvalidParameterException
client

A parameter is specified incorrectly.

MissingRequiredParameterException
client

A required parameter is missing from the request.

ResourceNotFoundException
client

The request references a resource that does not exist.

OAMServiceException
Base exception class for all service exceptions from OAM service.