How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Managed Service for Prometheus Workspaces API

The Workspaces API from Amazon Managed Service for Prometheus — 7 operation(s) for workspaces.

Amazon Managed Service for Prometheus Workspaces API is one of 2 APIs that Amazon Managed Service for Prometheus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, a JSON-LD context, and 2 JSON Schemas.

This API exposes 18 operations across 7 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://aps.{region}.amazonaws.com, https://aps.{region}.amazonaws.com, http://aps.{region}.amazonaws.com.cn, https://aps.{region}.amazonaws.com.cn.

18 operations 7 paths 50 schemas 4 DELETE6 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://aps.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Managed Service for Prometheus Workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 18

Across 7 paths, the API surfaces 18 operations — 4 DELETE, 6 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 18
POST
/workspaces/{workspaceId}/alertmanager/definition
Amazon Managed Service for Prometheus Create Alert Manager Definition
CreateAlertManagerDefinition 8 params body → 202480481482483484485486
DELETE
/workspaces/{workspaceId}/alertmanager/definition
Amazon Managed Service for Prometheus Delete Alert Manager Definition
DeleteAlertManagerDefinition 9 params → 202480481482483484485
GET
/workspaces/{workspaceId}/alertmanager/definition
Amazon Managed Service for Prometheus Describe Alert Manager Definition
DescribeAlertManagerDefinition 8 params → 200480481482483484
PUT
/workspaces/{workspaceId}/alertmanager/definition
Amazon Managed Service for Prometheus Put Alert Manager Definition
PutAlertManagerDefinition 8 params body → 202480481482483484485486
POST
/workspaces/{workspaceId}/logging
Amazon Managed Service for Prometheus Create Logging Configuration
CreateLoggingConfiguration 8 params body → 202480481482483
DELETE
/workspaces/{workspaceId}/logging
Amazon Managed Service for Prometheus Delete Logging Configuration
DeleteLoggingConfiguration 9 params → 202480481482483484
GET
/workspaces/{workspaceId}/logging
Amazon Managed Service for Prometheus Describe Logging Configuration
DescribeLoggingConfiguration 8 params → 200480481482483
PUT
/workspaces/{workspaceId}/logging
Amazon Managed Service for Prometheus Update Logging Configuration
UpdateLoggingConfiguration 8 params body → 202480481482483484
POST
/workspaces/{workspaceId}/rulegroupsnamespaces
Amazon Managed Service for Prometheus Create Rule Groups Namespace
CreateRuleGroupsNamespace 8 params body → 202480481482483484485486
GET
/workspaces/{workspaceId}/rulegroupsnamespaces
Amazon Managed Service for Prometheus List Rule Groups Namespaces
ListRuleGroupsNamespaces 11 params → 200480481482483484
POST
/workspaces
Amazon Managed Service for Prometheus Create Workspace
CreateWorkspace 7 params body → 202480481482483484485
GET
/workspaces
Amazon Managed Service for Prometheus List Workspaces
ListWorkspaces 10 params → 200480481482483
DELETE
/workspaces/{workspaceId}/rulegroupsnamespaces/{name}
Amazon Managed Service for Prometheus Delete Rule Groups Namespace
DeleteRuleGroupsNamespace 10 params → 202480481482483484485
GET
/workspaces/{workspaceId}/rulegroupsnamespaces/{name}
Amazon Managed Service for Prometheus Describe Rule Groups Namespace
DescribeRuleGroupsNamespace 9 params → 200480481482483484
PUT
/workspaces/{workspaceId}/rulegroupsnamespaces/{name}
Amazon Managed Service for Prometheus Put Rule Groups Namespace
PutRuleGroupsNamespace 9 params body → 202480481482483484485486
DELETE
/workspaces/{workspaceId}
Amazon Managed Service for Prometheus Delete Workspace
DeleteWorkspace 9 params → 202480481482483484485
GET
/workspaces/{workspaceId}
Amazon Managed Service for Prometheus Describe Workspace
DescribeWorkspace 8 params → 200480481482483484
POST
/workspaces/{workspaceId}/alias
Amazon Managed Service for Prometheus Update Workspace Alias
UpdateWorkspaceAlias 8 params body → 204480481482483484485486

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are WorkspaceDescription (7 properties), RuleGroupsNamespaceDescription (7 properties), RuleGroupsNamespaceSummary (6 properties), WorkspaceSummary (6 properties). Each schema is shown below with its type and property counts.

