2023/07/19 - Amazon Managed Grafana - 1 new9 updated api methods
Changes Amazon Managed Grafana now supports grafanaVersion update for existing workspaces with UpdateWorkspaceConfiguration API. DescribeWorkspaceConfiguration API additionally returns grafanaVersion. A new ListVersions API lists available versions or, if given a workspaceId, the versions it can upgrade to.
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally, include a workspace to list the versions to which it can be upgraded.
See also: AWS API Documentation
Request Syntax
client.list_versions(
maxResults=123,
nextToken='string',
workspaceId='string'
)
integer
The maximum number of results to include in the response.
string
The token to use when requesting the next set of results. You receive this token from a previous ListVersions operation.
string
The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for CreateWorkspace.
dict
Response Syntax
{
'grafanaVersions': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
grafanaVersions (list) --
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.
(string) --
nextToken (string) --
The token to use in a subsequent ListVersions operation to return the next set of results.
{'workspace': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
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.
See also: AWS API Documentation
Request Syntax
client.associate_license(
licenseType='ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
workspaceId='string'
)
string
[REQUIRED]
The type of license to associate with the workspace.
string
[REQUIRED]
The ID of the workspace to associate the license with.
dict
Response Syntax
{
'workspace': {
'accountAccessType': 'CURRENT_ACCOUNT'|'ORGANIZATION',
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'dataSources': [
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
'description': 'string',
'endpoint': 'string',
'freeTrialConsumed': True|False,
'freeTrialExpiration': datetime(2015, 1, 1),
'grafanaVersion': 'string',
'id': 'string',
'licenseExpiration': datetime(2015, 1, 1),
'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
'modified': datetime(2015, 1, 1),
'name': 'string',
'networkAccessControl': {
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
'notificationDestinations': [
'SNS',
],
'organizationRoleName': 'string',
'organizationalUnits': [
'string',
],
'permissionType': 'CUSTOMER_MANAGED'|'SERVICE_MANAGED',
'stackSetName': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
},
'vpcConfiguration': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
'workspaceRoleArn': 'string'
}
}
Response Structure
(dict) --
workspace (dict) --
A structure containing data about the workspace.
accountAccessType (string) --
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 (dict) --
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
dataSources (list) --
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.
(string) --
description (string) --
The user-defined description of the workspace.
endpoint (string) --
The URL that users can use to access the Grafana console in the workspace.
freeTrialConsumed (boolean) --
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialExpiration (datetime) --
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
grafanaVersion (string) --
The version of Grafana supported in this workspace.
id (string) --
The unique ID of this workspace.
licenseExpiration (datetime) --
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseType (string) --
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
networkAccessControl (dict) --
The configuration settings for network access to your workspace.
prefixListIds (list) --
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) --
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.
(string) --
notificationDestinations (list) --
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 (string) --
The name of the IAM role that is used to access resources through Organizations.
organizationalUnits (list) --
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 (string) --
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) --
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
status (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
vpcConfiguration (dict) --
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
securityGroupIds (list) --
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) --
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
workspaceRoleArn (string) --
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
{'workspace': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_workspace(
accountAccessType='CURRENT_ACCOUNT'|'ORGANIZATION',
authenticationProviders=[
'AWS_SSO'|'SAML',
],
clientToken='string',
configuration='string',
grafanaVersion='string',
networkAccessControl={
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
organizationRoleName='string',
permissionType='CUSTOMER_MANAGED'|'SERVICE_MANAGED',
stackSetName='string',
tags={
'string': 'string'
},
vpcConfiguration={
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
workspaceDataSources=[
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
workspaceDescription='string',
workspaceName='string',
workspaceNotificationDestinations=[
'SNS',
],
workspaceOrganizationalUnits=[
'string',
],
workspaceRoleArn='string'
)
string
[REQUIRED]
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
[REQUIRED]
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.
(string) --
string
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
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.
string
Specifies the version of Grafana to support in the new workspace.
To get a list of supported version, use the ListVersions operation.
dict
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.
prefixListIds (list) -- [REQUIRED]
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) -- [REQUIRED]
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.
(string) --
string
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
[REQUIRED]
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.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
string
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
dict
The list of tags associated with the workspace.
(string) --
(string) --
dict
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
securityGroupIds (list) -- [REQUIRED]
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) -- [REQUIRED]
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
list
This parameter is for internal use only, and should not be used.
(string) --
string
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}$
string
The name for the workspace. It does not have to be unique.
list
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.
(string) --
list
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) --
string
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.
dict
Response Syntax
{
'workspace': {
'accountAccessType': 'CURRENT_ACCOUNT'|'ORGANIZATION',
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'dataSources': [
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
'description': 'string',
'endpoint': 'string',
'freeTrialConsumed': True|False,
'freeTrialExpiration': datetime(2015, 1, 1),
'grafanaVersion': 'string',
'id': 'string',
'licenseExpiration': datetime(2015, 1, 1),
'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
'modified': datetime(2015, 1, 1),
'name': 'string',
'networkAccessControl': {
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
'notificationDestinations': [
'SNS',
],
'organizationRoleName': 'string',
'organizationalUnits': [
'string',
],
'permissionType': 'CUSTOMER_MANAGED'|'SERVICE_MANAGED',
'stackSetName': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
},
'vpcConfiguration': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
'workspaceRoleArn': 'string'
}
}
Response Structure
(dict) --
workspace (dict) --
A structure containing data about the workspace that was created.
accountAccessType (string) --
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 (dict) --
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
dataSources (list) --
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.
(string) --
description (string) --
The user-defined description of the workspace.
endpoint (string) --
The URL that users can use to access the Grafana console in the workspace.
freeTrialConsumed (boolean) --
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialExpiration (datetime) --
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
grafanaVersion (string) --
The version of Grafana supported in this workspace.
id (string) --
The unique ID of this workspace.
licenseExpiration (datetime) --
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseType (string) --
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
networkAccessControl (dict) --
The configuration settings for network access to your workspace.
prefixListIds (list) --
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) --
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.
(string) --
notificationDestinations (list) --
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 (string) --
The name of the IAM role that is used to access resources through Organizations.
organizationalUnits (list) --
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 (string) --
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) --
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
status (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
vpcConfiguration (dict) --
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
securityGroupIds (list) --
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) --
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
workspaceRoleArn (string) --
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
{'workspace': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
Deletes an Amazon Managed Grafana workspace.
See also: AWS API Documentation
Request Syntax
client.delete_workspace(
workspaceId='string'
)
string
[REQUIRED]
The ID of the workspace to delete.
dict
Response Syntax
{
'workspace': {
'accountAccessType': 'CURRENT_ACCOUNT'|'ORGANIZATION',
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'dataSources': [
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
'description': 'string',
'endpoint': 'string',
'freeTrialConsumed': True|False,
'freeTrialExpiration': datetime(2015, 1, 1),
'grafanaVersion': 'string',
'id': 'string',
'licenseExpiration': datetime(2015, 1, 1),
'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
'modified': datetime(2015, 1, 1),
'name': 'string',
'networkAccessControl': {
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
'notificationDestinations': [
'SNS',
],
'organizationRoleName': 'string',
'organizationalUnits': [
'string',
],
'permissionType': 'CUSTOMER_MANAGED'|'SERVICE_MANAGED',
'stackSetName': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
},
'vpcConfiguration': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
'workspaceRoleArn': 'string'
}
}
Response Structure
(dict) --
workspace (dict) --
A structure containing information about the workspace that was deleted.
accountAccessType (string) --
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 (dict) --
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
dataSources (list) --
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.
(string) --
description (string) --
The user-defined description of the workspace.
endpoint (string) --
The URL that users can use to access the Grafana console in the workspace.
freeTrialConsumed (boolean) --
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialExpiration (datetime) --
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
grafanaVersion (string) --
The version of Grafana supported in this workspace.
id (string) --
The unique ID of this workspace.
licenseExpiration (datetime) --
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseType (string) --
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
networkAccessControl (dict) --
The configuration settings for network access to your workspace.
prefixListIds (list) --
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) --
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.
(string) --
notificationDestinations (list) --
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 (string) --
The name of the IAM role that is used to access resources through Organizations.
organizationalUnits (list) --
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 (string) --
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) --
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
status (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
vpcConfiguration (dict) --
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
securityGroupIds (list) --
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) --
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
workspaceRoleArn (string) --
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
{'workspace': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
Displays information about one Amazon Managed Grafana workspace.
See also: AWS API Documentation
Request Syntax
client.describe_workspace(
workspaceId='string'
)
string
[REQUIRED]
The ID of the workspace to display information about.
dict
Response Syntax
{
'workspace': {
'accountAccessType': 'CURRENT_ACCOUNT'|'ORGANIZATION',
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'dataSources': [
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
'description': 'string',
'endpoint': 'string',
'freeTrialConsumed': True|False,
'freeTrialExpiration': datetime(2015, 1, 1),
'grafanaVersion': 'string',
'id': 'string',
'licenseExpiration': datetime(2015, 1, 1),
'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
'modified': datetime(2015, 1, 1),
'name': 'string',
'networkAccessControl': {
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
'notificationDestinations': [
'SNS',
],
'organizationRoleName': 'string',
'organizationalUnits': [
'string',
],
'permissionType': 'CUSTOMER_MANAGED'|'SERVICE_MANAGED',
'stackSetName': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
},
'vpcConfiguration': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
'workspaceRoleArn': 'string'
}
}
Response Structure
(dict) --
workspace (dict) --
A structure containing information about the workspace.
accountAccessType (string) --
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 (dict) --
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
dataSources (list) --
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.
(string) --
description (string) --
The user-defined description of the workspace.
endpoint (string) --
The URL that users can use to access the Grafana console in the workspace.
freeTrialConsumed (boolean) --
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialExpiration (datetime) --
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
grafanaVersion (string) --
The version of Grafana supported in this workspace.
id (string) --
The unique ID of this workspace.
licenseExpiration (datetime) --
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseType (string) --
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
networkAccessControl (dict) --
The configuration settings for network access to your workspace.
prefixListIds (list) --
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) --
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.
(string) --
notificationDestinations (list) --
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 (string) --
The name of the IAM role that is used to access resources through Organizations.
organizationalUnits (list) --
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 (string) --
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) --
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
status (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
vpcConfiguration (dict) --
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
securityGroupIds (list) --
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) --
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
workspaceRoleArn (string) --
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
{'grafanaVersion': 'string'}
Gets the current configuration string for the given workspace.
See also: AWS API Documentation
Request Syntax
client.describe_workspace_configuration(
workspaceId='string'
)
string
[REQUIRED]
The ID of the workspace to get configuration information for.
dict
Response Syntax
{
'configuration': 'string',
'grafanaVersion': 'string'
}
Response Structure
(dict) --
configuration (string) --
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) --
The supported Grafana version for the workspace.
{'workspace': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
Removes the Grafana Enterprise license from a workspace.
See also: AWS API Documentation
Request Syntax
client.disassociate_license(
licenseType='ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
workspaceId='string'
)
string
[REQUIRED]
The type of license to remove from the workspace.
string
[REQUIRED]
The ID of the workspace to remove the Grafana Enterprise license from.
dict
Response Syntax
{
'workspace': {
'accountAccessType': 'CURRENT_ACCOUNT'|'ORGANIZATION',
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'dataSources': [
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
'description': 'string',
'endpoint': 'string',
'freeTrialConsumed': True|False,
'freeTrialExpiration': datetime(2015, 1, 1),
'grafanaVersion': 'string',
'id': 'string',
'licenseExpiration': datetime(2015, 1, 1),
'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
'modified': datetime(2015, 1, 1),
'name': 'string',
'networkAccessControl': {
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
'notificationDestinations': [
'SNS',
],
'organizationRoleName': 'string',
'organizationalUnits': [
'string',
],
'permissionType': 'CUSTOMER_MANAGED'|'SERVICE_MANAGED',
'stackSetName': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
},
'vpcConfiguration': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
'workspaceRoleArn': 'string'
}
}
Response Structure
(dict) --
workspace (dict) --
A structure containing information about the workspace.
accountAccessType (string) --
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 (dict) --
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
dataSources (list) --
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.
(string) --
description (string) --
The user-defined description of the workspace.
endpoint (string) --
The URL that users can use to access the Grafana console in the workspace.
freeTrialConsumed (boolean) --
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialExpiration (datetime) --
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
grafanaVersion (string) --
The version of Grafana supported in this workspace.
id (string) --
The unique ID of this workspace.
licenseExpiration (datetime) --
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseType (string) --
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
networkAccessControl (dict) --
The configuration settings for network access to your workspace.
prefixListIds (list) --
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) --
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.
(string) --
notificationDestinations (list) --
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 (string) --
The name of the IAM role that is used to access resources through Organizations.
organizationalUnits (list) --
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 (string) --
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) --
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
status (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
vpcConfiguration (dict) --
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
securityGroupIds (list) --
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) --
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
workspaceRoleArn (string) --
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
{'workspaces': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
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.
See also: AWS API Documentation
Request Syntax
client.list_workspaces(
maxResults=123,
nextToken='string'
)
integer
The maximum number of workspaces to include in the results.
string
The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)
dict
Response Syntax
{
'nextToken': 'string',
'workspaces': [
{
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'description': 'string',
'endpoint': 'string',
'grafanaVersion': 'string',
'id': 'string',
'modified': datetime(2015, 1, 1),
'name': 'string',
'notificationDestinations': [
'SNS',
],
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use when requesting the next set of workspaces.
workspaces (list) --
An array of structures that contain some information about the workspaces in the account.
(dict) --
A structure that contains some information about one workspace in the account.
authentication (dict) --
A structure containing information about the authentication methods used in the workspace.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
description (string) --
The customer-entered description of the workspace.
endpoint (string) --
The URL endpoint to use to access the Grafana console in the workspace.
grafanaVersion (string) --
The Grafana version that the workspace is running.
id (string) --
The unique ID of the workspace.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
notificationDestinations (list) --
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 (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
{'workspace': {'status': {'VERSION_UPDATING', 'VERSION_UPDATE_FAILED'}}}
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 Admin and Editor Grafana roles, use UpdatePermissions.
See also: AWS API Documentation
Request Syntax
client.update_workspace(
accountAccessType='CURRENT_ACCOUNT'|'ORGANIZATION',
networkAccessControl={
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
organizationRoleName='string',
permissionType='CUSTOMER_MANAGED'|'SERVICE_MANAGED',
removeNetworkAccessConfiguration=True|False,
removeVpcConfiguration=True|False,
stackSetName='string',
vpcConfiguration={
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
workspaceDataSources=[
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
workspaceDescription='string',
workspaceId='string',
workspaceName='string',
workspaceNotificationDestinations=[
'SNS',
],
workspaceOrganizationalUnits=[
'string',
],
workspaceRoleArn='string'
)
string
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.
dict
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.
prefixListIds (list) -- [REQUIRED]
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) -- [REQUIRED]
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.
(string) --
string
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.
string
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
boolean
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.
boolean
Whether to remove the VPC configuration from the workspace.
Setting this to true and providing a vpcConfiguration to set will return an error.
string
The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
dict
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
securityGroupIds (list) -- [REQUIRED]
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) -- [REQUIRED]
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
list
This parameter is for internal use only, and should not be used.
(string) --
string
A description for the workspace. This is used only to help you identify this workspace.
string
[REQUIRED]
The ID of the workspace to update.
string
A new name for the workspace to update.
list
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.
(string) --
list
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) --
string
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.
dict
Response Syntax
{
'workspace': {
'accountAccessType': 'CURRENT_ACCOUNT'|'ORGANIZATION',
'authentication': {
'providers': [
'AWS_SSO'|'SAML',
],
'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
},
'created': datetime(2015, 1, 1),
'dataSources': [
'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE'|'ATHENA'|'REDSHIFT'|'TWINMAKER',
],
'description': 'string',
'endpoint': 'string',
'freeTrialConsumed': True|False,
'freeTrialExpiration': datetime(2015, 1, 1),
'grafanaVersion': 'string',
'id': 'string',
'licenseExpiration': datetime(2015, 1, 1),
'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
'modified': datetime(2015, 1, 1),
'name': 'string',
'networkAccessControl': {
'prefixListIds': [
'string',
],
'vpceIds': [
'string',
]
},
'notificationDestinations': [
'SNS',
],
'organizationRoleName': 'string',
'organizationalUnits': [
'string',
],
'permissionType': 'CUSTOMER_MANAGED'|'SERVICE_MANAGED',
'stackSetName': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
'tags': {
'string': 'string'
},
'vpcConfiguration': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
},
'workspaceRoleArn': 'string'
}
}
Response Structure
(dict) --
workspace (dict) --
A structure containing data about the workspace that was created.
accountAccessType (string) --
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 (dict) --
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
providers (list) --
Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
(string) --
samlConfigurationStatus (string) --
Specifies whether the workplace's user authentication method is fully configured.
created (datetime) --
The date that the workspace was created.
dataSources (list) --
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.
(string) --
description (string) --
The user-defined description of the workspace.
endpoint (string) --
The URL that users can use to access the Grafana console in the workspace.
freeTrialConsumed (boolean) --
Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
freeTrialExpiration (datetime) --
If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
grafanaVersion (string) --
The version of Grafana supported in this workspace.
id (string) --
The unique ID of this workspace.
licenseExpiration (datetime) --
If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
licenseType (string) --
Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
modified (datetime) --
The most recent date that the workspace was modified.
name (string) --
The name of the workspace.
networkAccessControl (dict) --
The configuration settings for network access to your workspace.
prefixListIds (list) --
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 lists <https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html>`__in the Amazon Virtual Private Cloud User Guide.
(string) --
vpceIds (list) --
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.
(string) --
notificationDestinations (list) --
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 (string) --
The name of the IAM role that is used to access resources through Organizations.
organizationalUnits (list) --
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 (string) --
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) --
The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
status (string) --
The current status of the workspace.
tags (dict) --
The list of tags associated with the workspace.
(string) --
(string) --
vpcConfiguration (dict) --
The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).
securityGroupIds (list) --
The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
subnetIds (list) --
The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
(string) --
workspaceRoleArn (string) --
The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
{'grafanaVersion': 'string'}
Updates the configuration string for the given workspace
See also: AWS API Documentation
Request Syntax
client.update_workspace_configuration(
configuration='string',
grafanaVersion='string',
workspaceId='string'
)
string
[REQUIRED]
The new configuration string for the workspace. For more information about the format and configuration options available, see Working in your Grafana workspace.
string
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.
string
[REQUIRED]
The ID of the workspace to update.
dict
Response Syntax
{}
Response Structure
(dict) --