oam/aws.sdk.kotlin.services.oam

Package-level declarations

Types

Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createLink

inline suspend fun OamClient.createLink(crossinline block: CreateLinkRequest.Builder.() -> Unit): CreateLinkResponse

Creates a link between a source account and a sink that you have created in a monitoring account.

createSink

inline suspend fun OamClient.createSink(crossinline block: CreateSinkRequest.Builder.() -> Unit): CreateSinkResponse

Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

deleteLink

inline suspend fun OamClient.deleteLink(crossinline block: DeleteLinkRequest.Builder.() -> Unit): DeleteLinkResponse

Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.

deleteSink

inline suspend fun OamClient.deleteSink(crossinline block: DeleteSinkRequest.Builder.() -> Unit): DeleteSinkResponse

Deletes a sink. You must delete all links to a sink before you can delete that sink.

getLink

inline suspend fun OamClient.getLink(crossinline block: GetLinkRequest.Builder.() -> Unit): GetLinkResponse

Returns complete information about one link.

getSink

inline suspend fun OamClient.getSink(crossinline block: GetSinkRequest.Builder.() -> Unit): GetSinkResponse

Returns complete information about one monitoring account sink.

getSinkPolicy

inline suspend fun OamClient.getSinkPolicy(crossinline block: GetSinkPolicyRequest.Builder.() -> Unit): GetSinkPolicyResponse

Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.

listAttachedLinks

inline suspend fun OamClient.listAttachedLinks(crossinline block: ListAttachedLinksRequest.Builder.() -> Unit): ListAttachedLinksResponse

Returns a list of source account links that are linked to this monitoring account sink.

listLinks

inline suspend fun OamClient.listLinks(crossinline block: ListLinksRequest.Builder.() -> Unit): ListLinksResponse

Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

listSinks

inline suspend fun OamClient.listSinks(crossinline block: ListSinksRequest.Builder.() -> Unit): ListSinksResponse

Use this operation in a monitoring account to return the list of sinks created in that account.

listTagsForResource

inline suspend fun OamClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Displays the tags associated with a resource. Both sinks and links support tagging.

putSinkPolicy

inline suspend fun OamClient.putSinkPolicy(crossinline block: PutSinkPolicyRequest.Builder.() -> Unit): PutSinkPolicyResponse

Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.

tagResource

inline suspend fun OamClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

untagResource

inline suspend fun OamClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from the specified resource.

updateLink

inline suspend fun OamClient.updateLink(crossinline block: UpdateLinkRequest.Builder.() -> Unit): UpdateLinkResponse

Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.

withConfig

fun OamClient.withConfig(block: OamClient.Config.Builder.() -> Unit): OamClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.