AWS 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.
DeleteWorkspace ( array $params = [] )
Deletes an Amazon Managed Grafana workspace.
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.
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.
ListWorkspaces ( array $params = [] )
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
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.

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
ListWorkspaces

Operations

AssociateLicense

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

Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.

Parameter Syntax

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

Parameter Details

Members

licenseType

Required: Yes
Type: string

The type of license to associate with the workspace.

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>,
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<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',
        '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>',
    'organizationRoleName' => '<string>',
    'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED', // REQUIRED
    'stackSetName' => '<string>',
    '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, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.

clientToken

Type: string

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

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

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

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

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

stackSetName

Type: string

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

workspaceDataSources

Type: Array of strings

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

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

workspaceDescription

Type: string

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

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

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

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>,
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<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',
        '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.

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>,
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<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',
        '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.

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>,
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<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',
        '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.
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.

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>,
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<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',
        '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 Amazon Web Services SSO users are returned. If you specify SSO_GROUP, only the permissions of Amazon Web Services SSO 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',
            '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.

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>',
            'grafanaVersion' => '<string>',
            'id' => '<string>',
            'modified' => <DateTime>,
            'name' => '<string>',
            'notificationDestinations' => ['<string>', ...],
            'status' => 'ACTIVE|CREATING|DELETING|FAILED|UPDATING|UPGRADING|DELETION_FAILED|CREATION_FAILED|UPDATE_FAILED|UPGRADE_FAILED|LICENSE_REMOVAL_FAILED',
        ],
        // ...
    ],
]

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.

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', // 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',
                '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 Amazon Web Services SSO, 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',
    'organizationRoleName' => '<string>',
    'permissionType' => 'CUSTOMER_MANAGED|SERVICE_MANAGED',
    'stackSetName' => '<string>',
    'workspaceDataSources' => ['<string>', ...],
    'workspaceDescription' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
    'workspaceName' => '<string>',
    'workspaceNotificationDestinations' => ['<string>', ...],
    'workspaceOrganizationalUnits' => ['<string>', ...],
    'workspaceRoleArn' => '<string>',
]);

Parameter Details

Members

accountAccessType

Type: string

organizationRoleName

Type: string

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

permissionType

Type: string

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

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

stackSetName

Type: string

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

workspaceDataSources

Type: Array of strings

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

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

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

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>,
        'grafanaVersion' => '<string>',
        'id' => '<string>',
        'licenseExpiration' => <DateTime>,
        'licenseType' => 'ENTERPRISE|ENTERPRISE_FREE_TRIAL',
        'modified' => <DateTime>,
        'name' => '<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',
        '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.

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

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.

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

providers

Required: Yes
Type: Array of strings

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

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

Members

ssoClientId

Type: string

The ID of the Amazon Web Services SSO-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.

Members

url

Type: string

The URL of the location containing the metadata.

xml

Type: string

The actual full metadata file, 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.

PermissionEntry

Description

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

Members

role

Required: Yes
Type: string

Specifies whether the user or group has the Admin or Editor 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.

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.

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.

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.

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

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.

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.

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, this specifies when the license ends and will need to be renewed.

licenseType

Type: string

Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.

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

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

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

stackSetName

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.

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.

grafanaVersion

Required: Yes
Type: string

The Grafana version that the workspace is running.

id

Required: Yes
Type: string

The unique ID of the workspace.

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.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Managed Grafana 2020-08-18

Operation Summary

Paginators

Operations

AssociateLicense

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateWorkspace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteWorkspace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeWorkspace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeWorkspaceAuthentication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateLicense

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListPermissions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListWorkspaces

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdatePermissions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details