ThrottlingException
WorkspaceStatusCode
string
State of a workspace.
WorkspaceSummary
object
Represents a summary of the properties of a workspace.
6 properties 4 required
LogGroupArn
string
ListRuleGroupsNamespacesResponse
object
Represents the output of a ListRuleGroupsNamespaces operation.
2 properties 1 required
RuleGroupsNamespaceStatus
object
Represents the status of a namespace.
2 properties 1 required
WorkspaceDescription
object
Represents the properties of a workspace.
7 properties 4 required
InternalServerException
CreateWorkspaceResponse
object
Represents the output of a CreateWorkspace operation.
4 properties 3 required
AccessDeniedException
LoggingConfigurationStatusCode
string
State of a logging configuration.
ServiceQuotaExceededException
CreateAlertManagerDefinitionResponse
object
Represents the output of a CreateAlertManagerDefinition operation.
1 property 1 required
WorkspaceAlias
string
A user-assigned workspace alias.
RuleGroupsNamespaceDescription
object
Represents a description of the rule groups namespace.
7 properties 6 required
PaginationToken
string
A token used to access the next page in a paginated result set.
ConflictException
CreateLoggingConfigurationResponse
object
Represents the output of a CreateLoggingConfiguration operation.
1 property 1 required
RuleGroupsNamespaceArn
string
An ARN identifying a rule groups namespace.
ValidationException
RuleGroupsNamespaceSummary
object
Represents a summary of the rule groups namespace.
6 properties 5 required
PutRuleGroupsNamespaceResponse
object
Represents the output of a PutRuleGroupsNamespace operation.
4 properties 3 required
CreateRuleGroupsNamespaceResponse
object
Represents the output of a CreateRuleGroupsNamespace operation.
4 properties 3 required
TagValue
string
String
string
RuleGroupsNamespaceStatusCode
string
State of a namespace.
WorkspaceId
string
A workspace ID.
AlertManagerDefinitionDescription
object
Represents the properties of an alert manager definition.
4 properties 4 required
Uri
string
DescribeLoggingConfigurationResponse
object
Represents the output of a DescribeLoggingConfiguration operation.
1 property 1 required
PutAlertManagerDefinitionResponse
object
Represents the output of a PutAlertManagerDefinition operation.
1 property 1 required
RuleGroupsNamespaceSummaryList
array
A list of rule groups namespace summary.
WorkspaceSummaryList
array
A list of workspace summaries.
UpdateLoggingConfigurationResponse
object
Represents the output of an UpdateLoggingConfiguration operation.
1 property 1 required
DescribeWorkspaceResponse
object
Represents the output of a DescribeWorkspace operation.
1 property 1 required
Timestamp
string
WorkspaceStatus
object
Represents the status of a workspace.
1 property 1 required
AlertManagerDefinitionStatus
object
Represents the status of a definition.
2 properties 1 required
WorkspaceArn
string
An ARN identifying a Workspace.
TagMap
object
The list of tags assigned to the resource.
ResourceNotFoundException
LoggingConfigurationMetadata
object
Represents the properties of a logging configuration metadata.
5 properties 5 required
RuleGroupsNamespaceData
string
The rule groups namespace data.
AlertManagerDefinitionStatusCode
string
State of an alert manager definition.
DescribeRuleGroupsNamespaceResponse
object
Represents the output of a DescribeRuleGroupsNamespace operation.
1 property 1 required
DescribeAlertManagerDefinitionResponse
object
Represents the output of a DescribeAlertManagerDefinition operation.
1 property 1 required
ListWorkspacesResponse
object
Represents the output of a ListWorkspaces operation.
2 properties 1 required
RuleGroupsNamespaceName
string
The namespace name that the rule group belong to.
LoggingConfigurationStatus
object
Represents the status of a logging configuration.
2 properties 1 required
AlertManagerDefinitionData
string
The alert manager definition data.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-managed-prometheus-workspaces-api-openapi.yml Raw ↑

Other APIs Amazon Managed Service for Prometheus publishes across the network.

Amazon Managed Service for Prometheus Tags API
Where this information came from

This is an independent, third-party profile of Amazon Managed Service for Prometheus Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.