{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-managed-grafana/refs/heads/main/json-schema/amazon-managed-grafana-update-workspace-request-schema.json",
"title": "UpdateWorkspaceRequest",
"description": "UpdateWorkspaceRequest schema from Amazon Managed Grafana API",
"type": "object",
"properties": {
"accountAccessType": {
"allOf": [
{
"$ref": "#/components/schemas/AccountAccessType"
},
{
"description": "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": {
"allOf": [
{
"$ref": "#/components/schemas/NetworkAccessConfiguration"
},
{
"description": "
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": { "allOf": [ { "$ref": "#/components/schemas/OrganizationRoleName" }, { "description": "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 thepermissionType set to CUSTOMER_MANAGED."
}
]
},
"permissionType": {
"allOf": [
{
"$ref": "#/components/schemas/PermissionType"
},
{
"description": "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.
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.
Whether to remove the VPC configuration from the workspace.
Setting this to true and providing a vpcConfiguration to set will return an error.
permissionType CUSTOMER_MANAGED, then this role is required."
}
]
}
}
}