CloudWatchObservabilityAccessManager / Client / put_sink_policy

put_sink_policy#

CloudWatchObservabilityAccessManager.Client.put_sink_policy(**kwargs)#

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

  • Application Insights - Applications - Specify with AWS::ApplicationInsights::Application

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

See also: AWS API Documentation

Request Syntax

response = client.put_sink_policy(
    Policy='string',
    SinkIdentifier='string'
)
Parameters:

  • Policy (string) –

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

  • SinkIdentifier (string) –

    [REQUIRED]

    The ARN of the sink to attach this policy to.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Policy (string) –

      The policy that you specified.

    • SinkArn (string) –

      The ARN of the sink.

    • SinkId (string) –

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

Exceptions

  • CloudWatchObservabilityAccessManager.Client.exceptions.InternalServiceFault

  • CloudWatchObservabilityAccessManager.Client.exceptions.MissingRequiredParameterException

  • CloudWatchObservabilityAccessManager.Client.exceptions.InvalidParameterException

  • CloudWatchObservabilityAccessManager.Client.exceptions.ResourceNotFoundException