Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetLink

Returns complete information about one link.

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

Request Syntax


POST /GetLink HTTP/1.1
Content-type: application/json

{
   "Identifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Identifier

The ARN of the link to retrieve information for.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string",
   "Label": "string",
   "LabelTemplate": "string",
   "ResourceTypes": [ "string" ],
   "SinkArn": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

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

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

Arn

The ARN of the link.

Type: String

Id

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

Type: String

Label

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

Type: String

LabelTemplate

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

Type: String

ResourceTypes

The resource types supported by this link.

Type: Array of strings

SinkArn

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

Type: String

Tags

The tags assigned to the link.

Type: String to string map

Errors

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