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

CreateLink

Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

For more information, see CreateSink and PutSinkPolicy.

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

Request Syntax


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

{
   "LabelTemplate": "string",
   "LinkConfiguration": { 
      "LogGroupConfiguration": { 
         "Filter": "string"
      },
      "MetricConfiguration": { 
         "Filter": "string"
      }
   },
   "ResourceTypes": [ "string" ],
   "SinkIdentifier": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

LabelTemplate

Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

You can use a custom label or use the following variables:

$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

LinkConfiguration

Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.

Type: LinkConfiguration object

Required: No

ResourceTypes

An array of strings that define which types of data that the source account shares with the monitoring account.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Valid Values: AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor

Required: Yes

SinkIdentifier

The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

For more information about sinks, see CreateSink.

Type: String

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

Required: Yes

Tags

Assigns one or more tags (key-value pairs) to the link.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


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" 
   }
}

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 that is newly created.

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. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.

Type: String

LabelTemplate

The exact label template that you specified, with the variables not resolved.

Type: String

LinkConfiguration

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

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.

ConflictException

A resource was in an inconsistent state during an update or a deletion.

HTTP Status Code: 409

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

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 429