Serialized Form (AWS Java SDK for Amazon Managed Grafana 1.12.558 API)

Package com.amazonaws.services.managedgrafana.model
- Class com.amazonaws.services.managedgrafana.model.AccessDeniedException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.managedgrafana.model.AmazonManagedGrafanaException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.managedgrafana.model.AssertionAttributes extends Object implements Serializable
  - Serialized Fields
    - email
```
String email
```
      The name of the attribute within the SAML assertion to use as the email names for SAML users.
    - groups
```
String groups
```
      The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
    - login
```
String login
```
      The name of the attribute within the SAML assertion to use as the login names for SAML users.
    - name
```
String name
```
      The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
    - org
```
String org
```
      The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
    - role
```
String role
```
      The name of the attribute within the SAML assertion to use as the user roles.
- Class com.amazonaws.services.managedgrafana.model.AssociateLicenseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - licenseType
```
String licenseType
```
      The type of license to associate with the workspace.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to associate the license with.
- Class com.amazonaws.services.managedgrafana.model.AssociateLicenseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workspace
```
WorkspaceDescription workspace
```
      A structure containing data about the workspace.
- Class com.amazonaws.services.managedgrafana.model.AuthenticationDescription extends Object implements Serializable
  - Serialized Fields
    - awsSso
```
AwsSsoAuthentication awsSso
```
      A structure containing information about how this workspace works with IAM Identity Center.
    - providers
```
List<E> providers
```
      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.
    - saml
```
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.
- Class com.amazonaws.services.managedgrafana.model.AuthenticationSummary extends Object implements Serializable
  - Serialized Fields
    - providers
```
List<E> providers
```
      Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
    - samlConfigurationStatus
```
String samlConfigurationStatus
```
      Specifies whether the workplace's user authentication method is fully configured.
- Class com.amazonaws.services.managedgrafana.model.AwsSsoAuthentication extends Object implements Serializable
  - Serialized Fields
    - ssoClientId
```
String ssoClientId
```
      The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
- Class com.amazonaws.services.managedgrafana.model.ConflictException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The ID of the resource that is associated with the error.
    - resourceType
```
String resourceType
```
      The type of the resource that is associated with the error.
- Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      Specifies the name of the key. Keynames must be unique to the workspace.
    - keyRole
```
String keyRole
```
      Specifies the permission level of the key.
      
      Valid values: VIEWER|EDITOR|ADMIN
    - secondsToLive
```
Integer secondsToLive
```
      Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to create an API key.
- Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.
    - keyName
```
String keyName
```
      The name of the key that was created.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace that the key is valid for.
- Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountAccessType
```
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.
    - authenticationProviders
```
List<E> authenticationProviders
```
      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.
    - clientToken
```
String clientToken
```
      A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
    - configuration
```
String configuration
```
      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.
    - grafanaVersion
```
String grafanaVersion
```
      Specifies the version of Grafana to support in the new workspace.
      
      To get a list of supported version, use the ListVersions operation.
    - networkAccessControl
```
NetworkAccessConfiguration networkAccessControl
```
      Configuration for network access to your workspace.
      
      When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
      
      If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
    - organizationRoleName
```
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.
    - permissionType
```
String permissionType
```
      When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
      
      You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.
      
      The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.
      
      Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.
      
      For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
    - stackSetName
```
String stackSetName
```
      The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    - tags
```
Map<K,V> tags
```
      The list of tags associated with the workspace.
    - vpcConfiguration
```
VpcConfiguration vpcConfiguration
```
      The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
      
      Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
    - workspaceDataSources
```
List<E> workspaceDataSources
```
      This parameter is for internal use only, and should not be used.
    - workspaceDescription
```
String workspaceDescription
```
      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}$
    - workspaceName
```
String workspaceName
```
      The name for the workspace. It does not have to be unique.
    - workspaceNotificationDestinations
```
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.
    - workspaceOrganizationalUnits
