CloudWatchObservabilityAccessManager / Client / get_link
get_link#
- CloudWatchObservabilityAccessManager.Client.get_link(**kwargs)#
Returns complete information about one link.
To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
See also: AWS API Documentation
Request Syntax
response = client.get_link( Identifier='string' )
- Parameters:
Identifier (string) –
[REQUIRED]
The ARN of the link to retrieve information for.
- Return type:
dict
- Returns:
Response Syntax
{ 'Arn': 'string', 'Id': 'string', 'Label': 'string', 'LabelTemplate': 'string', 'LinkConfiguration': { 'LogGroupConfiguration': { 'Filter': 'string' }, 'MetricConfiguration': { 'Filter': 'string' } }, 'ResourceTypes': [ 'string', ], 'SinkArn': 'string', 'Tags': { 'string': 'string' } }
Response Structure
(dict) –
Arn (string) –
The ARN of the link.
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, with the variables resolved to their actual values.
LabelTemplate (string) –
The exact label template that was specified when the link was created, with the template variables not resolved.
LinkConfiguration (dict) –
This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
LogGroupConfiguration (dict) –
Use this structure to filter which log groups are to send log events from the source account to the monitoring account.
Filter (string) –
Use this field to specify which log groups are to share their log events with the monitoring account. Use the term
LogGroupName
and one or more of the following operands. Use single quotation marks (’) around log group names. The matching of log group names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands areAND
andOR
.=
and!=
AND
OR
LIKE
andNOT LIKE
. These can be used only as prefix searches. Include a%
at the end of the string that you want to search for and include.IN
andNOT IN
, using parentheses( )
Examples:
LogGroupName IN ('This-Log-Group', 'Other-Log-Group')
includes only the log groups with namesThis-Log-Group
andOther-Log-Group
.LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2')
includes all log groups except the log groups with namesPrivate-Log-Group
andPrivate-Log-Group-2
.LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'
includes all log groups that have names that start withaws/lambda/
orAWSLogs
.
Note
If you are updating a link that uses filters, you can specify
*
as the only value for thefilter
parameter to delete the filter and share all log groups with the monitoring account.
MetricConfiguration (dict) –
Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
Filter (string) –
Use this field to specify which metrics are to be shared with the monitoring account. Use the term
Namespace
and one or more of the following operands. Use single quotation marks (’) around namespace names. The matching of namespace names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands areAND
andOR
.=
and!=
AND
OR
LIKE
andNOT LIKE
. These can be used only as prefix searches. Include a%
at the end of the string that you want to search for and include.IN
andNOT IN
, using parentheses( )
Examples:
Namespace NOT LIKE 'AWS/%'
includes only namespaces that don’t start withAWS/
, such as custom namespaces.Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')
includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%'
includes only the EC2 namespace and your custom namespaces.
Note
If you are updating a link that uses filters, you can specify
*
as the only value for thefilter
parameter to delete the filter and share all metric namespaces with the monitoring account.
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.MissingRequiredParameterException
CloudWatchObservabilityAccessManager.Client.exceptions.InvalidParameterException
CloudWatchObservabilityAccessManager.Client.exceptions.ResourceNotFoundException