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

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

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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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.

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

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

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

Result Syntax

[]

Result Details

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.