```
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.
    - workspaceRoleArn
```
String workspaceRoleArn
```
      Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
- Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workspace
```
WorkspaceDescription workspace
```
      A structure containing data about the workspace that was created.
- Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      The name of the API key to delete.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to delete.
- Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      The name of the key that was deleted.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace where the key was deleted.
- Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to delete.
- Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workspace
```
WorkspaceDescription workspace
```
      A structure containing information about the workspace that was deleted.
- Class com.amazonaws.services.managedgrafana.model.DescribeWorkspaceAuthenticationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to return authentication information about.
- Class com.amazonaws.services.managedgrafana.model.DescribeWorkspaceAuthenticationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - authentication
```
AuthenticationDescription authentication
```
      A structure containing information about the authentication methods used in the workspace.
- Class com.amazonaws.services.managedgrafana.model.DescribeWorkspaceConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to get configuration information for.
- Class com.amazonaws.services.managedgrafana.model.DescribeWorkspaceConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - configuration
```
String configuration
```
      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.
    - grafanaVersion
```
String grafanaVersion
```
      The supported Grafana version for the workspace.
- Class com.amazonaws.services.managedgrafana.model.DescribeWorkspaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to display information about.
- Class com.amazonaws.services.managedgrafana.model.DescribeWorkspaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workspace
```
WorkspaceDescription workspace
```
      A structure containing information about the workspace.
- Class com.amazonaws.services.managedgrafana.model.DisassociateLicenseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - licenseType
```
String licenseType
```
      The type of license to remove from the workspace.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to remove the Grafana Enterprise license from.
- Class com.amazonaws.services.managedgrafana.model.DisassociateLicenseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workspace
```
WorkspaceDescription workspace
```
      A structure containing information about the workspace.
- Class com.amazonaws.services.managedgrafana.model.IdpMetadata extends Object implements Serializable
  - Serialized Fields
    - url
```
String url
```
      The URL of the location containing the IdP metadata.
    - xml
```
String xml
```
      The full IdP metadata, in XML format.
- Class com.amazonaws.services.managedgrafana.model.InternalServerException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
Integer retryAfterSeconds
```
      How long to wait before you retry this operation.
- Class com.amazonaws.services.managedgrafana.model.ListPermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      (Optional) Limits the results to only the group that matches this ID.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response.
    - nextToken
```
String nextToken
```
      The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.
    - userId
```
String userId
```
      (Optional) Limits the results to only the user that matches this ID.
    - userType
```
String userType
```
      (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.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to list permissions for. This parameter is required.
- Class com.amazonaws.services.managedgrafana.model.ListPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token to use in a subsequent ListPermissions operation to return the next set of results.
    - permissions
```
List<E> permissions
```
      The permissions returned by the operation.
- Class com.amazonaws.services.managedgrafana.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource the list of tags are associated with.
- Class com.amazonaws.services.managedgrafana.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      The list of tags that are associated with the resource.
- Class com.amazonaws.services.managedgrafana.model.ListVersionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response.
    - nextToken
```
String nextToken
```
      The token to use when requesting the next set of results. You receive this token from a previous ListVersions operation.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for CreateWorkspace.
- Class com.amazonaws.services.managedgrafana.model.ListVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - grafanaVersions
```
List<E> grafanaVersions
```
      The Grafana versions available to create. If a workspace ID is included in the request, the Grafana versions to which this workspace can be upgraded.
    - nextToken
```
String nextToken
```
      The token to use in a subsequent ListVersions operation to return the next set of results.
- Class com.amazonaws.services.managedgrafana.model.ListWorkspacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of workspaces to include in the results.
    - nextToken
```
String nextToken
```
      The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)
- Class com.amazonaws.services.managedgrafana.model.ListWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token to use when requesting the next set of workspaces.
    - workspaces
```
List<E> workspaces
```
      An array of structures that contain some information about the workspaces in the account.
- Class com.amazonaws.services.managedgrafana.model.NetworkAccessConfiguration extends Object implements Serializable
  - Serialized Fields
    - prefixListIds
```
List<E> prefixListIds
```
      An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.
      
      Prefix list IDs have the format pl-1a2b3c4d .
      
      For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.
    - vpceIds
