The type of license to associate with the workspace.

The ID of the workspace to associate the license with.

The response's http status code.

A structure containing data about the workspace.

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.

The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

The list of tags associated with the workspace.

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.

A description for the workspace. This is used only to help you identify this workspace.

Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

The name for the workspace. It does not have to be unique.

Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to CUSTOMER_MANAGED.

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

If you specify SERVICE_MANAGED on AWS Grafana console, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels. In the CLI mode, the permissionType SERVICE_MANAGED will not create the IAM role for you. The ability for the Amazon Managed Grafana to create the IAM role on behalf of the user is supported only in the Amazon Managed Grafana AWS console. Use only the CUSTOMER_MANAGED permission type when creating a workspace in the CLI.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.

The response's http status code.

A structure containing data about the workspace that was created.

Specifies the name of the key. Keynames must be unique to the workspace.

Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

The ID of the workspace to create an API key.

The response's http status code.

The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.

The name of the key that was created.

The ID of the workspace that the key is valid for.

The ID of the workspace to delete.

The response's http status code.

A structure containing information about the workspace that was deleted.

The name of the API key to delete.

The ID of the workspace to delete.

The response's http status code.

The name of the key that was deleted.

The ID of the workspace where the key was deleted.

The ID of the workspace to display information about.

The response's http status code.

A structure containing information about the workspace.

The ID of the workspace to return authentication information about.

The response's http status code.

A structure containing information about the authentication methods used in the workspace.

The ID of the workspace to get configuration information for.

The response's http status code.

The configuration string for the workspace that you requested. For more information about the format and configuration options available, see Working in your Grafana workspace.

The type of license to remove from the workspace.

The ID of the workspace to remove the Grafana Enterprise license from.

The response's http status code.

A structure containing information about the workspace.

(Optional) Limits the results to only the group that matches this ID.

The maximum number of results to include in the response.

The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

(Optional) Limits the results to only the user that matches this ID.

(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.

The ID of the workspace to list permissions for. This parameter is required.

The token to use in a subsequent ListPermissions operation to return the next set of results.

The response's http status code.

The permissions returned by the operation.

The ARN of the resource the list of tags are associated with.

The list of tags that are associated with the resource.

The response's http status code.

The maximum number of workspaces to include in the results.

The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)

The token to use when requesting the next set of workspaces.

The response's http status code.

An array of structures that contain some information about the workspaces in the account.

The ARN of the resource the tag is associated with.

The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags.

The response's http status code.

The ARN of the resource the tag association is removed from.

The key values of the tag to be removed from the resource.

The response's http status code.

An array of structures that contain the permission updates to make.

The ID of the workspace to update.

The response's http status code.

An array of structures that contain the errors from the operation, if any.

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

The name of an IAM role that already exists to use to access resources through Organizations.

If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

Whether to remove the VPC configuration from the workspace.

Setting this to true and providing a vpcConfiguration to set will return an error.

The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.

If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.

A description for the workspace. This is used only to help you identify this workspace.

A new name for the workspace to update.

Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.

The ID of the workspace to update.

The response's http status code.

A structure containing data about the workspace that was created.

If the workspace uses SAML, use this structure to 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.

Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

The ID of the workspace to update the authentication for.

The response's http status code.

A structure that describes the user authentication for this workspace after the update is made.

The new configuration string for the workspace. For more information about the format and configuration options available, see Working in your Grafana workspace.

The ID of the workspace to update.

The response's http status code.

The name of the attribute within the SAML assertion to use as the email names for SAML users.

The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.

The name of the attribute within the SAML assertion to use as the login names for SAML users.

The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.

The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.

The name of the attribute within the SAML assertion to use as the user roles.

A structure containing information about how this workspace works with IAM Identity Center.

A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

Specifies whether the workplace's user authentication method is fully configured.

Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.

The URL of the location containing the IdP metadata.

The full IdP metadata, in XML format.

Specifies whether the user or group has the Admin, Editor, or Viewer role.

A structure with the ID of the user or group with this role.

A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

A structure containing details about how this workspace works with SAML.

Specifies whether the workspace's SAML configuration is complete.

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

Specifies which permission update caused the error.

The error code.

The message for this error.

Specifies whether this update is to add or revoke role permissions.

The role to add or revoke for the user or the group specified in users.

A structure that specifies the user or group to add or revoke the role for.

The ID of the user or group.

Pattern: ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

Specifies whether this is a single user or a group.

The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.

The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.

The user-defined description of the workspace.

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.

Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.

The name of the workspace.

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

The name of the IAM role that is used to access resources through Organizations.

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

If this is Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

If this is CUSTOMER_MANAGED, you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

The list of tags associated with the workspace.

The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

The date that the workspace was created.

Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

The URL that users can use to access the Grafana console in the workspace.

The version of Grafana supported in this workspace.

The unique ID of this workspace.

The most recent date that the workspace was modified.

The current status of the workspace.

The customer-entered description of the workspace.

The name of the workspace.

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

The list of tags associated with the workspace.

A structure containing information about the authentication methods used in the workspace.

The date that the workspace was created.

The URL endpoint to use to access the Grafana console in the workspace.

The Grafana version that the workspace is running.

The unique ID of the workspace.

The most recent date that the workspace was modified.

The current status of the workspace.