Amazon Managed Service for Prometheus Managed Prometheus Policy API
The Managed Prometheus Policy API from Amazon Managed Service for Prometheus — 1 operation(s) for managed prometheus policy.
The Managed Prometheus Policy API from Amazon Managed Service for Prometheus — 1 operation(s) for managed prometheus policy.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-managed-prometheus:amazon-managed-prometheus-policy-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon Prometheus Service Policy API
version: '2020-08-01'
description: Generated from AWS's published Smithy model for Amazon Prometheus Service. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://aps.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Policy
paths:
/workspaces/{workspaceId}/policy:
put:
operationId: PutResourcePolicy
summary: Put Resource Policy
description: Creates or updates a resource-based policy for an Amazon Managed Service for Prometheus workspace. Use resource-based policies to grant permissions to other AWS accounts or services to access your workspace. Only Prometheus-compatible APIs can be used for workspace sharing. You can add non-Prometheus-compatible APIs to the policy, but they will be ignored. For more information, see Prometheus-compatible APIs in the Amazon Managed Service for Prometheus User Guide. If your workspace uses customer-managed KMS keys for encryption, you must grant the principals in your resource-based policy access to those KMS keys. You can do this by creating KMS grants. For more information, see CreateGrant in the AWS Key Management Service API Reference and Encryption at rest in the Amazon Managed Service for Prometheus User Guide. For more information about working with IAM, see Using Amazon Managed Service for Prometheus with IAM in the Amazon Managed Service for Prometheus User Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyRequest'
tags:
- Policy
get:
operationId: DescribeResourcePolicy
summary: Describe Resource Policy
description: Returns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeResourcePolicyResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeResourcePolicyRequest'
tags:
- Policy
delete:
operationId: DeleteResourcePolicy
summary: Delete Resource Policy
description: Deletes the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResourcePolicyRequest'
tags:
- Policy
components:
schemas:
DeleteResourcePolicyRequest:
type: object
properties:
workspaceId:
type: string
description: The ID of the workspace from which to delete the resource-based policy.
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the request is safe to retry (idempotent).
revisionId:
type: string
description: The revision ID of the policy to delete. Use this parameter to ensure that you are deleting the correct version of the policy.
required:
- workspaceId
ValidationException:
type: object
properties:
message:
type: string
description: Description of the error.
reason:
type: string
description: Reason the request failed validation.
fieldList:
type: array
items:
$ref: '#/components/schemas/ValidationExceptionField'
description: The field that caused the error, if applicable.
required:
- message
- reason
InternalServerException:
type: object
properties:
message:
type: string
description: Description of the error.
retryAfterSeconds:
type: integer
description: Advice to clients on when the call can be safely retried.
required:
- message
DescribeResourcePolicyRequest:
type: object
properties:
workspaceId:
type: string
description: The ID of the workspace to describe the resource-based policy for.
required:
- workspaceId
ValidationExceptionField:
type: object
properties:
name:
type: string
description: The name of the field that caused an exception.
message:
type: string
description: A message describing why the field caused an exception.
required:
- name
- message
ThrottlingException:
type: object
properties:
message:
type: string
description: Description of the error.
serviceCode:
type: string
description: Service quotas code for the originating service.
quotaCode:
type: string
description: Service quotas code for the originating quota.
retryAfterSeconds:
type: integer
description: Advice to clients on when the call can be safely retried.
required:
- message
ConflictException:
type: object
properties:
message:
type: string
description: Description of the error.
resourceId:
type: string
description: Identifier of the resource affected.
resourceType:
type: string
description: Type of the resource affected.
required:
- message
- resourceId
- resourceType
PutResourcePolicyRequest:
type: object
properties:
workspaceId:
type: string
description: The ID of the workspace to attach the resource-based policy to.
policyDocument:
type: string
description: The JSON policy document to use as the resource-based policy. This policy defines the permissions that other AWS accounts or services have to access your workspace.
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the request is safe to retry (idempotent).
revisionId:
type: string
description: The revision ID of the policy to update. Use this parameter to ensure that you are updating the correct version of the policy. If you don't specify a revision ID, the policy is updated regardless of its current revision. For the first PUT request on a workspace that doesn't have an existing resource policy, you can specify NO_POLICY as the revision ID.
required:
- workspaceId
- policyDocument
AccessDeniedException:
type: object
properties:
message:
type: string
description: Description of the error.
required:
- message
PutResourcePolicyResponse:
type: object
properties:
policyStatus:
type: string
description: The current status of the resource-based policy.
revisionId:
type: string
description: The revision ID of the newly created or updated resource-based policy.
required:
- policyStatus
- revisionId
ResourceNotFoundException:
type: object
properties:
message:
type: string
description: Description of the error.
resourceId:
type: string
description: Identifier of the resource affected.
resourceType:
type: string
description: Type of the resource affected.
required:
- message
- resourceId
- resourceType
DescribeResourcePolicyResponse:
type: object
properties:
policyDocument:
type: string
description: The JSON policy document for the resource-based policy attached to the workspace.
policyStatus:
type: string
description: The current status of the resource-based policy.
revisionId:
type: string
description: The revision ID of the current resource-based policy.
required:
- policyDocument
- policyStatus
- revisionId
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: aps
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amp/service/2020-08-01/amp-2020-08-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)