String email
The name of the attribute within the SAML assertion to use as the email names for SAML users.
String groups
The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
String login
The name of the attribute within the SAML assertion to use as the login names for SAML users.
String name
The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
String org
The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
String role
The name of the attribute within the SAML assertion to use as the user roles.
WorkspaceDescription workspace
A structure containing data about the workspace.
AwsSsoAuthentication awsSso
A structure containing information about how this workspace works with Amazon Web Services SSO.
List<E> providers
Specifies whether this workspace uses Amazon Web Services SSO, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
SamlAuthentication saml
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.
String ssoClientId
The ID of the Amazon Web Services SSO-managed application that is created by Amazon Managed Grafana.
String accountAccessType
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.
List<E> authenticationProviders
Specifies whether this workspace uses SAML 2.0, Amazon Web Services 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.
String clientToken
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
String organizationRoleName
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.
String permissionType
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 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
String stackSetName
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
List<E> workspaceDataSources
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.
String workspaceDescription
A description for the workspace. This is used only to help you identify this workspace.
String workspaceName
The name for the workspace. It does not have to be unique.
List<E> workspaceNotificationDestinations
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.
List<E> workspaceOrganizationalUnits
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.
String workspaceRoleArn
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.
WorkspaceDescription workspace
A structure containing data about the workspace that was created.
String workspaceId
The ID of the workspace to delete.
WorkspaceDescription workspace
A structure containing information about the workspace that was deleted.
String workspaceId
The ID of the workspace to return authentication information about.
AuthenticationDescription authentication
A structure containing information about the authentication methods used in the workspace.
String workspaceId
The ID of the workspace to display information about.
WorkspaceDescription workspace
A structure containing information about the workspace.
WorkspaceDescription workspace
A structure containing information about the workspace.
Integer retryAfterSeconds
How long to wait before you retry this operation.
String groupId
(Optional) Limits the results to only the group that matches this ID.
Integer maxResults
The maximum number of results to include in the response.
String nextToken
The token to use when requesting the next set of results. You received this token from a previous
ListPermissions operation.
String userId
(Optional) Limits the results to only the user that matches this ID.
String userType
(Optional) If you specify SSO_USER, then only the permissions of Amazon Web Services SSO users are
returned. If you specify SSO_GROUP, only the permissions of Amazon Web Services SSO groups are
returned.
String workspaceId
The ID of the workspace to list permissions for. This parameter is required.
SamlConfiguration configuration
A structure containing details about how this workspace works with SAML.
String status
Specifies whether the workspace's SAML configuration is complete.
List<E> allowedOrganizations
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.
AssertionAttributes assertionAttributes
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.
IdpMetadata idpMetadata
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
Integer loginValidityDuration
How long a sign-on session by a SAML user is valid, before the user has to sign on again.
RoleValues roleValues
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and
Editor roles in the workspace.
String quotaCode
The ID of the service quota that was exceeded.
String resourceId
The ID of the resource that is associated with the error.
String resourceType
The type of the resource that is associated with the error.
String serviceCode
The value of a parameter in the request caused an error.
UpdateInstruction causedBy
Specifies which permission update caused the error.
Integer code
The error code.
String message
The message for this error.
List<E> authenticationProviders
Specifies whether this workspace uses SAML 2.0, Amazon Web Services 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.
SamlConfiguration samlConfiguration
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.
String workspaceId
The ID of the workspace to update the authentication for.
AuthenticationDescription authentication
A structure that describes the user authentication for this workspace after the update is made.
String accountAccessType
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.
String organizationRoleName
The name of an IAM role that already exists to use to access resources through Organizations.
String permissionType
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
String stackSetName
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
List<E> workspaceDataSources
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.
String workspaceDescription
A description for the workspace. This is used only to help you identify this workspace.
String workspaceId
The ID of the workspace to update.
String workspaceName
A new name for the workspace to update.
List<E> workspaceNotificationDestinations
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.
List<E> workspaceOrganizationalUnits
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.
String workspaceRoleArn
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.
WorkspaceDescription workspace
A structure containing data about the workspace that was created.
String accountAccessType
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.
AuthenticationSummary authentication
A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
Date created
The date that the workspace was created.
List<E> dataSources
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.
String description
The user-defined description of the workspace.
String endpoint
The URL that users can use to access the Grafana console in the workspace.
Boolean freeTrialConsumed
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
Date freeTrialExpiration
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
String grafanaVersion
The version of Grafana supported in this workspace.
String id
The unique ID of this workspace.
Date licenseExpiration
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
String licenseType
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
Date modified
The most recent date that the workspace was modified.
String name
The name of the workspace.
List<E> notificationDestinations
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.
String organizationRoleName
The name of the IAM role that is used to access resources through Organizations.
List<E> organizationalUnits
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.
String permissionType
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
String stackSetName
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
String status
The current status of the workspace.
String workspaceRoleArn
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
AuthenticationSummary authentication
A structure containing information about the authentication methods used in the workspace.
Date created
The date that the workspace was created.
String description
The customer-entered description of the workspace.
String endpoint
The URL endpoint to use to access the Grafana console in the workspace.
String grafanaVersion
The Grafana version that the workspace is running.
String id
The unique ID of the workspace.
Date modified
The most recent date that the workspace was modified.
String name
The name of the workspace.
List<E> notificationDestinations
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.
String status
The current status of the workspace.
Copyright © 2022. All rights reserved.