Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

OAM

import { OAM } from "https://aws-api.deno.dev/v0.4/services/oam.ts?docs=full";
class OAM {
constructor(apiFactory: client.ApiFactory);
async createLink(params: CreateLinkInput, opts?: client.RequestOptions): Promise<CreateLinkOutput>;
async createSink(params: CreateSinkInput, opts?: client.RequestOptions): Promise<CreateSinkOutput>;
async deleteLink(params: DeleteLinkInput, opts?: client.RequestOptions): Promise<void>;
async deleteSink(params: DeleteSinkInput, opts?: client.RequestOptions): Promise<void>;
async getLink(params: GetLinkInput, opts?: client.RequestOptions): Promise<GetLinkOutput>;
async getSink(params: GetSinkInput, opts?: client.RequestOptions): Promise<GetSinkOutput>;
async getSinkPolicy(params: GetSinkPolicyInput, opts?: client.RequestOptions): Promise<GetSinkPolicyOutput>;
async listAttachedLinks(params: ListAttachedLinksInput, opts?: client.RequestOptions): Promise<ListAttachedLinksOutput>;
async listLinks(params?: ListLinksInput, opts?: client.RequestOptions): Promise<ListLinksOutput>;
async listSinks(params?: ListSinksInput, opts?: client.RequestOptions): Promise<ListSinksOutput>;
async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;
async putSinkPolicy(params: PutSinkPolicyInput, opts?: client.RequestOptions): Promise<PutSinkPolicyOutput>;
async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;
async updateLink(params: UpdateLinkInput, opts?: client.RequestOptions): Promise<UpdateLinkOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new OAM(apiFactory: client.ApiFactory)
[src]

§Methods

§
createSink(params: CreateSinkInput, opts?: client.RequestOptions): Promise<CreateSinkOutput>
[src]

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.

After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.

Each account can contain one sink. If you delete a sink, you can then create a new one in that account.

§
deleteSink(params: DeleteSinkInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
getSink(params: GetSinkInput, opts?: client.RequestOptions): Promise<GetSinkOutput>
[src]

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.

§
getSinkPolicy(params: GetSinkPolicyInput, opts?: client.RequestOptions): Promise<GetSinkPolicyOutput>
[src]

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.

§
listSinks(params?: ListSinksInput, opts?: client.RequestOptions): Promise<ListSinksOutput>
[src]

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

§
listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>
[src]

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

§
putSinkPolicy(params: PutSinkPolicyInput, opts?: client.RequestOptions): Promise<PutSinkPolicyOutput>
[src]

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.

You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:

  • Metrics - Specify with AWS::CloudWatch::Metric
  • Log groups - Specify with AWS::Logs::LogGroup
  • Traces - Specify with AWS::XRay::Trace

See the examples in this section to see how to specify permitted source accounts and data types.

§
tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

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

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.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

! IMPORTANT: ! Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. ! The iam:ResourceTag permission does not allow you to tag and untag links and sinks.

§
untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

Removes one or more tags from the specified resource.

! IMPORTANT: ! Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. ! The iam:TagResource permission does not allow you to tag and untag links and sinks.

§Static Properties