```
List<E> vpceIds
```
      An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.
      
      VPC endpoint IDs have the format vpce-1a2b3c4d .
      
      For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.
      
      The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
- Class com.amazonaws.services.managedgrafana.model.PermissionEntry extends Object implements Serializable
  - Serialized Fields
    - role
```
String role
```
      Specifies whether the user or group has the Admin, Editor, or Viewer role.
    - user
```
User user
```
      A structure with the ID of the user or group with this role.
- Class com.amazonaws.services.managedgrafana.model.ResourceNotFoundException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The ID of the resource that is associated with the error.
    - resourceType
```
String resourceType
```
      The type of the resource that is associated with the error.
- Class com.amazonaws.services.managedgrafana.model.RoleValues extends Object implements Serializable
  - Serialized Fields
    - admin
```
List<E> admin
```
      A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
    - editor
```
List<E> editor
```
      A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
- Class com.amazonaws.services.managedgrafana.model.SamlAuthentication extends Object implements Serializable
  - Serialized Fields
    - configuration
```
SamlConfiguration configuration
```
      A structure containing details about how this workspace works with SAML.
    - status
```
String status
```
      Specifies whether the workspace's SAML configuration is complete.
- Class com.amazonaws.services.managedgrafana.model.SamlConfiguration extends Object implements Serializable
  - Serialized Fields
    - allowedOrganizations
```
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 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 idpMetadata
```
      A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
    - loginValidityDuration
```
Integer loginValidityDuration
```
      How long a sign-on session by a SAML user is valid, before the user has to sign on again.
    - roleValues
```
RoleValues roleValues
```
      A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
- Class com.amazonaws.services.managedgrafana.model.ServiceQuotaExceededException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - quotaCode
```
String quotaCode
```
      The ID of the service quota that was exceeded.
    - resourceId
```
String resourceId
```
      The ID of the resource that is associated with the error.
    - resourceType
```
String resourceType
```
      The type of the resource that is associated with the error.
    - serviceCode
```
String serviceCode
```
      The value of a parameter in the request caused an error.
- Class com.amazonaws.services.managedgrafana.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource the tag is associated with.
    - tags
```
Map<K,V> tags
```
      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.
- Class com.amazonaws.services.managedgrafana.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.managedgrafana.model.ThrottlingException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - quotaCode
```
String quotaCode
```
      The ID of the service quota that was exceeded.
    - retryAfterSeconds
```
Integer retryAfterSeconds
```
      The value of a parameter in the request caused an error.
    - serviceCode
```
String serviceCode
```
      The ID of the service that is associated with the error.
- Class com.amazonaws.services.managedgrafana.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource the tag association is removed from.
    - tagKeys
```
List<E> tagKeys
```
      The key values of the tag to be removed from the resource.
- Class com.amazonaws.services.managedgrafana.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.managedgrafana.model.UpdateError extends Object implements Serializable
  - Serialized Fields
    - causedBy
```
UpdateInstruction causedBy
```
      Specifies which permission update caused the error.
    - code
```
Integer code
```
      The error code.
    - message
```
String message
```
      The message for this error.
- Class com.amazonaws.services.managedgrafana.model.UpdateInstruction extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      Specifies whether this update is to add or revoke role permissions.
    - role
```
String role
```
      The role to add or revoke for the user or the group specified in users.
    - users
```
List<E> users
```
      A structure that specifies the user or group to add or revoke the role for.
- Class com.amazonaws.services.managedgrafana.model.UpdatePermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - updateInstructionBatch
```
List<E> updateInstructionBatch
```
      An array of structures that contain the permission updates to make.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to update.
- Class com.amazonaws.services.managedgrafana.model.UpdatePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - errors
```
List<E> errors
```
      An array of structures that contain the errors from the operation, if any.
- Class com.amazonaws.services.managedgrafana.model.UpdateWorkspaceAuthenticationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - authenticationProviders
```
List<E> authenticationProviders
```
      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.
    - samlConfiguration
