CloudWatch Observability Access Manager

2022/11/28 - CloudWatch Observability Access Manager - 15 new api methods

Changes  Amazon CloudWatch Observability Access Manager is a new service that allows configuration of the CloudWatch cross-account observability feature.

GetSink (new) Link ¶

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

client.get_sink(
    Identifier='string'
)
type Identifier

string

param Identifier

[REQUIRED]

The ARN of the sink to retrieve information for.

rtype

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) --

GetSinkPolicy (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.get_sink_policy(
    SinkIdentifier='string'
)
type SinkIdentifier

string

param SinkIdentifier

[REQUIRED]

The ARN of the sink to retrieve the policy of.

rtype

dict

returns

Response Syntax

{
    'SinkArn': 'string',
    'SinkId': 'string',
    'Policy': 'string'
}

Response Structure

  • (dict) --

    • SinkArn (string) --

      The ARN of the sink.

    • SinkId (string) --

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

    • Policy (string) --

      The policy that you specified, in JSON format.

PutSinkPolicy (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.put_sink_policy(
    SinkIdentifier='string',
    Policy='string'
)
type SinkIdentifier

string

param SinkIdentifier

[REQUIRED]

The ARN of the sink to attach this policy to.

type Policy

string

param Policy

[REQUIRED]

The JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.

The policy must be in JSON string format with quotation marks escaped and no newlines.

For examples of different types of policies, see the Examples section on this page.

rtype

dict

returns

Response Syntax

{
    'SinkArn': 'string',
    'SinkId': 'string',
    'Policy': 'string'
}

Response Structure

  • (dict) --

    • SinkArn (string) --

      The ARN of the sink.

    • SinkId (string) --

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

    • Policy (string) --

      The policy that you specified.

DeleteSink (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_sink(
    Identifier='string'
)
type Identifier

string

param Identifier

[REQUIRED]

The ARN of the sink to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListSinks (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_sinks(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

Limits the number of returned links to the specified number.

type NextToken

string

param NextToken

The token for the next set of items to return. You received this token from a previous call.

rtype

dict

returns

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Items (list) --

      An array of structures that contain the information about the returned sinks.

      • (dict) --

        A structure that contains information about one of this monitoring account's sinks.

        • 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.

    • NextToken (string) --

      The token to use when requesting the next set of sinks.

TagResource (new) Link ¶

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.

Warning

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.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The ARN of the resource that you're adding tags to.

The ARN format of a sink is ``arn:aws:oam:Region :account-id :sink/sink-id ``

The ARN format of a link is ``arn:aws:oam:Region :account-id :link/link-id ``

For more information about ARN format, see CloudWatch Logs resources and operations .

type Tags

dict

param Tags

[REQUIRED]

The list of key-value pairs to associate with the resource.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UntagResource (new) Link ¶

Removes one or more tags from the specified resource.

Warning

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.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The ARN of the resource that you're removing tags from.

The ARN format of a sink is ``arn:aws:oam:Region :account-id :sink/sink-id ``

The ARN format of a link is ``arn:aws:oam:Region :account-id :link/link-id ``

For more information about ARN format, see CloudWatch Logs resources and operations .

type TagKeys

list

param TagKeys

[REQUIRED]

The list of tag keys to remove from the resource.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The ARN of the resource that you want to view tags for.

The ARN format of a sink is ``arn:aws:oam:Region :account-id :sink/sink-id ``

The ARN format of a link is ``arn:aws:oam:Region :account-id :link/link-id ``

For more information about ARN format, see CloudWatch Logs resources and operations .

Warning

Unlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags for links or sinks you must have the oam:RequestTag permission. The aws:ReguestTag permission does not allow you to tag and untag links and sinks.

rtype

dict

returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Tags (dict) --

      The list of tags associated with the requested resource.>

      • (string) --

        • (string) --

CreateSink (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.create_sink(
    Name='string',
    Tags={
        'string': 'string'
    }
)
type Name

string

param Name

[REQUIRED]

A name for the sink.

type Tags

dict

param Tags

Assigns one or more tags (key-value pairs) to the link.

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.

For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags .

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN of the sink that is newly created.

    • 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) --