Amazon Managed Grafana Workspaces API is one of 3 APIs that Amazon Managed Grafana 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
15 operations
across 8 paths,
and defines 93 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://grafana.{region}.amazonaws.com, https://grafana.{region}.amazonaws.com, http://grafana.{region}.amazonaws.com.cn, https://grafana.{region}.amazonaws.com.cn.
15 operations8 paths93 schemas3 DELETE5 GET1 PATCH4 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Amazon Managed Grafana 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 15
Across 8 paths, the API surfaces 15 operations — 3 DELETE, 5 GET, 1 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are WorkspaceDescription (24 properties), WorkspaceSummary (11 properties), AssertionAttributes (6 properties), SamlConfiguration (5 properties). Each schema is shown below with its type and property counts.
String
string
ValidationException
ServiceQuotaExceededException
ApiKeyName
string
User
object
A structure that specifies one user or group in the workspace.
2 properties2 required
Description
string
AllowedOrganizations
array
UpdateErrorList
array
OrganizationalUnit
string
RoleValue
string
Boolean
boolean
IamRoleArn
string
RoleValueList
array
PermissionType
string
Endpoint
string
SubnetIds
array
AssertionAttributes
object
A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspa…
6 properties
ConflictException
AccountAccessType
string
LoginValidityDuration
integer
WorkspaceSummary
object
A structure that contains some information about one workspace in the account.
11 properties7 required
UpdateWorkspaceConfigurationResponse
object
SubnetId
string
StackSetName
string
PrefixListId
string
SSOClientId
string
AuthenticationProviders
array
DataSourceTypesList
array
CreateWorkspaceResponse
object
1 property1 required
NotificationDestinationType
string
AwsSsoAuthentication
object
A structure containing information about how this workspace works with IAM Identity Center.
1 property
AccessDeniedException
Timestamp
string
AssertionAttribute
string
Role
string
PermissionEntryList
array
UpdateWorkspaceAuthenticationResponse
object
1 property1 required
VpcConfiguration
object
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. Provided securityGroupIds and subnetIds must…
2 properties2 required
TagValue
string
AssociateLicenseResponse
object
1 property1 required
DataSourceType
string
UserType
string
ThrottlingException
TagMap
object
ListPermissionsResponse
object
2 properties1 required
DescribeWorkspaceResponse
object
1 property1 required
SamlConfiguration
object
A structure containing information about how this workspace works with SAML.
5 properties1 required
CreateWorkspaceApiKeyResponse
object
3 properties3 required
UserList
array
InternalServerException
NotificationDestinationsList
array
AuthenticationSummary
object
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication, and whether that authentication is fu…
2 properties1 required
NetworkAccessConfiguration
object
The configuration settings for in-bound network access to your workspace. When this is configured, only listed IP addresses and VPC endpoints will be able to a…
2 properties2 required
PrefixListIds
array
VpceIds
array
ApiKeyToken
string
SamlConfigurationStatus
string
PaginationToken
string
VpceId
string
SsoId
string
SecurityGroupIds
array
DeleteWorkspaceApiKeyResponse
object
2 properties2 required
GrafanaVersion
string
DescribeWorkspaceConfigurationResponse
object
2 properties1 required
UpdateWorkspaceResponse
object
1 property1 required
UpdateError
object
A structure containing information about one error encountered while performing an UpdatePermissions operation.
3 properties3 required
AllowedOrganization
string
WorkspaceDescription
object
A structure containing information about an Amazon Managed Grafana workspace in your account.
24 properties8 required
OrganizationalUnitList
array
DeleteWorkspaceResponse
object
1 property1 required
WorkspaceName
string
UpdateErrorCodeInteger
integer
PermissionEntry
object
A structure containing the identity of one user or group and the Admin , Editor , or Viewer role that they have.
2 properties2 required
DescribeWorkspaceAuthenticationResponse
object
1 property1 required
AuthenticationDescription
object
A structure containing information about the user authentication methods used by the workspace.
3 properties1 required
WorkspaceStatus
string
OverridableConfigurationJson
string
IdpMetadataUrl
string
OrganizationRoleName
string
UpdatePermissionsResponse
object
1 property1 required
WorkspaceId
string
ListWorkspacesResponse
object
2 properties1 required
IdpMetadata
object
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by…
2 properties
RoleValues
object
This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace. SAML authe…
2 properties
SecurityGroupId
string
WorkspaceList
array
SamlAuthentication
object
A structure containing information about how this workspace works with SAML.
2 properties1 required
LicenseType
string
UpdateInstruction
object
Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.
3 properties3 required
DisassociateLicenseResponse
object
1 property1 required
ResourceNotFoundException
UpdateAction
string
AuthenticationProviderTypes
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Amazon Managed Grafana 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.
