SDK for PHP 3.x

Client: Aws\ManagedGrafana\ManagedGrafanaClient
Service ID: grafana
Version: 2020-08-18

This page describes the parameters and results for the operations of the Amazon Managed Grafana (2020-08-18), and shows how to use the Aws\ManagedGrafana\ManagedGrafanaClient object to call the described operations. This documentation is specific to the 2020-08-18 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateLicense ( array $params = [] )
Assigns a Grafana Enterprise license to a workspace.
CreateWorkspace ( array $params = [] )
Creates a workspace.
CreateWorkspaceApiKey ( array $params = [] )
Creates a Grafana API key for the workspace.
CreateWorkspaceServiceAccount ( array $params = [] )
Creates a service account for the workspace.
CreateWorkspaceServiceAccountToken ( array $params = [] )
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.
DeleteWorkspace ( array $params = [] )
Deletes an Amazon Managed Grafana workspace.
DeleteWorkspaceApiKey ( array $params = [] )
Deletes a Grafana API key for the workspace.
DeleteWorkspaceServiceAccount ( array $params = [] )
Deletes a workspace service account from the workspace.
DeleteWorkspaceServiceAccountToken ( array $params = [] )
Deletes a token for the workspace service account.
DescribeWorkspace ( array $params = [] )
Displays information about one Amazon Managed Grafana workspace.
DescribeWorkspaceAuthentication ( array $params = [] )
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
DescribeWorkspaceConfiguration ( array $params = [] )
Gets the current configuration string for the given workspace.
DisassociateLicense ( array $params = [] )
Removes the Grafana Enterprise license from a workspace.
ListPermissions ( array $params = [] )
Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
ListTagsForResource ( array $params = [] )
The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn.
ListVersions ( array $params = [] )
Lists available versions of Grafana.
ListWorkspaceServiceAccountTokens ( array $params = [] )
Returns a list of tokens for a workspace service account.
ListWorkspaceServiceAccounts ( array $params = [] )
Returns a list of service accounts for a workspace.
ListWorkspaces ( array $params = [] )
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
TagResource ( array $params = [] )
The TagResource operation associates tags with an Amazon Managed Grafana resource.
UntagResource ( array $params = [] )
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.
UpdatePermissions ( array $params = [] )
Updates which users in a workspace have the Grafana Admin or Editor roles.
UpdateWorkspace ( array $params = [] )
Modifies an existing Amazon Managed Grafana workspace.
UpdateWorkspaceAuthentication ( array $params = [] )
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.
UpdateWorkspaceConfiguration ( array $params = [] )
Updates the configuration string for the given workspace

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListPermissions
ListVersions
ListWorkspaceServiceAccountTokens
ListWorkspaceServiceAccounts
ListWorkspaces

Operations

AssociateLicense

$result = $client->associateLicense([/* ... */]);
$promise = $client->associateLicenseAsync([/* ... */]);

Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE for the licenseType, and pass in a valid Grafana Labs token for the grafanaToken. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.

Parameter Syntax