```
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.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to update the authentication for.
- Class com.amazonaws.services.managedgrafana.model.UpdateWorkspaceAuthenticationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - authentication
```
AuthenticationDescription authentication
```
      A structure that describes the user authentication for this workspace after the update is made.
- Class com.amazonaws.services.managedgrafana.model.UpdateWorkspaceConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configuration
```
String configuration
```
      The new configuration string for the workspace. For more information about the format and configuration options available, see Working in your Grafana workspace.
    - grafanaVersion
```
String grafanaVersion
```
      Specifies the version of Grafana to support in the new workspace.
      
      Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).
      
      To know what versions are available to upgrade to for a specific workspace, see the ListVersions operation.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to update.
- Class com.amazonaws.services.managedgrafana.model.UpdateWorkspaceConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.managedgrafana.model.UpdateWorkspaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountAccessType
```
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.
    - networkAccessControl
```
NetworkAccessConfiguration networkAccessControl
```
      The configuration settings for network access to your workspace.
      
      When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
      
      If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
    - organizationRoleName
```
String organizationRoleName
```
      The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.
    - permissionType
```
String permissionType
```
      Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services 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.
      
      If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.
      
      For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
      
      Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED.
      
      You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.
    - removeNetworkAccessConfiguration
```
Boolean removeNetworkAccessConfiguration
```
      Whether to remove the network access configuration from the workspace.
      
      Setting this to true and providing a networkAccessControl to set will return an error.
      
      If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
    - removeVpcConfiguration
```
Boolean removeVpcConfiguration
```
      Whether to remove the VPC configuration from the workspace.
      
      Setting this to true and providing a vpcConfiguration to set will return an error.
    - stackSetName
```
String stackSetName
```
      The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
    - vpcConfiguration
```
VpcConfiguration vpcConfiguration
```
      The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
    - workspaceDataSources
```
List<E> workspaceDataSources
```
      This parameter is for internal use only, and should not be used.
    - workspaceDescription
```
String workspaceDescription
```
      A description for the workspace. This is used only to help you identify this workspace.
    - workspaceId
```
String workspaceId
```
      The ID of the workspace to update.
    - workspaceName
```
String workspaceName
```
      A new name for the workspace to update.
    - workspaceNotificationDestinations
```
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.
    - workspaceOrganizationalUnits
```
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.
    - workspaceRoleArn
```
String workspaceRoleArn
```
      Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.
- Class com.amazonaws.services.managedgrafana.model.UpdateWorkspaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workspace
```
WorkspaceDescription workspace
```
      A structure containing data about the workspace that was created.
- Class com.amazonaws.services.managedgrafana.model.User extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      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}$
    - type
```
String type
```
      Specifies whether this is a single user or a group.
- Class com.amazonaws.services.managedgrafana.model.ValidationException extends AmazonManagedGrafanaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fieldList
```
List<E> fieldList
```
      A list of fields that might be associated with the error.
    - reason
```
String reason
```
      The reason that the operation failed.
- Class com.amazonaws.services.managedgrafana.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A message describing why this field couldn't be validated.
    - name
```
String name
```
      The name of the field that caused the validation error.
- Class com.amazonaws.services.managedgrafana.model.VpcConfiguration extends Object implements Serializable
  - Serialized Fields
    - securityGroupIds
```
List<E> securityGroupIds
```
      The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
    - subnetIds
```
List<E> subnetIds
```
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
- Class com.amazonaws.services.managedgrafana.model.WorkspaceDescription extends Object implements Serializable
  - Serialized Fields
    - accountAccessType
```
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.
    - authentication
```
AuthenticationSummary authentication
```
      A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
    - created
```
Date created
```
      The date that the workspace was created.
    - dataSources
```
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.
      
      This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.
    - description
```
String description
```
      The user-defined description of the workspace.
    - endpoint
```
String endpoint
```
      The URL that users can use to access the Grafana console in the workspace.
    - freeTrialConsumed
```
Boolean freeTrialConsumed
```
      Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
    - freeTrialExpiration
```
Date freeTrialExpiration
```
      If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
    - grafanaVersion
```
String grafanaVersion
```
      The version of Grafana supported in this workspace.
    - id
