Skip to content

Get Sink

cloudwatchobservabilityaccessmanager_get_sink R Documentation

Returns complete information about one monitoring account sink

Description

Returns complete information about one monitoring account sink.

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

Usage

cloudwatchobservabilityaccessmanager_get_sink(Identifier, IncludeTags)

Arguments

Identifier

[required] The ARN of the sink to retrieve information for.

IncludeTags

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.

Value

A list with the following syntax:

list(
  Arn = "string",
  Id = "string",
  Name = "string",
  Tags = list(
    "string"
  )
)

Request syntax

svc$get_sink(
  Identifier = "string",
  IncludeTags = TRUE|FALSE
)