$result = $client->associateLicense([
    'grafanaToken' => '<string>',
    'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
grafanaToken
Type: string

A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see Link your account with Grafana Labs.

licenseType
Required: Yes
Type: string

The type of license to associate with the workspace.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

workspaceId
Required: Yes
Type: string

The ID of the workspace to associate the license with.

Result Syntax

[
    'workspace' => [
        'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
        'authentication' => [
            'providers' => ['<string>', ...],
            'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        ],
        'created' => <DateTime>,
        'dataSources' => ['<string>', ...],
        'description' => '<string>',
        'endpoint' => '<string>',
        'freeTrialConsumed' => true || false,
        'freeTrialExpiration' => <DateTime>,
        'grafanaToken' => '<string>',
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<string>',
        'networkAccessControl' => [
            'prefixListIds' => ['<string>', ...],
            'vpceIds' => ['<string>', ...],
        ],
        'notificationDestinations' => ['<string>', ...],
        'organizationRoleName' => '<string>',
        'organizationalUnits' => ['<string>', ...],
        'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
        'stackSetName' => '<string>',
        'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'vpcConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'workspaceRoleArn' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure containing data about the workspace.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

CreateWorkspace

$result = $client->createWorkspace([/* ... */]);
$promise = $client->createWorkspaceAsync([/* ... */]);

Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.

Parameter Syntax

$result = $client->createWorkspace([
    'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION', // REQUIRED
    'authenticationProviders' => ['<string>', ...], // REQUIRED
    'clientToken' => '<string>',
    'configuration' => '<string>',
    'grafanaVersion' => '<string>',
    'networkAccessControl' => [
        'prefixListIds' => ['<string>', ...], // REQUIRED
        'vpceIds' => ['<string>', ...], // REQUIRED
    ],
    'organizationRoleName' => '<string>',
    'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED', // REQUIRED
    'stackSetName' => '<string>',
    'tags' => ['<string>', ...],
    'vpcConfiguration' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
    'workspaceDataSources' => ['<string>', ...],
    'workspaceDescription' => '<string>',
    'workspaceName' => '<string>',
    'workspaceNotificationDestinations' => ['<string>', ...],
    'workspaceOrganizationalUnits' => ['<string>', ...],
    'workspaceRoleArn' => '<string>',
]);

Parameter Details

Members
accountAccessType
Required: Yes
Type: 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.

authenticationProviders
Required: Yes
Type: Array of strings

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
Type: string

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

configuration
Type: string (string|number|array|map or anything parsable by json_encode)

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
Type: string

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

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

networkAccessControl
Type: NetworkAccessConfiguration structure

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.

organizationRoleName
Type: 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
Required: Yes
Type: 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.

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.

stackSetName
Type: string

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

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags associated with the workspace.

vpcConfiguration
Type: VpcConfiguration structure

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

Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

workspaceDataSources
Type: Array of strings

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

workspaceDescription
Type: 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
Type: string

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

workspaceNotificationDestinations
Type: Array of strings

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
Type: Array of strings

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

Result Syntax

[
    'workspace' => [
        'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
        'authentication' => [
            'providers' => ['<string>', ...],
            'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        ],
        'created' => <DateTime>,
        'dataSources' => ['<string>', ...],
        'description' => '<string>',
        'endpoint' => '<string>',
        'freeTrialConsumed' => true || false,
        'freeTrialExpiration' => <DateTime>,
        'grafanaToken' => '<string>',
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<string>',
        'networkAccessControl' => [
            'prefixListIds' => ['<string>', ...],
            'vpceIds' => ['<string>', ...],
        ],
        'notificationDestinations' => ['<string>', ...],
        'organizationRoleName' => '<string>',
        'organizationalUnits' => ['<string>', ...],
        'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
        'stackSetName' => '<string>',
        'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'vpcConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'workspaceRoleArn' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure containing data about the workspace that was created.

Errors

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

CreateWorkspaceApiKey

$result = $client->createWorkspaceApiKey([/* ... */]);
$promise = $client->createWorkspaceApiKeyAsync([/* ... */]);

Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.

In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

Parameter Syntax

$result = $client->createWorkspaceApiKey([
    'keyName' => '<string>', // REQUIRED
    'keyRole' => '<string>', // REQUIRED
    'secondsToLive' => <integer>, // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
keyName
Required: Yes
Type: string

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

keyRole
Required: Yes
Type: string

Specifies the permission level of the key.

Valid values: ADMIN|EDITOR|VIEWER

secondsToLive
Required: Yes
Type: int

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

workspaceId
Required: Yes
Type: string

The ID of the workspace to create an API key.

Result Syntax

[
    'key' => '<string>',
    'keyName' => '<string>',
    'workspaceId' => '<string>',
]

Result Details

Members
key
Required: Yes
Type: string

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

keyName
Required: Yes
Type: string

The name of the key that was created.

workspaceId
Required: Yes
Type: string

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

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

CreateWorkspaceServiceAccount

$result = $client->createWorkspaceServiceAccount([/* ... */]);
$promise = $client->createWorkspaceServiceAccountAsync([/* ... */]);

Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct GrafanaRole for your use case, use CreateWorkspaceServiceAccountToken to create a token that can be used to authenticate and authorize Grafana HTTP API calls.

You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.

For more information about service accounts, see Service accounts in the Amazon Managed Grafana User Guide.

For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs in the Amazon Managed Grafana User Guide.

Parameter Syntax

$result = $client->createWorkspaceServiceAccount([
    'grafanaRole' => 'ADMIN|EDITOR|VIEWER', // REQUIRED
    'name' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
grafanaRole
Required: Yes
Type: string

The permission level to use for this service account.

For more information about the roles and the permissions each has, see User roles in the Amazon Managed Grafana User Guide.

name
Required: Yes
Type: string

A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account.

workspaceId
Required: Yes
Type: string

The ID of the workspace within which to create the service account.

Result Syntax

[
    'grafanaRole' => 'ADMIN|EDITOR|VIEWER',
    'id' => '<string>',
    'name' => '<string>',
    'workspaceId' => '<string>',
]

Result Details

Members
grafanaRole
Required: Yes
Type: string

The permission level given to the service account.

id
Required: Yes
Type: string

The ID of the service account.

name
Required: Yes
Type: string

The name of the service account.

workspaceId
Required: Yes
Type: string

The workspace with which the service account is associated.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

CreateWorkspaceServiceAccountToken

$result = $client->createWorkspaceServiceAccountToken([/* ... */]);
$promise = $client->createWorkspaceServiceAccountTokenAsync([/* ... */]);

Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.

When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.

If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Parameter Syntax

$result = $client->createWorkspaceServiceAccountToken([
    'name' => '<string>', // REQUIRED
    'secondsToLive' => <integer>, // REQUIRED
    'serviceAccountId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

A name for the token to create.

secondsToLive
Required: Yes
Type: int

Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future.

serviceAccountId
Required: Yes
Type: string

The ID of the service account for which to create a token.

workspaceId
Required: Yes
Type: string

The ID of the workspace the service account resides within.

Result Syntax

[
    'serviceAccountId' => '<string>',
    'serviceAccountToken' => [
        'id' => '<string>',
        'key' => '<string>',
        'name' => '<string>',
    ],
    'workspaceId' => '<string>',
]

Result Details

Members
serviceAccountId
Required: Yes
Type: string

The ID of the service account where the token was created.

serviceAccountToken
Required: Yes
Type: ServiceAccountTokenSummaryWithKey structure

Information about the created token, including the key. Be sure to store the key securely.

workspaceId
Required: Yes
Type: string

The ID of the workspace where the token was created.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

DeleteWorkspace

$result = $client->deleteWorkspace([/* ... */]);
$promise = $client->deleteWorkspaceAsync([/* ... */]);

Deletes an Amazon Managed Grafana workspace.

Parameter Syntax

$result = $client->deleteWorkspace([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to delete.

Result Syntax

[
    'workspace' => [
        'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
        'authentication' => [
            'providers' => ['<string>', ...],
            'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        ],
        'created' => <DateTime>,
        'dataSources' => ['<string>', ...],
        'description' => '<string>',
        'endpoint' => '<string>',
        'freeTrialConsumed' => true || false,
        'freeTrialExpiration' => <DateTime>,
        'grafanaToken' => '<string>',
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<string>',
        'networkAccessControl' => [
            'prefixListIds' => ['<string>', ...],
            'vpceIds' => ['<string>', ...],
        ],
        'notificationDestinations' => ['<string>', ...],
        'organizationRoleName' => '<string>',
        'organizationalUnits' => ['<string>', ...],
        'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
        'stackSetName' => '<string>',
        'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'vpcConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'workspaceRoleArn' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure containing information about the workspace that was deleted.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DeleteWorkspaceApiKey

$result = $client->deleteWorkspaceApiKey([/* ... */]);
$promise = $client->deleteWorkspaceApiKeyAsync([/* ... */]);

Deletes a Grafana API key for the workspace.

In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

Parameter Syntax

$result = $client->deleteWorkspaceApiKey([
    'keyName' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
keyName
Required: Yes
Type: string

The name of the API key to delete.

workspaceId
Required: Yes
Type: string

The ID of the workspace to delete.

Result Syntax

[
    'keyName' => '<string>',
    'workspaceId' => '<string>',
]

Result Details

Members
keyName
Required: Yes
Type: string

The name of the key that was deleted.

workspaceId
Required: Yes
Type: string

The ID of the workspace where the key was deleted.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DeleteWorkspaceServiceAccount

$result = $client->deleteWorkspaceServiceAccount([/* ... */]);
$promise = $client->deleteWorkspaceServiceAccountAsync([/* ... */]);

Deletes a workspace service account from the workspace.

This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Parameter Syntax

$result = $client->deleteWorkspaceServiceAccount([
    'serviceAccountId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
serviceAccountId
Required: Yes
Type: string

The ID of the service account to delete.

workspaceId
Required: Yes
Type: string

The ID of the workspace where the service account resides.

Result Syntax

[
    'serviceAccountId' => '<string>',
    'workspaceId' => '<string>',
]

Result Details

Members
serviceAccountId
Required: Yes
Type: string

The ID of the service account deleted.

workspaceId
Required: Yes
Type: string

The ID of the workspace where the service account was deleted.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DeleteWorkspaceServiceAccountToken

$result = $client->deleteWorkspaceServiceAccountToken([/* ... */]);
$promise = $client->deleteWorkspaceServiceAccountTokenAsync([/* ... */]);

Deletes a token for the workspace service account.

This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Parameter Syntax

$result = $client->deleteWorkspaceServiceAccountToken([
    'serviceAccountId' => '<string>', // REQUIRED
    'tokenId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
serviceAccountId
Required: Yes
Type: string

The ID of the service account from which to delete the token.

tokenId
Required: Yes
Type: string

The ID of the token to delete.

workspaceId
Required: Yes
Type: string

The ID of the workspace from which to delete the token.

Result Syntax

[
    'serviceAccountId' => '<string>',
    'tokenId' => '<string>',
    'workspaceId' => '<string>',
]

Result Details

Members
serviceAccountId
Required: Yes
Type: string

The ID of the service account where the token was deleted.

tokenId
Required: Yes
Type: string

The ID of the token that was deleted.

workspaceId
Required: Yes
Type: string

The ID of the workspace where the token was deleted.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DescribeWorkspace

$result = $client->describeWorkspace([/* ... */]);
$promise = $client->describeWorkspaceAsync([/* ... */]);

Displays information about one Amazon Managed Grafana workspace.

Parameter Syntax

$result = $client->describeWorkspace([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to display information about.

Result Syntax

[
    'workspace' => [
        'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
        'authentication' => [
            'providers' => ['<string>', ...],
            'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        ],
        'created' => <DateTime>,
        'dataSources' => ['<string>', ...],
        'description' => '<string>',
        'endpoint' => '<string>',
        'freeTrialConsumed' => true || false,
        'freeTrialExpiration' => <DateTime>,
        'grafanaToken' => '<string>',
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<string>',
        'networkAccessControl' => [
            'prefixListIds' => ['<string>', ...],
            'vpceIds' => ['<string>', ...],
        ],
        'notificationDestinations' => ['<string>', ...],
        'organizationRoleName' => '<string>',
        'organizationalUnits' => ['<string>', ...],
        'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
        'stackSetName' => '<string>',
        'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'vpcConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'workspaceRoleArn' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure containing information about the workspace.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DescribeWorkspaceAuthentication

$result = $client->describeWorkspaceAuthentication([/* ... */]);
$promise = $client->describeWorkspaceAuthenticationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeWorkspaceAuthentication([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to return authentication information about.

Result Syntax

[
    'authentication' => [
        'awsSso' => [
            'ssoClientId' => '<string>',
        ],
        'providers' => ['<string>', ...],
        'saml' => [
            'configuration' => [
                'allowedOrganizations' => ['<string>', ...],
                'assertionAttributes' => [
                    'email' => '<string>',
                    'groups' => '<string>',
                    'login' => '<string>',
                    'name' => '<string>',
                    'org' => '<string>',
                    'role' => '<string>',
                ],
                'idpMetadata' => [
                    'url' => '<string>',
                    'xml' => '<string>',
                ],
                'loginValidityDuration' => <integer>,
                'roleValues' => [
                    'admin' => ['<string>', ...],
                    'editor' => ['<string>', ...],
                ],
            ],
            'status' => 'CONFIGURED|NOT_CONFIGURED',
        ],
    ],
]

Result Details

Members
authentication
Required: Yes
Type: AuthenticationDescription structure

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

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DescribeWorkspaceConfiguration

$result = $client->describeWorkspaceConfiguration([/* ... */]);
$promise = $client->describeWorkspaceConfigurationAsync([/* ... */]);

Gets the current configuration string for the given workspace.

Parameter Syntax

$result = $client->describeWorkspaceConfiguration([
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
workspaceId
Required: Yes
Type: string

The ID of the workspace to get configuration information for.

Result Syntax

[
    'configuration' => '<string>',
    'grafanaVersion' => '<string>',
]

Result Details

Members
configuration
Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

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
Type: string

The supported Grafana version for the workspace.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

DisassociateLicense

$result = $client->disassociateLicense([/* ... */]);
$promise = $client->disassociateLicenseAsync([/* ... */]);

Removes the Grafana Enterprise license from a workspace.

Parameter Syntax

$result = $client->disassociateLicense([
    'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
licenseType
Required: Yes
Type: string

The type of license to remove from the workspace.

workspaceId
Required: Yes
Type: string

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

Result Syntax

[
    'workspace' => [
        'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
        'authentication' => [
            'providers' => ['<string>', ...],
            'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        ],
        'created' => <DateTime>,
        'dataSources' => ['<string>', ...],
        'description' => '<string>',
        'endpoint' => '<string>',
        'freeTrialConsumed' => true || false,
        'freeTrialExpiration' => <DateTime>,
        'grafanaToken' => '<string>',
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<string>',
        'networkAccessControl' => [
            'prefixListIds' => ['<string>', ...],
            'vpceIds' => ['<string>', ...],
        ],
        'notificationDestinations' => ['<string>', ...],
        'organizationRoleName' => '<string>',
        'organizationalUnits' => ['<string>', ...],
        'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
        'stackSetName' => '<string>',
        'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'vpcConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'workspaceRoleArn' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure containing information about the workspace.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ListPermissions

$result = $client->listPermissions([/* ... */]);
$promise = $client->listPermissionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPermissions([
    'groupId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'userId' => '<string>',
    'userType' => 'SSO_USER|SSO_GROUP',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
groupId
Type: string

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

maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

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

userId
Type: string

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

userType
Type: 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.

workspaceId
Required: Yes
Type: string

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

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'role' => 'ADMIN|EDITOR|VIEWER',
            'user' => [
                'id' => '<string>',
                'type' => 'SSO_USER|SSO_GROUP',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

permissions
Required: Yes
Type: Array of PermissionEntry structures

The permissions returned by the operation.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be tagged is a workspace.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags that are associated with the resource.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ListVersions

$result = $client->listVersions([/* ... */]);
$promise = $client->listVersionsAsync([/* ... */]);

Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally, include a workspace to list the versions to which it can be upgraded.

Parameter Syntax

$result = $client->listVersions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to include in the response.

nextToken
Type: string

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

workspaceId
Type: 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.

Result Syntax

[
    'grafanaVersions' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
grafanaVersions
Type: Array of strings

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
Type: string

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

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ListWorkspaceServiceAccountTokens

$result = $client->listWorkspaceServiceAccountTokens([/* ... */]);
$promise = $client->listWorkspaceServiceAccountTokensAsync([/* ... */]);

Returns a list of tokens for a workspace service account.

This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Parameter Syntax

$result = $client->listWorkspaceServiceAccountTokens([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceAccountId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of tokens to include in the results.

nextToken
Type: string

The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccountTokens operation.)

serviceAccountId
Required: Yes
Type: string

The ID of the service account for which to return tokens.

workspaceId
Required: Yes
Type: string

The ID of the workspace for which to return tokens.

Result Syntax

[
    'nextToken' => '<string>',
    'serviceAccountId' => '<string>',
    'serviceAccountTokens' => [
        [
            'createdAt' => <DateTime>,
            'expiresAt' => <DateTime>,
            'id' => '<string>',
            'lastUsedAt' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'workspaceId' => '<string>',
]

Result Details

Members
nextToken
Type: string

The token to use when requesting the next set of service accounts.

serviceAccountId
Required: Yes
Type: string

The ID of the service account where the tokens reside.

serviceAccountTokens
Required: Yes
Type: Array of ServiceAccountTokenSummary structures

An array of structures containing information about the tokens.

workspaceId
Required: Yes
Type: string

The ID of the workspace where the tokens reside.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ListWorkspaceServiceAccounts

$result = $client->listWorkspaceServiceAccounts([/* ... */]);
$promise = $client->listWorkspaceServiceAccountsAsync([/* ... */]);

Returns a list of service accounts for a workspace.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Parameter Syntax

$result = $client->listWorkspaceServiceAccounts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of service accounts to include in the results.

nextToken
Type: string

The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccounts operation.)

workspaceId
Required: Yes
Type: string

The workspace for which to list service accounts.

Result Syntax

[
    'nextToken' => '<string>',
    'serviceAccounts' => [
        [
            'grafanaRole' => 'ADMIN|EDITOR|VIEWER',
            'id' => '<string>',
            'isDisabled' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'workspaceId' => '<string>',
]

Result Details

Members
nextToken
Type: string

The token to use when requesting the next set of service accounts.

serviceAccounts
Required: Yes
Type: Array of ServiceAccountSummary structures

An array of structures containing information about the service accounts.

workspaceId
Required: Yes
Type: string

The workspace to which the service accounts are associated.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

ListWorkspaces

$result = $client->listWorkspaces([/* ... */]);
$promise = $client->listWorkspacesAsync([/* ... */]);

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.

Parameter Syntax

$result = $client->listWorkspaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of workspaces to include in the results.

nextToken
Type: string

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

Result Syntax

[
    'nextToken' => '<string>',
    'workspaces' => [
        [
            'authentication' => [
                'providers' => ['<string>', ...],
                'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
            ],
            'created' => <DateTime>,
            'description' => '<string>',
            'endpoint' => '<string>',
            'grafanaToken' => '<string>',
            'grafanaVersion' => '<string>',
            'id' => '<string>',
            'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
            'modified' => <DateTime>,
            'name' => '<string>',
            'notificationDestinations' => ['<string>', ...],
            'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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

workspaces
Required: Yes
Type: Array of WorkspaceSummary structures

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

Errors

ThrottlingException:

The request was denied because of request throttling. Retry the request.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource the tag is associated with.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

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

tagKeys
Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

UpdatePermissions

$result = $client->updatePermissions([/* ... */]);
$promise = $client->updatePermissionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updatePermissions([
    'updateInstructionBatch' => [ // REQUIRED
        [
            'action' => 'ADD|REVOKE', // REQUIRED
            'role' => 'ADMIN|EDITOR|VIEWER', // REQUIRED
            'users' => [ // REQUIRED
                [
                    'id' => '<string>', // REQUIRED
                    'type' => 'SSO_USER|SSO_GROUP', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
updateInstructionBatch
Required: Yes
Type: Array of UpdateInstruction structures

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

workspaceId
Required: Yes
Type: string

The ID of the workspace to update.

Result Syntax

[
    'errors' => [
        [
            'causedBy' => [
                'action' => 'ADD|REVOKE',
                'role' => 'ADMIN|EDITOR|VIEWER',
                'users' => [
                    [
                        'id' => '<string>',
                        'type' => 'SSO_USER|SSO_GROUP',
                    ],
                    // ...
                ],
            ],
            'code' => <integer>,
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
errors
Required: Yes
Type: Array of UpdateError structures

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

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

UpdateWorkspace

$result = $client->updateWorkspace([/* ... */]);
$promise = $client->updateWorkspaceAsync([/* ... */]);

Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.

To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.

To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.

Parameter Syntax

$result = $client->updateWorkspace([
    'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
    'networkAccessControl' => [
        'prefixListIds' => ['<string>', ...], // REQUIRED
        'vpceIds' => ['<string>', ...], // REQUIRED
    ],
    'organizationRoleName' => '<string>',
    'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
    'removeNetworkAccessConfiguration' => true || false,
    'removeVpcConfiguration' => true || false,
    'stackSetName' => '<string>',
    'vpcConfiguration' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
    'workspaceDataSources' => ['<string>', ...],
    'workspaceDescription' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
    'workspaceName' => '<string>',
    'workspaceNotificationDestinations' => ['<string>', ...],
    'workspaceOrganizationalUnits' => ['<string>', ...],
    'workspaceRoleArn' => '<string>',
]);

Parameter Details

Members
accountAccessType
Type: 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.

networkAccessControl
Type: NetworkAccessConfiguration structure

The configuration settings for network access to your workspace.

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

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

organizationRoleName
Type: 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
Type: 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

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.

removeNetworkAccessConfiguration
Type: 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
Type: 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
Type: string

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

vpcConfiguration
Type: VpcConfiguration structure

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

workspaceDataSources
Type: Array of strings

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

workspaceDescription
Type: string

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

workspaceId
Required: Yes
Type: string

The ID of the workspace to update.

workspaceName
Type: string

A new name for the workspace to update.

workspaceNotificationDestinations
Type: Array of strings

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
Type: Array of strings

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

Result Syntax

[
    'workspace' => [
        'accountAccessType' => 'CURRENT_ACCOUNT|ORGANIZATION',
        'authentication' => [
            'providers' => ['<string>', ...],
            'samlConfigurationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        ],
        'created' => <DateTime>,
        'dataSources' => ['<string>', ...],
        'description' => '<string>',
        'endpoint' => '<string>',
        'freeTrialConsumed' => true || false,
        'freeTrialExpiration' => <DateTime>,
        'grafanaToken' => '<string>',
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<string>',
        'networkAccessControl' => [
            'prefixListIds' => ['<string>', ...],
            'vpceIds' => ['<string>', ...],
        ],
        'notificationDestinations' => ['<string>', ...],
        'organizationRoleName' => '<string>',
        'organizationalUnits' => ['<string>', ...],
        'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
        'stackSetName' => '<string>',
        'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED|VERSION_UPDATING|VERSION_UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'vpcConfiguration' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
        ],
        'workspaceRoleArn' => '<string>',
    ],
]

Result Details

Members
workspace
Required: Yes
Type: WorkspaceDescription structure

A structure containing data about the workspace that was created.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

UpdateWorkspaceAuthentication

$result = $client->updateWorkspaceAuthentication([/* ... */]);
$promise = $client->updateWorkspaceAuthenticationAsync([/* ... */]);

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

Changes to the authentication method for a workspace may take a few minutes to take effect.

Parameter Syntax

$result = $client->updateWorkspaceAuthentication([
    'authenticationProviders' => ['<string>', ...], // REQUIRED
    'samlConfiguration' => [
        'allowedOrganizations' => ['<string>', ...],
        'assertionAttributes' => [
            'email' => '<string>',
            'groups' => '<string>',
            'login' => '<string>',
            'name' => '<string>',
            'org' => '<string>',
            'role' => '<string>',
        ],
        'idpMetadata' => [ // REQUIRED
            'url' => '<string>',
            'xml' => '<string>',
        ],
        'loginValidityDuration' => <integer>,
        'roleValues' => [
            'admin' => ['<string>', ...],
            'editor' => ['<string>', ...],
        ],
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
authenticationProviders
Required: Yes
Type: Array of strings

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
Type: SamlConfiguration structure

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.

workspaceId
Required: Yes
Type: string

The ID of the workspace to update the authentication for.

Result Syntax

[
    'authentication' => [
        'awsSso' => [
            'ssoClientId' => '<string>',
        ],
        'providers' => ['<string>', ...],
        'saml' => [
            'configuration' => [
                'allowedOrganizations' => ['<string>', ...],
                'assertionAttributes' => [
                    'email' => '<string>',
                    'groups' => '<string>',
                    'login' => '<string>',
                    'name' => '<string>',
                    'org' => '<string>',
                    'role' => '<string>',
                ],
                'idpMetadata' => [
                    'url' => '<string>',
                    'xml' => '<string>',
                ],
                'loginValidityDuration' => <integer>,
                'roleValues' => [
                    'admin' => ['<string>', ...],
                    'editor' => ['<string>', ...],
                ],
            ],
            'status' => 'CONFIGURED|NOT_CONFIGURED',
        ],
    ],
]

Result Details

Members
authentication
Required: Yes
Type: AuthenticationDescription structure

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

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

UpdateWorkspaceConfiguration

$result = $client->updateWorkspaceConfiguration([/* ... */]);
$promise = $client->updateWorkspaceConfigurationAsync([/* ... */]);

Updates the configuration string for the given workspace

Parameter Syntax

$result = $client->updateWorkspaceConfiguration([
    'configuration' => '<string>', // REQUIRED
    'grafanaVersion' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
configuration
Required: Yes
Type: string (string|number|array|map or anything parsable by json_encode)

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

grafanaVersion
Type: 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
Required: Yes
Type: string

The ID of the workspace to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The request references a resource that does not exist.

ThrottlingException:

The request was denied because of request throttling. Retry the request.

ConflictException:

A resource was in an inconsistent state during an update or a deletion.

ValidationException:

The value of a parameter in the request caused an error.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

Unexpected error while processing the request. Retry the request.

Shapes

AccessDeniedException

Description

You do not have sufficient permissions to perform this action.

Members
message
Required: Yes
Type: string

AssertionAttributes

Description

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

Members
email
Type: string

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

groups
Type: string

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

login
Type: string

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

name
Type: string

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

org
Type: string

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

role
Type: string

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

AuthenticationDescription

Description

A structure containing information about the user authentication methods used by the workspace.

Members
awsSso
Type: AwsSsoAuthentication structure

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

providers
Required: Yes
Type: Array of strings

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
Type: SamlAuthentication structure

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.

AuthenticationSummary

Description

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

Members
providers
Required: Yes
Type: Array of strings

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

samlConfigurationStatus
Type: string

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

AwsSsoAuthentication

Description

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

Members
ssoClientId
Type: string

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

ConflictException

Description

A resource was in an inconsistent state during an update or a deletion.

Members
message
Required: Yes
Type: string

A description of the error.

resourceId
Required: Yes
Type: string

The ID of the resource that is associated with the error.

resourceType
Required: Yes
Type: string

The type of the resource that is associated with the error.

IdpMetadata

Description

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter. Specifying both will cause an error.

Members
url
Type: string

The URL of the location containing the IdP metadata.

xml
Type: string

The full IdP metadata, in XML format.

InternalServerException

Description

Unexpected error while processing the request. Retry the request.

Members
message
Required: Yes
Type: string

A description of the error.

retryAfterSeconds
Type: int

How long to wait before you retry this operation.

NetworkAccessConfiguration

Description

The configuration settings for in-bound 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 are still required.

Access is granted to a caller that is in either the IP address list or the VPC endpoint list - they do not need to be in both.

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

While both prefixListIds and vpceIds are required, you can pass in an empty array of strings for either parameter if you do not want to allow any of that type.

If both are passed as empty arrays, no traffic is allowed to the workspace, because only explicitly allowed connections are accepted.

Members
prefixListIds
Required: Yes
Type: Array of strings

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: Yes
Type: Array of strings

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.

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.

PermissionEntry

Description

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

Members
role
Required: Yes
Type: string

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

user
Required: Yes
Type: User structure

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

ResourceNotFoundException

Description

The request references a resource that does not exist.

Members
message
Required: Yes
Type: string

The value of a parameter in the request caused an error.

resourceId
Required: Yes
Type: string

The ID of the resource that is associated with the error.

resourceType
Required: Yes
Type: string

The type of the resource that is associated with the error.

RoleValues

Description

This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace. SAML authenticated users not part of Admin or Editor role groups have Viewer permission over the workspace.

Members
admin
Type: Array of strings

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

editor
Type: Array of strings

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

SamlAuthentication

Description

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

Members
configuration
Type: SamlConfiguration structure

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

status
Required: Yes
Type: string

Specifies whether the workspace's SAML configuration is complete.

SamlConfiguration

Description

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

Members
allowedOrganizations
Type: Array of strings

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
Type: AssertionAttributes structure

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.

idpMetadata
Required: Yes
Type: IdpMetadata structure

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

loginValidityDuration
Type: int

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

roleValues
Type: RoleValues structure

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

ServiceAccountSummary

Description

A structure that contains the information about one service account.

Members
grafanaRole
Required: Yes
Type: string

The role of the service account, which sets the permission level used when calling Grafana APIs.

id
Required: Yes
Type: string

The unique ID of the service account.

isDisabled
Required: Yes
Type: string

Returns true if the service account is disabled. Service accounts can be disabled and enabled in the Amazon Managed Grafana console.

name
Required: Yes
Type: string

The name of the service account.

ServiceAccountTokenSummary

Description

A structure that contains the information about a service account token.

Members
createdAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the service account token was created.

expiresAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the service account token will expire.

id
Required: Yes
Type: string

The unique ID of the service account token.

lastUsedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the token was used to authorize a Grafana HTTP API.

name
Required: Yes
Type: string

The name of the service account token.

ServiceAccountTokenSummaryWithKey

Description

A structure that contains the information about a service account token.

This structure is returned when creating the token. It is important to store the key that is returned, as it is not retrievable at a later time.

If you lose the key, you can delete and recreate the token, which will create a new key.

Members
id
Required: Yes
Type: string

The unique ID of the service account token.

key
Required: Yes
Type: string

The key for the service account token. Used when making calls to the Grafana HTTP APIs to authenticate and authorize the requests.

name
Required: Yes
Type: string

The name of the service account token.

ServiceQuotaExceededException

Description

The request would cause a service quota to be exceeded.

Members
message
Required: Yes
Type: string

A description of the error.

quotaCode
Required: Yes
Type: string

The ID of the service quota that was exceeded.

resourceId
Required: Yes
Type: string

The ID of the resource that is associated with the error.

resourceType
Required: Yes
Type: string

The type of the resource that is associated with the error.

serviceCode
Required: Yes
Type: string

The value of a parameter in the request caused an error.

ThrottlingException

Description

The request was denied because of request throttling. Retry the request.

Members
message
Required: Yes
Type: string

A description of the error.

quotaCode
Type: string

The ID of the service quota that was exceeded.

retryAfterSeconds
Type: int

The value of a parameter in the request caused an error.

serviceCode
Type: string

The ID of the service that is associated with the error.

UpdateError

Description

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

Members
causedBy
Required: Yes
Type: UpdateInstruction structure

Specifies which permission update caused the error.

code
Required: Yes
Type: int

The error code.

message
Required: Yes
Type: string

The message for this error.

UpdateInstruction

Description

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

Members
action
Required: Yes
Type: string

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

role
Required: Yes
Type: string

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

users
Required: Yes
Type: Array of User structures

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

User

Description

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

Members
id
Required: Yes
Type: 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: Yes
Type: string

Specifies whether this is a single user or a group.

ValidationException

Description

The value of a parameter in the request caused an error.

Members
fieldList
Type: Array of ValidationExceptionField structures

A list of fields that might be associated with the error.

message
Required: Yes
Type: string

A description of the error.

reason
Required: Yes
Type: string

The reason that the operation failed.

ValidationExceptionField

Description

A structure that contains information about a request parameter that caused an error.

Members
message
Required: Yes
Type: string

A message describing why this field couldn't be validated.

name
Required: Yes
Type: string

The name of the field that caused the validation error.

VpcConfiguration

Description

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

Provided securityGroupIds and subnetIds must be part of the same VPC.

Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

Members
securityGroupIds
Required: Yes
Type: Array of strings

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

subnetIds
Required: Yes
Type: Array of strings

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

WorkspaceDescription

Description

A structure containing information about an Amazon Managed Grafana workspace in your account.

Members
accountAccessType
Type: string

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

authentication
Required: Yes
Type: AuthenticationSummary structure

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

created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the workspace was created.

dataSources
Required: Yes
Type: Array of strings

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
Type: string

The user-defined description of the workspace.

endpoint
Required: Yes
Type: string

The URL that users can use to access the Grafana console in the workspace.

freeTrialConsumed
Type: boolean

Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

freeTrialExpiration
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

grafanaToken
Type: string

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

grafanaVersion
Required: Yes
Type: string

The version of Grafana supported in this workspace.

id
Required: Yes
Type: string

The unique ID of this workspace.

licenseExpiration
Type: timestamp (string|DateTime or anything parsable by strtotime)

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
Type: string

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

modified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The most recent date that the workspace was modified.

name
Type: string

The name of the workspace.

networkAccessControl
Type: NetworkAccessConfiguration structure

The configuration settings for network access to your workspace.

notificationDestinations
Type: Array of strings

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
Type: string

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

organizationalUnits
Type: Array of strings

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
Type: string

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

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

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

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

stackSetName
Type: string

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

status
Required: Yes
Type: string

The current status of the workspace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags associated with the workspace.

vpcConfiguration
Type: VpcConfiguration structure

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

workspaceRoleArn
Type: 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.

WorkspaceSummary

Description

A structure that contains some information about one workspace in the account.

Members
authentication
Required: Yes
Type: AuthenticationSummary structure

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

created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the workspace was created.

description
Type: string

The customer-entered description of the workspace.

endpoint
Required: Yes
Type: string

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

grafanaToken
Type: string

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

grafanaVersion
Required: Yes
Type: string

The Grafana version that the workspace is running.

id
Required: Yes
Type: string

The unique ID of the workspace.

licenseType
Type: string

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

modified
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The most recent date that the workspace was modified.

name
Type: string

The name of the workspace.

notificationDestinations
Type: Array of strings

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: Yes
Type: string

The current status of the workspace.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags associated with the workspace.