AWS API Changes

2022/11/23 - Amazon Managed Grafana - 2 new 6 updated api methods

Changes This release includes support for configuring a Grafana workspace to connect to a datasource within a VPC as well as new APIs for configuring Grafana settings.

UpdateWorkspaceConfiguration (new)

Link ¶

Updates the configuration string for the given workspace

See also: AWS API Documentation

Request Syntax

client.update_workspace_configuration(
    configuration='string',
    workspaceId='string'
)

type configuration

string

param configuration

[REQUIRED]

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

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to update.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeWorkspaceConfiguration (new)

Link ¶

Gets the current configuration string for the given workspace.

See also: AWS API Documentation

Request Syntax

client.describe_workspace_configuration(
    workspaceId='string'
)

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to get configuration information for.

rtype

dict

returns

Response Syntax

{
    'configuration': '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 .

AssociateLicense (updated)

Link ¶
Changes (response)

{'workspace': {'dataSources': {'TWINMAKER'},
               'vpcConfiguration': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string']}}}

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'
)

type licenseType

string

param licenseType

[REQUIRED]

The type of license to associate with the workspace.

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to associate the license with.

rtype

dict

returns

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',
        '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',
        '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.
    - (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.
  - 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED , you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED .
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
  - 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.
      - (string) --
    - subnetIds (list) --
      
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
      - (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.

CreateWorkspace (updated)

Link ¶
Changes (request, response)
Request

{'configuration': 'string',
 'vpcConfiguration': {'securityGroupIds': ['string'], 'subnetIds': ['string']},
 'workspaceDataSources': {'TWINMAKER'}}

Response

{'workspace': {'dataSources': {'TWINMAKER'},
               'vpcConfiguration': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string']}}}

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',
    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'
)

type accountAccessType

string

param accountAccessType

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

type authenticationProviders

list

param authenticationProviders

[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) --

type clientToken

string

param clientToken

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

This field is autopopulated if not provided.

type configuration

string

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

type organizationRoleName

string

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

type permissionType

string

param permissionType

[REQUIRED]

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

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

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

type stackSetName

string

param stackSetName

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

type tags

dict

param tags

The list of tags associated with the workspace.

(string) --
- (string) --

type vpcConfiguration

dict

param vpcConfiguration

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.
- (string) --
subnetIds (list) -- [REQUIRED]

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

type workspaceDataSources

list

param workspaceDataSources

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

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

(string) --

type workspaceDescription

string

param 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}$

type workspaceName

string

param workspaceName

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

type workspaceNotificationDestinations

list

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

(string) --

type workspaceOrganizationalUnits

list

param workspaceOrganizationalUnits

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

(string) --

type workspaceRoleArn

string

param workspaceRoleArn

rtype

dict

returns

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',
        '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',
        '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.
    - (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.
  - 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED , you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED .
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
  - 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.
      - (string) --
    - subnetIds (list) --
      
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
      - (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.

DeleteWorkspace (updated)

Link ¶
Changes (response)

{'workspace': {'dataSources': {'TWINMAKER'},
               'vpcConfiguration': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string']}}}

Deletes an Amazon Managed Grafana workspace.

See also: AWS API Documentation

Request Syntax

client.delete_workspace(
    workspaceId='string'
)

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to delete.

rtype

dict

returns

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',
        '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',
        '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.
    - (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.
  - 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED , you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED .
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
  - 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.
      - (string) --
    - subnetIds (list) --
      
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
      - (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.

DescribeWorkspace (updated)

Link ¶
Changes (response)

{'workspace': {'dataSources': {'TWINMAKER'},
               'vpcConfiguration': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string']}}}

Displays information about one Amazon Managed Grafana workspace.

See also: AWS API Documentation

Request Syntax

client.describe_workspace(
    workspaceId='string'
)

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to display information about.

rtype

dict

returns

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',
        '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',
        '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.
    - (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.
  - 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED , you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED .
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
  - 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.
      - (string) --
    - subnetIds (list) --
      
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
      - (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.

DisassociateLicense (updated)

Link ¶
Changes (response)

{'workspace': {'dataSources': {'TWINMAKER'},
               'vpcConfiguration': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string']}}}

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'
)

type licenseType

string

param licenseType

[REQUIRED]

The type of license to remove from the workspace.

type workspaceId

string

param workspaceId

[REQUIRED]

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

rtype

dict

returns

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',
        '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',
        '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.
    - (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.
  - 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED , you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED .
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
  - 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.
      - (string) --
    - subnetIds (list) --
      
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
      - (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.

UpdateWorkspace (updated)

Link ¶
Changes (request, response)
Request

{'removeVpcConfiguration': 'boolean',
 'vpcConfiguration': {'securityGroupIds': ['string'], 'subnetIds': ['string']},
 'workspaceDataSources': {'TWINMAKER'}}

Response

{'workspace': {'dataSources': {'TWINMAKER'},
               'vpcConfiguration': {'securityGroupIds': ['string'],
                                    'subnetIds': ['string']}}}

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',
    organizationRoleName='string',
    permissionType='CUSTOMER_MANAGED'|'SERVICE_MANAGED',
    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'
)

type accountAccessType

string

param accountAccessType

type organizationRoleName

string

param organizationRoleName

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

type permissionType

string

param permissionType

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

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

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

type removeVpcConfiguration

boolean

param removeVpcConfiguration

Whether to remove the VPC configuration from the workspace.

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

type stackSetName

string

param stackSetName

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

type vpcConfiguration

dict

param vpcConfiguration

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.
- (string) --
subnetIds (list) -- [REQUIRED]

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

type workspaceDataSources

list

param workspaceDataSources

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

(string) --

type workspaceDescription

string

param workspaceDescription

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

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to update.

type workspaceName

string

param workspaceName

A new name for the workspace to update.

type workspaceNotificationDestinations

list

param workspaceNotificationDestinations

(string) --

type workspaceOrganizationalUnits

list

param workspaceOrganizationalUnits

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

(string) --

type workspaceRoleArn

string

param workspaceRoleArn

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

rtype

dict

returns

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',
        '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',
        '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.
    - (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.
  - 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
    
    If this is CUSTOMER_MANAGED , you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED .
    
    For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
  - 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.
      - (string) --
    - subnetIds (list) --
      
      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
      - (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.