create_link

CloudWatchObservabilityAccessManager.Client.create_link(**kwargs)

Creates a link between a source account and a sink that you have created in a 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.

See also: AWS API Documentation

Request Syntax

response = client.create_link(
    LabelTemplate='string',
    ResourceTypes=[
        'AWS::CloudWatch::Metric'|'AWS::Logs::LogGroup'|'AWS::XRay::Trace',
    ],
    SinkIdentifier='string',
    Tags={
        'string': 'string'
    }
)

Parameters

• LabelTemplate (string) --

  [REQUIRED]

  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
• ResourceTypes (list) --

  [REQUIRED]

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

  • (string) --
• SinkIdentifier (string) --

  [REQUIRED]

  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.

• Tags (dict) --

  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.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • Arn (string) --

    The ARN of the link that is newly created.

  • Id (string) --

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

  • Label (string) --

    The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.

  • LabelTemplate (string) --

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

  • ResourceTypes (list) --

    The resource types supported by this link.

    • (string) --

  • SinkArn (string) --

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

  • Tags (dict) --

    The tags assigned to the link.

    • (string) --
      • (string) --

Exceptions

• CloudWatchObservabilityAccessManager.Client.exceptions.InternalServiceFault
• CloudWatchObservabilityAccessManager.Client.exceptions.ConflictException
• CloudWatchObservabilityAccessManager.Client.exceptions.MissingRequiredParameterException
• CloudWatchObservabilityAccessManager.Client.exceptions.ServiceQuotaExceededException
• CloudWatchObservabilityAccessManager.Client.exceptions.InvalidParameterException