Class: AWS.Grafana

var params = {
  accountAccessType: CURRENT_ACCOUNT | ORGANIZATION, /* required */
  authenticationProviders: [ /* required */
    AWS_SSO | SAML,
    /* more items */
  ],
  permissionType: CUSTOMER_MANAGED | SERVICE_MANAGED, /* required */
  clientToken: 'STRING_VALUE',
  configuration: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
  grafanaVersion: 'STRING_VALUE',
  networkAccessControl: {
    prefixListIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    vpceIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  organizationRoleName: 'STRING_VALUE',
  stackSetName: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  vpcConfiguration: {
    securityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  workspaceDataSources: [
    AMAZON_OPENSEARCH_SERVICE | CLOUDWATCH | PROMETHEUS | XRAY | TIMESTREAM | SITEWISE | ATHENA | REDSHIFT | TWINMAKER,
    /* more items */
  ],
  workspaceDescription: 'STRING_VALUE',
  workspaceName: 'STRING_VALUE',
  workspaceNotificationDestinations: [
    SNS,
    /* more items */
  ],
  workspaceOrganizationalUnits: [
    'STRING_VALUE',
    /* more items */
  ],
  workspaceRoleArn: 'STRING_VALUE'
};
grafana.createWorkspace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

    Possible values include:
    • "CURRENT_ACCOUNT"
    • "ORGANIZATION"
  • authenticationProviders — (Array<String>)

    Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

  • clientToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • configuration — (String)

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

  • grafanaVersion — (String)

    Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 9.4).

    To get a list of supported versions, use the ListVersions operation.

  • networkAccessControl — (map)

    Configuration for network access to your workspace.

    When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

    If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

    • prefixListIds — required — (Array<String>)

      An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

      Prefix list IDs have the format pl-1a2b3c4d .

      For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

    • vpceIds — required — (Array<String>)

      An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

      VPC endpoint IDs have the format vpce-1a2b3c4d .

      For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

      Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
  • organizationRoleName — (String)

    The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.

  • permissionType — (String)

    When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

    You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels.

    The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED.

    Note: Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.

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

    Possible values include:
    • "CUSTOMER_MANAGED"
    • "SERVICE_MANAGED"
  • stackSetName — (String)

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

  • tags — (map<String>)

    The list of tags associated with the workspace.

  • vpcConfiguration — (map)

    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

    Note: Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
    • securityGroupIds — required — (Array<String>)

      The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

    • subnetIds — required — (Array<String>)

      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

  • workspaceDataSources — (Array<String>)

    This parameter is for internal use only, and should not be used.

  • workspaceDescription — (String)

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

    Pattern: ^[\p{L}\p{Z}\p{N}\p{P}]{0,2048}$

  • workspaceName — (String)

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

  • workspaceNotificationDestinations — (Array<String>)

    Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

  • workspaceOrganizationalUnits — (Array<String>)

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

  • workspaceRoleArn — (String)

    Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workspace — (map)

      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.

        Possible values include:
        • "CURRENT_ACCOUNT"
        • "ORGANIZATION"
      • authentication — required — (map)

        A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • providers — required — (Array<String>)

          Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • samlConfigurationStatus — (String)

          Specifies whether the workplace's user authentication method is fully configured.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"
      • created — required — (Date)

        The date that the workspace was created.

      • dataSources — required — (Array<String>)

        Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

        This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      • description — (String)

        The user-defined description of the workspace.

      • endpoint — required — (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.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • freeTrialExpiration — (Date)

        If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • grafanaToken — (String)

        The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

      • grafanaVersion — required — (String)

        The version of Grafana supported in this workspace.

      • id — required — (String)

        The unique ID of this workspace.

      • licenseExpiration — (Date)

        If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

      • licenseType — (String)

        Specifies whether this workspace has a full Grafana Enterprise license.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
        Possible values include:
        • "ENTERPRISE"
        • "ENTERPRISE_FREE_TRIAL"
      • modified — required — (Date)

        The most recent date that the workspace was modified.

      • name — (String)

        The name of the workspace.

      • networkAccessControl — (map)

        The configuration settings for network access to your workspace.

        • prefixListIds — required — (Array<String>)

          An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

          Prefix list IDs have the format pl-1a2b3c4d .

          For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

        • vpceIds — required — (Array<String>)

          An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

          VPC endpoint IDs have the format vpce-1a2b3c4d .

          For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

          Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
      • notificationDestinations — (Array<String>)

        The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

      • organizationRoleName — (String)

        The name of the IAM role that is used to access resources through Organizations.

      • organizationalUnits — (Array<String>)

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

      • permissionType — (String)

        If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

        If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

        If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

        For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "SERVICE_MANAGED"
      • stackSetName — (String)

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

      • status — required — (String)

        The current status of the workspace.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "UPGRADING"
        • "DELETION_FAILED"
        • "CREATION_FAILED"
        • "UPDATE_FAILED"
        • "UPGRADE_FAILED"
        • "LICENSE_REMOVAL_FAILED"
        • "VERSION_UPDATING"
        • "VERSION_UPDATE_FAILED"
      • tags — (map<String>)

        The list of tags associated with the workspace.

      • vpcConfiguration — (map)

        The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

        • securityGroupIds — required — (Array<String>)

          The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

        • subnetIds — required — (Array<String>)

          The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  keyName: 'STRING_VALUE', /* required */
  keyRole: 'STRING_VALUE', /* required */
  secondsToLive: 'NUMBER_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.createWorkspaceApiKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • keyName — (String)

    Specifies the name of the key. Keynames must be unique to the workspace.

  • keyRole — (String)

    Specifies the permission level of the key.

    Valid values: VIEWER|EDITOR|ADMIN

  • secondsToLive — (Integer)

    Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

  • workspaceId — (String)

    The ID of the workspace to create an API key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • key — (String)

      The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.

    • keyName — (String)

      The name of the key that was created.

    • workspaceId — (String)

      The ID of the workspace that the key is valid for.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.deleteWorkspace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workspaceId — (String)

    The ID of the workspace to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workspace — (map)

      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.

        Possible values include:
        • "CURRENT_ACCOUNT"
        • "ORGANIZATION"
      • authentication — required — (map)

        A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • providers — required — (Array<String>)

          Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • samlConfigurationStatus — (String)

          Specifies whether the workplace's user authentication method is fully configured.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"
      • created — required — (Date)

        The date that the workspace was created.

      • dataSources — required — (Array<String>)

        Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

        This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      • description — (String)

        The user-defined description of the workspace.

      • endpoint — required — (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.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • freeTrialExpiration — (Date)

        If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • grafanaToken — (String)

        The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

      • grafanaVersion — required — (String)

        The version of Grafana supported in this workspace.

      • id — required — (String)

        The unique ID of this workspace.

      • licenseExpiration — (Date)

        If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

      • licenseType — (String)

        Specifies whether this workspace has a full Grafana Enterprise license.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
        Possible values include:
        • "ENTERPRISE"
        • "ENTERPRISE_FREE_TRIAL"
      • modified — required — (Date)

        The most recent date that the workspace was modified.

      • name — (String)

        The name of the workspace.

      • networkAccessControl — (map)

        The configuration settings for network access to your workspace.

        • prefixListIds — required — (Array<String>)

          An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

          Prefix list IDs have the format pl-1a2b3c4d .

          For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

        • vpceIds — required — (Array<String>)

          An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

          VPC endpoint IDs have the format vpce-1a2b3c4d .

          For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

          Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
      • notificationDestinations — (Array<String>)

        The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

      • organizationRoleName — (String)

        The name of the IAM role that is used to access resources through Organizations.

      • organizationalUnits — (Array<String>)

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

      • permissionType — (String)

        If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

        If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

        If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

        For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "SERVICE_MANAGED"
      • stackSetName — (String)

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

      • status — required — (String)

        The current status of the workspace.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "UPGRADING"
        • "DELETION_FAILED"
        • "CREATION_FAILED"
        • "UPDATE_FAILED"
        • "UPGRADE_FAILED"
        • "LICENSE_REMOVAL_FAILED"
        • "VERSION_UPDATING"
        • "VERSION_UPDATE_FAILED"
      • tags — (map<String>)

        The list of tags associated with the workspace.

      • vpcConfiguration — (map)

        The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

        • securityGroupIds — required — (Array<String>)

          The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

        • subnetIds — required — (Array<String>)

          The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  keyName: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.deleteWorkspaceApiKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • keyName — (String)

    The name of the API key to delete.

  • workspaceId — (String)

    The ID of the workspace to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • keyName — (String)

      The name of the key that was deleted.

    • workspaceId — (String)

      The ID of the workspace where the key was deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.describeWorkspace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workspaceId — (String)

    The ID of the workspace to display information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workspace — (map)

      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.

        Possible values include:
        • "CURRENT_ACCOUNT"
        • "ORGANIZATION"
      • authentication — required — (map)

        A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • providers — required — (Array<String>)

          Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • samlConfigurationStatus — (String)

          Specifies whether the workplace's user authentication method is fully configured.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"
      • created — required — (Date)

        The date that the workspace was created.

      • dataSources — required — (Array<String>)

        Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

        This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      • description — (String)

        The user-defined description of the workspace.

      • endpoint — required — (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.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • freeTrialExpiration — (Date)

        If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • grafanaToken — (String)

        The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

      • grafanaVersion — required — (String)

        The version of Grafana supported in this workspace.

      • id — required — (String)

        The unique ID of this workspace.

      • licenseExpiration — (Date)

        If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

      • licenseType — (String)

        Specifies whether this workspace has a full Grafana Enterprise license.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
        Possible values include:
        • "ENTERPRISE"
        • "ENTERPRISE_FREE_TRIAL"
      • modified — required — (Date)

        The most recent date that the workspace was modified.

      • name — (String)

        The name of the workspace.

      • networkAccessControl — (map)

        The configuration settings for network access to your workspace.

        • prefixListIds — required — (Array<String>)

          An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

          Prefix list IDs have the format pl-1a2b3c4d .

          For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

        • vpceIds — required — (Array<String>)

          An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

          VPC endpoint IDs have the format vpce-1a2b3c4d .

          For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

          Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
      • notificationDestinations — (Array<String>)

        The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

      • organizationRoleName — (String)

        The name of the IAM role that is used to access resources through Organizations.

      • organizationalUnits — (Array<String>)

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

      • permissionType — (String)

        If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

        If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

        If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

        For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "SERVICE_MANAGED"
      • stackSetName — (String)

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

      • status — required — (String)

        The current status of the workspace.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "UPGRADING"
        • "DELETION_FAILED"
        • "CREATION_FAILED"
        • "UPDATE_FAILED"
        • "UPGRADE_FAILED"
        • "LICENSE_REMOVAL_FAILED"
        • "VERSION_UPDATING"
        • "VERSION_UPDATE_FAILED"
      • tags — (map<String>)

        The list of tags associated with the workspace.

      • vpcConfiguration — (map)

        The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

        • securityGroupIds — required — (Array<String>)

          The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

        • subnetIds — required — (Array<String>)

          The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.describeWorkspaceAuthentication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workspaceId — (String)

    The ID of the workspace to return authentication information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • authentication — (map)

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

      • awsSso — (map)

        A structure containing information about how this workspace works with IAM Identity Center.

        • ssoClientId — (String)

          The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.

      • providers — required — (Array<String>)

        Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

      • saml — (map)

        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 — (map)

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

          • allowedOrganizations — (Array<String>)

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

          • assertionAttributes — (map)

            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 — required — (map)

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

            • xml — (String)

              The full IdP metadata, 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 — (map)

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

            • admin — (Array<String>)

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

            • editor — (Array<String>)

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

        • status — required — (String)

          Specifies whether the workspace's SAML configuration is complete.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.describeWorkspaceConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workspaceId — (String)

    The ID of the workspace to get configuration information for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuration — (String)

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

    • grafanaVersion — (String)

      The supported Grafana version for the workspace.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  licenseType: ENTERPRISE | ENTERPRISE_FREE_TRIAL, /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.disassociateLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • licenseType — (String)

    The type of license to remove from the workspace.

    Possible values include:
    • "ENTERPRISE"
    • "ENTERPRISE_FREE_TRIAL"
  • workspaceId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workspace — (map)

      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.

        Possible values include:
        • "CURRENT_ACCOUNT"
        • "ORGANIZATION"
      • authentication — required — (map)

        A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • providers — required — (Array<String>)

          Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • samlConfigurationStatus — (String)

          Specifies whether the workplace's user authentication method is fully configured.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"
      • created — required — (Date)

        The date that the workspace was created.

      • dataSources — required — (Array<String>)

        Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

        This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      • description — (String)

        The user-defined description of the workspace.

      • endpoint — required — (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.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • freeTrialExpiration — (Date)

        If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • grafanaToken — (String)

        The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

      • grafanaVersion — required — (String)

        The version of Grafana supported in this workspace.

      • id — required — (String)

        The unique ID of this workspace.

      • licenseExpiration — (Date)

        If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

      • licenseType — (String)

        Specifies whether this workspace has a full Grafana Enterprise license.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
        Possible values include:
        • "ENTERPRISE"
        • "ENTERPRISE_FREE_TRIAL"
      • modified — required — (Date)

        The most recent date that the workspace was modified.

      • name — (String)

        The name of the workspace.

      • networkAccessControl — (map)

        The configuration settings for network access to your workspace.

        • prefixListIds — required — (Array<String>)

          An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

          Prefix list IDs have the format pl-1a2b3c4d .

          For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

        • vpceIds — required — (Array<String>)

          An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

          VPC endpoint IDs have the format vpce-1a2b3c4d .

          For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

          Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
      • notificationDestinations — (Array<String>)

        The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

      • organizationRoleName — (String)

        The name of the IAM role that is used to access resources through Organizations.

      • organizationalUnits — (Array<String>)

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

      • permissionType — (String)

        If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

        If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

        If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

        For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "SERVICE_MANAGED"
      • stackSetName — (String)

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

      • status — required — (String)

        The current status of the workspace.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "UPGRADING"
        • "DELETION_FAILED"
        • "CREATION_FAILED"
        • "UPDATE_FAILED"
        • "UPGRADE_FAILED"
        • "LICENSE_REMOVAL_FAILED"
        • "VERSION_UPDATING"
        • "VERSION_UPDATE_FAILED"
      • tags — (map<String>)

        The list of tags associated with the workspace.

      • vpcConfiguration — (map)

        The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

        • securityGroupIds — required — (Array<String>)

          The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

        • subnetIds — required — (Array<String>)

          The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  groupId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  userId: 'STRING_VALUE',
  userType: SSO_USER | SSO_GROUP
};
grafana.listPermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • groupId — (String)

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

  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

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

  • userId — (String)

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

  • userType — (String)

    (Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

    Possible values include:
    • "SSO_USER"
    • "SSO_GROUP"
  • workspaceId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

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

    • permissions — (Array<map>)

      The permissions returned by the operation.

      • role — required — (String)

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

        Possible values include:
        • "ADMIN"
        • "EDITOR"
        • "VIEWER"
      • user — required — (map)

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

        • id — required — (String)

          The ID of the user or group.

          Pattern: ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

        • type — required — (String)

          Specifies whether this is a single user or a group.

          Possible values include:
          • "SSO_USER"
          • "SSO_GROUP"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
grafana.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource the list of tags are associated with.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The list of tags that are associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  workspaceId: 'STRING_VALUE'
};
grafana.listVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to include in the response.

  • nextToken — (String)

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

  • workspaceId — (String)

    The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for CreateWorkspace.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • grafanaVersions — (Array<String>)

      The Grafana versions available to create. If a workspace ID is included in the request, the Grafana versions to which this workspace can be upgraded.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
grafana.listWorkspaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of workspaces to include in the results.

  • nextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token to use when requesting the next set of workspaces.

    • workspaces — (Array<map>)

      An array of structures that contain some information about the workspaces in the account.

      • authentication — required — (map)

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

        • providers — required — (Array<String>)

          Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • samlConfigurationStatus — (String)

          Specifies whether the workplace's user authentication method is fully configured.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"
      • created — required — (Date)

        The date that the workspace was created.

      • description — (String)

        The customer-entered description of the workspace.

      • endpoint — required — (String)

        The URL endpoint to use to access the Grafana console in the workspace.

      • grafanaToken — (String)

        The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

      • grafanaVersion — required — (String)

        The Grafana version that the workspace is running.

      • id — required — (String)

        The unique ID of the workspace.

      • licenseType — (String)

        Specifies whether this workspace has a full Grafana Enterprise license.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
        Possible values include:
        • "ENTERPRISE"
        • "ENTERPRISE_FREE_TRIAL"
      • modified — required — (Date)

        The most recent date that the workspace was modified.

      • name — (String)

        The name of the workspace.

      • notificationDestinations — (Array<String>)

        The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

      • status — required — (String)

        The current status of the workspace.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "UPGRADING"
        • "DELETION_FAILED"
        • "CREATION_FAILED"
        • "UPDATE_FAILED"
        • "UPGRADE_FAILED"
        • "LICENSE_REMOVAL_FAILED"
        • "VERSION_UPDATING"
        • "VERSION_UPDATE_FAILED"
      • tags — (map<String>)

        The list of tags associated with the workspace.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
grafana.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource the tag is associated with.

  • tags — (map<String>)

    The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
grafana.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource the tag association is removed from.

  • tagKeys — (Array<String>)

    The key values of the tag to be removed from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  updateInstructionBatch: [ /* required */
    {
      action: ADD | REVOKE, /* required */
      role: ADMIN | EDITOR | VIEWER, /* required */
      users: [ /* required */
        {
          id: 'STRING_VALUE', /* required */
          type: SSO_USER | SSO_GROUP /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  workspaceId: 'STRING_VALUE' /* required */
};
grafana.updatePermissions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • updateInstructionBatch — (Array<map>)

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

    • action — required — (String)

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

      Possible values include:
      • "ADD"
      • "REVOKE"
    • role — required — (String)

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

      Possible values include:
      • "ADMIN"
      • "EDITOR"
      • "VIEWER"
    • users — required — (Array<map>)

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

      • id — required — (String)

        The ID of the user or group.

        Pattern: ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

      • type — required — (String)

        Specifies whether this is a single user or a group.

        Possible values include:
        • "SSO_USER"
        • "SSO_GROUP"
  • workspaceId — (String)

    The ID of the workspace to update.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • errors — (Array<map>)

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

      • causedBy — required — (map)

        Specifies which permission update caused the error.

        • action — required — (String)

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

          Possible values include:
          • "ADD"
          • "REVOKE"
        • role — required — (String)

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

          Possible values include:
          • "ADMIN"
          • "EDITOR"
          • "VIEWER"
        • users — required — (Array<map>)

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

          • id — required — (String)

            The ID of the user or group.

            Pattern: ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

          • type — required — (String)

            Specifies whether this is a single user or a group.

            Possible values include:
            • "SSO_USER"
            • "SSO_GROUP"
      • code — required — (Integer)

        The error code.

      • message — required — (String)

        The message for this error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  accountAccessType: CURRENT_ACCOUNT | ORGANIZATION,
  networkAccessControl: {
    prefixListIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    vpceIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  organizationRoleName: 'STRING_VALUE',
  permissionType: CUSTOMER_MANAGED | SERVICE_MANAGED,
  removeNetworkAccessConfiguration: true || false,
  removeVpcConfiguration: true || false,
  stackSetName: 'STRING_VALUE',
  vpcConfiguration: {
    securityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  workspaceDataSources: [
    AMAZON_OPENSEARCH_SERVICE | CLOUDWATCH | PROMETHEUS | XRAY | TIMESTREAM | SITEWISE | ATHENA | REDSHIFT | TWINMAKER,
    /* more items */
  ],
  workspaceDescription: 'STRING_VALUE',
  workspaceName: 'STRING_VALUE',
  workspaceNotificationDestinations: [
    SNS,
    /* more items */
  ],
  workspaceOrganizationalUnits: [
    'STRING_VALUE',
    /* more items */
  ],
  workspaceRoleArn: 'STRING_VALUE'
};
grafana.updateWorkspace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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 you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.

    Possible values include:
    • "CURRENT_ACCOUNT"
    • "ORGANIZATION"
  • networkAccessControl — (map)

    The configuration settings for network access to your workspace.

    When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.

    If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

    • prefixListIds — required — (Array<String>)

      An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

      Prefix list IDs have the format pl-1a2b3c4d .

      For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

    • vpceIds — required — (Array<String>)

      An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

      VPC endpoint IDs have the format vpce-1a2b3c4d .

      For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

      Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
  • organizationRoleName — (String)

    The name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the permissionType set to CUSTOMER_MANAGED.

  • permissionType — (String)

    Use this parameter if you want to change a workspace from SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services account of an organization, and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.

    If you specify this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will use for accessing Amazon Web Services resources.

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

    Note: Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to leave the workspace as SERVICE_MANAGED. You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.
    Possible values include:
    • "CUSTOMER_MANAGED"
    • "SERVICE_MANAGED"
  • removeNetworkAccessConfiguration — (Boolean)

    Whether to remove the network access configuration from the workspace.

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

    If you remove this configuration by setting this to true, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.

  • removeVpcConfiguration — (Boolean)

    Whether to remove the VPC configuration from the workspace.

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

  • stackSetName — (String)

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

  • vpcConfiguration — (map)

    The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

    • securityGroupIds — required — (Array<String>)

      The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

    • subnetIds — required — (Array<String>)

      The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

  • workspaceDataSources — (Array<String>)

    This parameter is for internal use only, and should not be used.

  • workspaceDescription — (String)

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

  • workspaceId — (String)

    The ID of the workspace to update.

  • workspaceName — (String)

    A new name for the workspace to update.

  • workspaceNotificationDestinations — (Array<String>)

    Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.

  • workspaceOrganizationalUnits — (Array<String>)

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

  • workspaceRoleArn — (String)

    Specifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • workspace — (map)

      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.

        Possible values include:
        • "CURRENT_ACCOUNT"
        • "ORGANIZATION"
      • authentication — required — (map)

        A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • providers — required — (Array<String>)

          Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

        • samlConfigurationStatus — (String)

          Specifies whether the workplace's user authentication method is fully configured.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"
      • created — required — (Date)

        The date that the workspace was created.

      • dataSources — required — (Array<String>)

        Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.

        This list is only used when the workspace was created through the Amazon Web Services console, and the permissionType is SERVICE_MANAGED.

      • description — (String)

        The user-defined description of the workspace.

      • endpoint — required — (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.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • freeTrialExpiration — (Date)

        If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
      • grafanaToken — (String)

        The token that ties this workspace to a Grafana Labs account. For more information, see Register with Grafana Labs.

      • grafanaVersion — required — (String)

        The version of Grafana supported in this workspace.

      • id — required — (String)

        The unique ID of this workspace.

      • licenseExpiration — (Date)

        If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.

      • licenseType — (String)

        Specifies whether this workspace has a full Grafana Enterprise license.

        Note: Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
        Possible values include:
        • "ENTERPRISE"
        • "ENTERPRISE_FREE_TRIAL"
      • modified — required — (Date)

        The most recent date that the workspace was modified.

      • name — (String)

        The name of the workspace.

      • networkAccessControl — (map)

        The configuration settings for network access to your workspace.

        • prefixListIds — required — (Array<String>)

          An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.

          Prefix list IDs have the format pl-1a2b3c4d .

          For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.

        • vpceIds — required — (Array<String>)

          An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.

          VPC endpoint IDs have the format vpce-1a2b3c4d .

          For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide.

          Note: The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
      • notificationDestinations — (Array<String>)

        The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.

      • organizationRoleName — (String)

        The name of the IAM role that is used to access resources through Organizations.

      • organizationalUnits — (Array<String>)

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

      • permissionType — (String)

        If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.

        If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.

        If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.

        For more information about converting between customer and service managed, see Managing permissions for data sources and notification channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "SERVICE_MANAGED"
      • stackSetName — (String)

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

      • status — required — (String)

        The current status of the workspace.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
        • "UPGRADING"
        • "DELETION_FAILED"
        • "CREATION_FAILED"
        • "UPDATE_FAILED"
        • "UPGRADE_FAILED"
        • "LICENSE_REMOVAL_FAILED"
        • "VERSION_UPDATING"
        • "VERSION_UPDATE_FAILED"
      • tags — (map<String>)

        The list of tags associated with the workspace.

      • vpcConfiguration — (map)

        The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).

        • securityGroupIds — required — (Array<String>)

          The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

        • subnetIds — required — (Array<String>)

          The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  authenticationProviders: [ /* required */
    AWS_SSO | SAML,
    /* more items */
  ],
  workspaceId: 'STRING_VALUE', /* required */
  samlConfiguration: {
    idpMetadata: { /* required */
      url: 'STRING_VALUE',
      xml: 'STRING_VALUE'
    },
    allowedOrganizations: [
      'STRING_VALUE',
      /* more items */
    ],
    assertionAttributes: {
      email: 'STRING_VALUE',
      groups: 'STRING_VALUE',
      login: 'STRING_VALUE',
      name: 'STRING_VALUE',
      org: 'STRING_VALUE',
      role: 'STRING_VALUE'
    },
    loginValidityDuration: 'NUMBER_VALUE',
    roleValues: {
      admin: [
        'STRING_VALUE',
        /* more items */
      ],
      editor: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
grafana.updateWorkspaceAuthentication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • authenticationProviders — (Array<String>)

    Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

  • samlConfiguration — (map)

    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 — (Array<String>)

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

    • assertionAttributes — (map)

      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 — required — (map)

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

      • xml — (String)

        The full IdP metadata, 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 — (map)

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

      • admin — (Array<String>)

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

      • editor — (Array<String>)

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

  • workspaceId — (String)

    The ID of the workspace to update the authentication for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • authentication — (map)

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

      • awsSso — (map)

        A structure containing information about how this workspace works with IAM Identity Center.

        • ssoClientId — (String)

          The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.

      • providers — required — (Array<String>)

        Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

      • saml — (map)

        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 — (map)

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

          • allowedOrganizations — (Array<String>)

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

          • assertionAttributes — (map)

            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 — required — (map)

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

            • xml — (String)

              The full IdP metadata, 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 — (map)

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

            • admin — (Array<String>)

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

            • editor — (Array<String>)

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

        • status — required — (String)

          Specifies whether the workspace's SAML configuration is complete.

          Possible values include:
          • "CONFIGURED"
          • "NOT_CONFIGURED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuration: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
  workspaceId: 'STRING_VALUE', /* required */
  grafanaVersion: 'STRING_VALUE'
};
grafana.updateWorkspaceConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuration — (String)

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

  • grafanaVersion — (String)

    Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.

    Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).

    To know what versions are available to upgrade to for a specific workspace, see the ListVersions operation.

  • workspaceId — (String)

    The ID of the workspace to update.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.