Amazon Managed Grafana

2021/10/07 - Amazon Managed Grafana - 11 new api methods

Changes  Initial release of the SDK for Amazon Managed Grafana API.

UpdatePermissions (new) Link ¶

Updates which users in a workspace have the Grafana Admin or Editor roles.

See also: AWS API Documentation

Request Syntax

client.update_permissions(
    updateInstructionBatch=[
        {
            'action': 'ADD'|'REVOKE',
            'role': 'ADMIN'|'EDITOR',
            'users': [
                {
                    'id': 'string',
                    'type': 'SSO_USER'|'SSO_GROUP'
                },
            ]
        },
    ],
    workspaceId='string'
)
type updateInstructionBatch

list

param updateInstructionBatch

[REQUIRED]

An array of structures that contain the permission updates to make.

  • (dict) --

    Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.

    • action (string) -- [REQUIRED]

      Specifies whether this update is to add or revoke role permissions.

    • role (string) -- [REQUIRED]

      The role to add or revoke for the user or the group specified in users .

    • users (list) -- [REQUIRED]

      A structure that specifies the user or group to add or revoke the role for.

      • (dict) --

        A structure that specifies one user or group in the workspace.

        • id (string) -- [REQUIRED]

          The ID of the user or group.

        • type (string) -- [REQUIRED]

          Specifies whether this is a single user or a group.

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to update.

rtype

dict

returns

Response Syntax

{
    'errors': [
        {
            'causedBy': {
                'action': 'ADD'|'REVOKE',
                'role': 'ADMIN'|'EDITOR',
                'users': [
                    {
                        'id': 'string',
                        'type': 'SSO_USER'|'SSO_GROUP'
                    },
                ]
            },
            'code': 123,
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      An array of structures that contain the errors from the operation, if any.

      • (dict) --

        A structure containing information about one error encountered while performing an UpdatePermissions operation.

        • causedBy (dict) --

          Specifies which permission update caused the error.

          • action (string) --

            Specifies whether this update is to add or revoke role permissions.

          • role (string) --

            The role to add or revoke for the user or the group specified in users .

          • users (list) --

            A structure that specifies the user or group to add or revoke the role for.

            • (dict) --

              A structure that specifies one user or group in the workspace.

              • id (string) --

                The ID of the user or group.

              • type (string) --

                Specifies whether this is a single user or a group.

        • code (integer) --

          The error code.

        • message (string) --

          The message for this error.

DescribeWorkspace (new) Link ¶

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',
        ],
        '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',
        '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, Amazon Web Services SSO, or both methods for user authentication.

        • providers (list) --

          Specifies whether the workspace uses SAML, Amazon Web Services SSO, 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.

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

DescribeWorkspaceAuthentication (new) Link ¶

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

See also: AWS API Documentation

Request Syntax

client.describe_workspace_authentication(
    workspaceId='string'
)
type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to return authentication information about.

rtype

dict

returns

Response Syntax

{
    'authentication': {
        'awsSso': {
            'ssoClientId': 'string'
        },
        'providers': [
            'AWS_SSO'|'SAML',
        ],
        'saml': {
            'configuration': {
                'allowedOrganizations': [
                    'string',
                ],
                'assertionAttributes': {
                    'email': 'string',
                    'groups': 'string',
                    'login': 'string',
                    'name': 'string',
                    'org': 'string',
                    'role': 'string'
                },
                'idpMetadata': {
                    'url': 'string',
                    'xml': 'string'
                },
                'loginValidityDuration': 123,
                'roleValues': {
                    'admin': [
                        'string',
                    ],
                    'editor': [
                        'string',
                    ]
                }
            },
            'status': 'CONFIGURED'|'NOT_CONFIGURED'
        }
    }
}

Response Structure

  • (dict) --

    • authentication (dict) --

      A structure containing information about the authentication methods used in the workspace.

      • awsSso (dict) --

        A structure containing information about how this workspace works with Amazon Web Services SSO.

        • ssoClientId (string) --

          The ID of the Amazon Web Services SSO-managed application that is created by Amazon Managed Grafana.

      • providers (list) --

        Specifies whether this workspace uses Amazon Web Services SSO, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

        • (string) --

      • saml (dict) --

        A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

        • configuration (dict) --

          A structure containing details about how this workspace works with SAML.

          • allowedOrganizations (list) --

            Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

            • (string) --

          • assertionAttributes (dict) --

            A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

            • email (string) --

              The name of the attribute within the SAML assertion to use as the email names for SAML users.

            • groups (string) --

              The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.

            • login (string) --

              The name of the attribute within the SAML assertion to use as the login names for SAML users.

            • name (string) --

              The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.

            • org (string) --

              The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.

            • role (string) --

              The name of the attribute within the SAML assertion to use as the user roles.

          • idpMetadata (dict) --

            A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

            • url (string) --

              The URL of the location containing the metadata.

            • xml (string) --

              The actual full metadata file, in XML format.

          • loginValidityDuration (integer) --

            How long a sign-on session by a SAML user is valid, before the user has to sign on again.

          • roleValues (dict) --

            A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

            • admin (list) --

              A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

              • (string) --

            • editor (list) --

              A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

              • (string) --

        • status (string) --

          Specifies whether the workspace's SAML configuration is complete.

AssociateLicense (new) Link ¶

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',
        ],
        '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',
        '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, Amazon Web Services SSO, or both methods for user authentication.

        • providers (list) --

          Specifies whether the workspace uses SAML, Amazon Web Services SSO, 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.

      • 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 (new) Link ¶

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',
    organizationRoleName='string',
    permissionType='CUSTOMER_MANAGED'|'SERVICE_MANAGED',
    stackSetName='string',
    workspaceDataSources=[
        'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE',
    ],
    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, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .

  • (string) --

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 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 , Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

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

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

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

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

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',
        ],
        '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',
        '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, Amazon Web Services SSO, or both methods for user authentication.

        • providers (list) --

          Specifies whether the workspace uses SAML, Amazon Web Services SSO, 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.

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