```
String id
```
      The unique ID of this workspace.
    - licenseExpiration
```
Date licenseExpiration
```
      If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
    - licenseType
```
String licenseType
```
      Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
    - modified
```
Date modified
```
      The most recent date that the workspace was modified.
    - name
```
String name
```
      The name of the workspace.
    - networkAccessControl
```
NetworkAccessConfiguration networkAccessControl
```
      The configuration settings for network access to your workspace.
    - notificationDestinations
```
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.
    - organizationRoleName
```
String organizationRoleName
```
      The name of the IAM role that is used to access resources through Organizations.
    - organizationalUnits
```
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.
    - permissionType
```
String permissionType
```
      If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then 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 must manage those roles and permissions yourself.
      
      If you are working with a 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, this parameter must be set to CUSTOMER_MANAGED.
      
      For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
    - stackSetName
```
String stackSetName
```
      The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
    - status
```
String status
```
      The current status of the workspace.
    - tags
```
Map<K,V> tags
```
      The list of tags associated with the workspace.
    - vpcConfiguration
```
VpcConfiguration vpcConfiguration
```
      The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
    - workspaceRoleArn
```
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.
- Class com.amazonaws.services.managedgrafana.model.WorkspaceSummary extends Object implements Serializable
  - Serialized Fields
    - authentication
```
AuthenticationSummary authentication
```
      A structure containing information about the authentication methods used in the workspace.
    - created
```
Date created
```
      The date that the workspace was created.
    - description
```
String description
```
      The customer-entered description of the workspace.
    - endpoint
```
String endpoint
```
      The URL endpoint to use to access the Grafana console in the workspace.
    - grafanaVersion
```
String grafanaVersion
```
      The Grafana version that the workspace is running.
    - id
```
String id
```
      The unique ID of the workspace.
    - modified
```
Date modified
```
      The most recent date that the workspace was modified.
    - name
```
String name
```
      The name of the workspace.
    - notificationDestinations
```
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.
    - status
```
String status
```
      The current status of the workspace.
    - tags
```
Map<K,V> tags
```
      The list of tags associated with the workspace.

Serialized Form

Package com.amazonaws.services.managedgrafana.model

Class com.amazonaws.services.managedgrafana.model.AccessDeniedException extends AmazonManagedGrafanaException implements Serializable

Class com.amazonaws.services.managedgrafana.model.AmazonManagedGrafanaException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.managedgrafana.model.AssertionAttributes extends Object implements Serializable

Serialized Fields

email

groups

login

name

org

role

Class com.amazonaws.services.managedgrafana.model.AssociateLicenseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

licenseType

workspaceId

Class com.amazonaws.services.managedgrafana.model.AssociateLicenseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

workspace

Class com.amazonaws.services.managedgrafana.model.AuthenticationDescription extends Object implements Serializable

Serialized Fields

awsSso

providers

saml

Class com.amazonaws.services.managedgrafana.model.AuthenticationSummary extends Object implements Serializable

Serialized Fields

providers

samlConfigurationStatus

Class com.amazonaws.services.managedgrafana.model.AwsSsoAuthentication extends Object implements Serializable

Serialized Fields

ssoClientId

Class com.amazonaws.services.managedgrafana.model.ConflictException extends AmazonManagedGrafanaException implements Serializable

Serialized Fields

resourceId

resourceType

Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceApiKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

keyRole

secondsToLive

workspaceId

Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

key

keyName

workspaceId

Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountAccessType

authenticationProviders

clientToken

configuration

grafanaVersion

networkAccessControl

organizationRoleName

permissionType

stackSetName

tags

vpcConfiguration

workspaceDataSources

workspaceDescription

workspaceName

workspaceNotificationDestinations

workspaceOrganizationalUnits

workspaceRoleArn

Class com.amazonaws.services.managedgrafana.model.CreateWorkspaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

workspace

Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceApiKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

workspaceId

Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

keyName

workspaceId

Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

workspaceId

Class com.amazonaws.services.managedgrafana.model.DeleteWorkspaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable