{ "opencollection": "1.0.0", "info": { "name": "Amazon Managed Grafana Tags Workspaces API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "Amazon Managed Grafana Associate License", "type": "http" }, "http": { "method": "POST", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/licenses/:licenseType", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "licenseType", "value": "", "type": "path", "description": "The type of license to associate with the workspace." }, { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to associate the license with." } ] }, "docs": "Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise." }, { "info": { "name": "Amazon Managed Grafana Disassociate License", "type": "http" }, "http": { "method": "DELETE", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/licenses/:licenseType", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "licenseType", "value": "", "type": "path", "description": "The type of license to remove from the workspace." }, { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to remove the Grafana Enterprise license from." } ] }, "docs": "Removes the Grafana Enterprise license from a workspace." }, { "info": { "name": "Amazon Managed Grafana List Workspaces", "type": "http" }, "http": { "method": "GET", "url": "http://grafana.{region}.amazonaws.com/workspaces", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of workspaces to include in the results." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)" } ] }, "docs": "Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace." }, { "info": { "name": "Amazon Managed Grafana Create Workspace", "type": "http" }, "http": { "method": "POST", "url": "http://grafana.{region}.amazonaws.com/workspaces", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.

" }, { "info": { "name": "Amazon Managed Grafana Create Workspace Api Key", "type": "http" }, "http": { "method": "POST", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/apikeys", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to create an API key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests." }, { "info": { "name": "Amazon Managed Grafana Describe Workspace", "type": "http" }, "http": { "method": "GET", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to display information about." } ] }, "docs": "Displays information about one Amazon Managed Grafana workspace." }, { "info": { "name": "Amazon Managed Grafana Update Workspace", "type": "http" }, "http": { "method": "PUT", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.

To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.

To modify which users in the workspace have the AdminUse this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

Changes to the authentication method for a workspace may take a few minutes to take effect.

" }, { "info": { "name": "Amazon Managed Grafana Describe Workspace Configuration", "type": "http" }, "http": { "method": "GET", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/configuration", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to get configuration information for." } ] }, "docs": "Gets the current configuration string for the given workspace." }, { "info": { "name": "Amazon Managed Grafana Update Workspace Configuration", "type": "http" }, "http": { "method": "PUT", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/configuration", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration string for the given workspace" }, { "info": { "name": "Amazon Managed Grafana List Permissions", "type": "http" }, "http": { "method": "GET", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/permissions", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "query", "description": "(Optional) Limits the results to only the group that matches this ID." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to include in the response." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation." }, { "name": "userId", "value": "", "type": "query", "description": "(Optional) Limits the results to only the user that matches this ID." }, { "name": "userType", "value": "", "type": "query", "description": "(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned." }, { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to list permissions for. This parameter is required." } ] }, "docs": "Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId." }, { "info": { "name": "Amazon Managed Grafana Update Permissions", "type": "http" }, "http": { "method": "PATCH", "url": "http://grafana.{region}.amazonaws.com/workspaces/:workspaceId/permissions", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The ID of the workspace to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates which users in a workspace have the Grafana Admin or Editor roles." } ] } ], "bundled": true }