GetLink - Amazon CloudWatch Observability Access Manager

GetLink

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 HTTP/1.1 Content-type: application/json { "Identifier": "string" }

The request does not use any URI parameters.

The request accepts the following data in JSON format.

The ARN of the link to retrieve information for.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_:\.\-\/]{0,2047}$

Required: Yes

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Id": "string", "Label": "string", "LabelTemplate": "string", "LinkConfiguration": { "LogGroupConfiguration": { "Filter": "string" }, "MetricConfiguration": { "Filter": "string" } }, "ResourceTypes": [ "string" ], "SinkArn": "string", "Tags": { "string" : "string" } }

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The ARN of the link.

Type: String

The random ID string that AWS generated as part of the link ARN.

Type: String

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

Type: String

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

Type: String

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

Type: LinkConfiguration object

The resource types supported by this link.

Type: Array of strings

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

Type: String

The tags assigned to the link.

Type: String to string map

For information about the errors that are common to all actions, see Common Errors.

InternalServiceFault

Unexpected error while processing the request. Retry the request.

HTTP Status Code: 500

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

MissingRequiredParameterException

A required parameter is missing from the request.

HTTP Status Code: 400

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

For more information about using this API in one of the language-specific AWS SDKs, see the following: