PrometheusService / Client / describe_resource_policy

describe_resource_policy

PrometheusService.Client.describe_resource_policy(**kwargs)

Returns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.

See also: AWS API Documentation

Request Syntax

response = client.describe_resource_policy(
    workspaceId='string'
)
Parameters:

workspaceId (string) –

[REQUIRED]

The ID of the workspace to describe the resource-based policy for.

Return type:

dict

Returns:

Response Syntax

{
    'policyDocument': 'string',
    'policyStatus': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
    'revisionId': 'string'
}

Response Structure

  • (dict) –

    • policyDocument (string) –

      The JSON policy document for the resource-based policy attached to the workspace.

    • policyStatus (string) –

      The current status of the resource-based policy.

    • revisionId (string) –

      The revision ID of the current resource-based policy.

Exceptions