CloudWatchObservabilityAccessManager / Client / get_sink

get_sink

CloudWatchObservabilityAccessManager.Client.get_sink(**kwargs)

Returns complete information about one monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

See also: AWS API Documentation

Request Syntax

response = client.get_sink(
    Identifier='string',
    IncludeTags=True|False
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    The ARN of the sink to retrieve information for.

  • IncludeTags (boolean) –

    Specifies whether to include the tags associated with the sink in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn’t have the required permission, oam:ListTagsForResource, the API will raise an exception.

    The default value is false.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • Arn (string) –

      The ARN of the sink.

    • Id (string) –

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

    • Name (string) –

      The name of the sink.

    • Tags (dict) –

      The tags assigned to the sink.

      • (string) –

        • (string) –

Exceptions