ListPermissions (new) Link ¶

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId , the operation returns the roles of all users and groups. If you specify a userId or a groupId , only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId .

See also: AWS API Documentation

Request Syntax

client.list_permissions(
    groupId='string',
    maxResults=123,
    nextToken='string',
    userId='string',
    userType='SSO_USER'|'SSO_GROUP',
    workspaceId='string'
)
type groupId

string

param groupId

(Optional) Limits the results to only the group that matches this ID.

type maxResults

integer

param maxResults

The maximum number of results to include in the response.

type nextToken

string

param nextToken

The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

type userId

string

param userId

(Optional) Limits the results to only the user that matches this ID.

type userType

string

param userType

(Optional) If you specify SSO_USER , then only the permissions of Amazon Web Services SSO users are returned. If you specify SSO_GROUP , only the permissions of Amazon Web Services SSO groups are returned.

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to list permissions for. This parameter is required.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'permissions': [
        {
            'role': 'ADMIN'|'EDITOR',
            'user': {
                'id': 'string',
                'type': 'SSO_USER'|'SSO_GROUP'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token to use in a subsequent ListPermissions operation to return the next set of results.

    • permissions (list) --

      The permissions returned by the operation.

      • (dict) --

        A structure containing the identity of one user or group and the Admin or Editor role that they have.

        • role (string) --

          Specifies whether the user or group has the Admin or Editor role.

        • user (dict) --

          A structure with the ID of the user or group with this role.

          • id (string) --

            The ID of the user or group.

          • type (string) --

            Specifies whether this is a single user or a group.

DeleteWorkspace (new) Link ¶

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',
        ],
        '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',
        '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, Amazon Web Services SSO, or both methods for user authentication.

        • providers (list) --

          Specifies whether the workspace uses SAML, Amazon Web Services SSO, 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.

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

UpdateWorkspaceAuthentication (new) Link ¶

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

See also: AWS API Documentation

Request Syntax

client.update_workspace_authentication(
    authenticationProviders=[
        'AWS_SSO'|'SAML',
    ],
    samlConfiguration={
        'allowedOrganizations': [
            'string',
        ],
        'assertionAttributes': {
            'email': 'string',
            'groups': 'string',
            'login': 'string',
            'name': 'string',
            'org': 'string',
            'role': 'string'
        },
        'idpMetadata': {
            'url': 'string',
            'xml': 'string'
        },
        'loginValidityDuration': 123,
        'roleValues': {
            'admin': [
                'string',
            ],
            'editor': [
                'string',
            ]
        }
    },
    workspaceId='string'
)
type authenticationProviders

list

param authenticationProviders

[REQUIRED]

Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .

  • (string) --

type samlConfiguration

dict

param samlConfiguration

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

  • allowedOrganizations (list) --

    Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

    • (string) --

  • assertionAttributes (dict) --

    A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

    • email (string) --

      The name of the attribute within the SAML assertion to use as the email names for SAML users.

    • groups (string) --

      The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.

    • login (string) --

      The name of the attribute within the SAML assertion to use as the login names for SAML users.

    • name (string) --

      The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.

    • org (string) --

      The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.

    • role (string) --

      The name of the attribute within the SAML assertion to use as the user roles.

  • idpMetadata (dict) -- [REQUIRED]

    A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

    • url (string) --

      The URL of the location containing the metadata.

    • xml (string) --

      The actual full metadata file, in XML format.

  • loginValidityDuration (integer) --

    How long a sign-on session by a SAML user is valid, before the user has to sign on again.

  • roleValues (dict) --

    A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

    • admin (list) --

      A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

      • (string) --

    • editor (list) --

      A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

      • (string) --

type workspaceId

string

param workspaceId

[REQUIRED]

The ID of the workspace to update the authentication for.

rtype

dict

returns

Response Syntax

{
    'authentication': {
        'awsSso': {
            'ssoClientId': 'string'
        },
        'providers': [
            'AWS_SSO'|'SAML',
        ],
        'saml': {
            'configuration': {
                'allowedOrganizations': [
                    'string',
                ],
                'assertionAttributes': {
                    'email': 'string',
                    'groups': 'string',
                    'login': 'string',
                    'name': 'string',
                    'org': 'string',
                    'role': 'string'
                },
                'idpMetadata': {
                    'url': 'string',
                    'xml': 'string'
                },
                'loginValidityDuration': 123,
                'roleValues': {
                    'admin': [
                        'string',
                    ],
                    'editor': [
                        'string',
                    ]
                }
            },
            'status': 'CONFIGURED'|'NOT_CONFIGURED'
        }
    }
}

Response Structure

  • (dict) --

    • authentication (dict) --

      A structure that describes the user authentication for this workspace after the update is made.

      • awsSso (dict) --

        A structure containing information about how this workspace works with Amazon Web Services SSO.

        • ssoClientId (string) --

          The ID of the Amazon Web Services SSO-managed application that is created by Amazon Managed Grafana.

      • providers (list) --

        Specifies whether this workspace uses Amazon Web Services SSO, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

        • (string) --

      • saml (dict) --

        A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

        • configuration (dict) --

          A structure containing details about how this workspace works with SAML.

          • allowedOrganizations (list) --

            Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

            • (string) --

          • assertionAttributes (dict) --

            A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

            • email (string) --

              The name of the attribute within the SAML assertion to use as the email names for SAML users.

            • groups (string) --

              The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.

            • login (string) --

              The name of the attribute within the SAML assertion to use as the login names for SAML users.

            • name (string) --

              The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.

            • org (string) --

              The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.

            • role (string) --

              The name of the attribute within the SAML assertion to use as the user roles.

          • idpMetadata (dict) --

            A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

            • url (string) --

              The URL of the location containing the metadata.

            • xml (string) --

              The actual full metadata file, in XML format.

          • loginValidityDuration (integer) --

            How long a sign-on session by a SAML user is valid, before the user has to sign on again.

          • roleValues (dict) --

            A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

            • admin (list) --

              A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

              • (string) --

            • editor (list) --

              A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

              • (string) --

        • status (string) --

          Specifies whether the workspace's SAML configuration is complete.

DisassociateLicense (new) Link ¶

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',
        ],
        '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',
        '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, Amazon Web Services SSO, or both methods for user authentication.

        • providers (list) --

          Specifies whether the workspace uses SAML, Amazon Web Services SSO, 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.

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

ListWorkspaces (new) Link ¶

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

integer

param maxResults

The maximum number of workspaces to include in the results.

type nextToken

string

param nextToken

The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)

rtype

dict

returns

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'
        },
    ]
}

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, Amazon Web Services SSO, 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.

UpdateWorkspace (new) Link ¶

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 Amazon Web Services SSO, 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',
    stackSetName='string',
    workspaceDataSources=[
        'AMAZON_OPENSEARCH_SERVICE'|'CLOUDWATCH'|'PROMETHEUS'|'XRAY'|'TIMESTREAM'|'SITEWISE',
    ],
    workspaceDescription='string',
    workspaceId='string',
    workspaceName='string',
    workspaceNotificationDestinations=[
        'SNS',
    ],
    workspaceOrganizationalUnits=[
        'string',
    ],
    workspaceRoleArn='string'
)
type accountAccessType

string

param accountAccessType

Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION , you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

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 stackSetName

string

param stackSetName

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

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

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

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',
        ],
        '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',
        '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, Amazon Web Services SSO, or both methods for user authentication.

        • providers (list) --

          Specifies whether the workspace uses SAML, Amazon Web Services SSO, 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.

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