Skip to content

ManagedGrafanaClient#

Index > ManagedGrafana > ManagedGrafanaClient

Auto-generated documentation for ManagedGrafana type annotations stubs module mypy-boto3-grafana.

ManagedGrafanaClient#

Type annotations and code completion for boto3.client("grafana"). boto3 documentation

# ManagedGrafanaClient usage example

from boto3.session import Session
from mypy_boto3_grafana.client import ManagedGrafanaClient

def get_grafana_client() -> ManagedGrafanaClient:
    return Session().client("grafana")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("grafana").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("grafana")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_grafana.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("grafana").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("grafana").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_license#

Assigns a Grafana Enterprise license to a workspace.

Type annotations and code completion for boto3.client("grafana").associate_license method. boto3 documentation

# associate_license method definition

def associate_license(
    self,
    *,
    licenseType: LicenseTypeType,  # (1)
    workspaceId: str,
    grafanaToken: str = ...,
) -> AssociateLicenseResponseTypeDef:  # (2)
    ...
  1. See LicenseTypeType
  2. See AssociateLicenseResponseTypeDef 
# associate_license method usage example with argument unpacking

kwargs: AssociateLicenseRequestRequestTypeDef = {  # (1)
    "licenseType": ...,
    "workspaceId": ...,
}

parent.associate_license(**kwargs)
  1. See AssociateLicenseRequestRequestTypeDef

create_workspace#

Creates a workspace.

Type annotations and code completion for boto3.client("grafana").create_workspace method. boto3 documentation

# create_workspace method definition

def create_workspace(
    self,
    *,
    accountAccessType: AccountAccessTypeType,  # (1)
    authenticationProviders: Sequence[AuthenticationProviderTypesType],  # (2)
    permissionType: PermissionTypeType,  # (3)
    clientToken: str = ...,
    configuration: str = ...,
    grafanaVersion: str = ...,
    networkAccessControl: NetworkAccessConfigurationTypeDef = ...,  # (4)
    organizationRoleName: str = ...,
    stackSetName: str = ...,
    tags: Mapping[str, str] = ...,
    vpcConfiguration: VpcConfigurationTypeDef = ...,  # (5)
    workspaceDataSources: Sequence[DataSourceTypeType] = ...,  # (6)
    workspaceDescription: str = ...,
    workspaceName: str = ...,
    workspaceNotificationDestinations: Sequence[NotificationDestinationTypeType] = ...,  # (7)
    workspaceOrganizationalUnits: Sequence[str] = ...,
    workspaceRoleArn: str = ...,
) -> CreateWorkspaceResponseTypeDef:  # (8)
    ...
  1. See AccountAccessTypeType
  2. See AuthenticationProviderTypesType
  3. See PermissionTypeType
  4. See NetworkAccessConfigurationTypeDef
  5. See VpcConfigurationTypeDef
  6. See DataSourceTypeType
  7. See NotificationDestinationTypeType
  8. See CreateWorkspaceResponseTypeDef 
# create_workspace method usage example with argument unpacking

kwargs: CreateWorkspaceRequestRequestTypeDef = {  # (1)
    "accountAccessType": ...,
    "authenticationProviders": ...,
    "permissionType": ...,
}

parent.create_workspace(**kwargs)
  1. See CreateWorkspaceRequestRequestTypeDef

create_workspace_api_key#

Creates a Grafana API key for the workspace.

Type annotations and code completion for boto3.client("grafana").create_workspace_api_key method. boto3 documentation

# create_workspace_api_key method definition

def create_workspace_api_key(
    self,
    *,
    keyName: str,
    keyRole: str,
    secondsToLive: int,
    workspaceId: str,
) -> CreateWorkspaceApiKeyResponseTypeDef:  # (1)
    ...
  1. See CreateWorkspaceApiKeyResponseTypeDef 
# create_workspace_api_key method usage example with argument unpacking

kwargs: CreateWorkspaceApiKeyRequestRequestTypeDef = {  # (1)
    "keyName": ...,
    "keyRole": ...,
    "secondsToLive": ...,
    "workspaceId": ...,
}

parent.create_workspace_api_key(**kwargs)
  1. See CreateWorkspaceApiKeyRequestRequestTypeDef

create_workspace_service_account#

Creates a service account for the workspace.

Type annotations and code completion for boto3.client("grafana").create_workspace_service_account method. boto3 documentation

# create_workspace_service_account method definition

def create_workspace_service_account(
    self,
    *,
    grafanaRole: RoleType,  # (1)
    name: str,
    workspaceId: str,
) -> CreateWorkspaceServiceAccountResponseTypeDef:  # (2)
    ...
  1. See RoleType
  2. See CreateWorkspaceServiceAccountResponseTypeDef 
# create_workspace_service_account method usage example with argument unpacking

kwargs: CreateWorkspaceServiceAccountRequestRequestTypeDef = {  # (1)
    "grafanaRole": ...,
    "name": ...,
    "workspaceId": ...,
}

parent.create_workspace_service_account(**kwargs)
  1. See CreateWorkspaceServiceAccountRequestRequestTypeDef

create_workspace_service_account_token#

Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.

Type annotations and code completion for boto3.client("grafana").create_workspace_service_account_token method. boto3 documentation

# create_workspace_service_account_token method definition

def create_workspace_service_account_token(
    self,
    *,
    name: str,
    secondsToLive: int,
    serviceAccountId: str,
    workspaceId: str,
) -> CreateWorkspaceServiceAccountTokenResponseTypeDef:  # (1)
    ...
  1. See CreateWorkspaceServiceAccountTokenResponseTypeDef 
# create_workspace_service_account_token method usage example with argument unpacking

kwargs: CreateWorkspaceServiceAccountTokenRequestRequestTypeDef = {  # (1)
    "name": ...,
    "secondsToLive": ...,
    "serviceAccountId": ...,
    "workspaceId": ...,
}

parent.create_workspace_service_account_token(**kwargs)
  1. See CreateWorkspaceServiceAccountTokenRequestRequestTypeDef

delete_workspace#

Deletes an Amazon Managed Grafana workspace.

Type annotations and code completion for boto3.client("grafana").delete_workspace method. boto3 documentation

# delete_workspace method definition

def delete_workspace(
    self,
    *,
    workspaceId: str,
) -> DeleteWorkspaceResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkspaceResponseTypeDef 
# delete_workspace method usage example with argument unpacking

kwargs: DeleteWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.delete_workspace(**kwargs)
  1. See DeleteWorkspaceRequestRequestTypeDef

delete_workspace_api_key#

Deletes a Grafana API key for the workspace.

Type annotations and code completion for boto3.client("grafana").delete_workspace_api_key method. boto3 documentation

# delete_workspace_api_key method definition

def delete_workspace_api_key(
    self,
    *,
    keyName: str,
    workspaceId: str,
) -> DeleteWorkspaceApiKeyResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkspaceApiKeyResponseTypeDef 
# delete_workspace_api_key method usage example with argument unpacking

kwargs: DeleteWorkspaceApiKeyRequestRequestTypeDef = {  # (1)
    "keyName": ...,
    "workspaceId": ...,
}

parent.delete_workspace_api_key(**kwargs)
  1. See DeleteWorkspaceApiKeyRequestRequestTypeDef

delete_workspace_service_account#

Deletes a workspace service account from the workspace.

Type annotations and code completion for boto3.client("grafana").delete_workspace_service_account method. boto3 documentation

# delete_workspace_service_account method definition

def delete_workspace_service_account(
    self,
    *,
    serviceAccountId: str,
    workspaceId: str,
) -> DeleteWorkspaceServiceAccountResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkspaceServiceAccountResponseTypeDef 
# delete_workspace_service_account method usage example with argument unpacking

kwargs: DeleteWorkspaceServiceAccountRequestRequestTypeDef = {  # (1)
    "serviceAccountId": ...,
    "workspaceId": ...,
}

parent.delete_workspace_service_account(**kwargs)
  1. See DeleteWorkspaceServiceAccountRequestRequestTypeDef

delete_workspace_service_account_token#

Deletes a token for the workspace service account.

Type annotations and code completion for boto3.client("grafana").delete_workspace_service_account_token method. boto3 documentation

# delete_workspace_service_account_token method definition

def delete_workspace_service_account_token(
    self,
    *,
    serviceAccountId: str,
    tokenId: str,
    workspaceId: str,
) -> DeleteWorkspaceServiceAccountTokenResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkspaceServiceAccountTokenResponseTypeDef 
# delete_workspace_service_account_token method usage example with argument unpacking

kwargs: DeleteWorkspaceServiceAccountTokenRequestRequestTypeDef = {  # (1)
    "serviceAccountId": ...,
    "tokenId": ...,
    "workspaceId": ...,
}

parent.delete_workspace_service_account_token(**kwargs)
  1. See DeleteWorkspaceServiceAccountTokenRequestRequestTypeDef

describe_workspace#

Displays information about one Amazon Managed Grafana workspace.

Type annotations and code completion for boto3.client("grafana").describe_workspace method. boto3 documentation

# describe_workspace method definition

def describe_workspace(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceResponseTypeDef:  # (1)
    ...
  1. See DescribeWorkspaceResponseTypeDef 
# describe_workspace method usage example with argument unpacking

kwargs: DescribeWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_workspace(**kwargs)
  1. See DescribeWorkspaceRequestRequestTypeDef

describe_workspace_authentication#

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

Type annotations and code completion for boto3.client("grafana").describe_workspace_authentication method. boto3 documentation

# describe_workspace_authentication method definition

def describe_workspace_authentication(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceAuthenticationResponseTypeDef:  # (1)
    ...
  1. See DescribeWorkspaceAuthenticationResponseTypeDef 
# describe_workspace_authentication method usage example with argument unpacking

kwargs: DescribeWorkspaceAuthenticationRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_workspace_authentication(**kwargs)
  1. See DescribeWorkspaceAuthenticationRequestRequestTypeDef

describe_workspace_configuration#

Gets the current configuration string for the given workspace.

Type annotations and code completion for boto3.client("grafana").describe_workspace_configuration method. boto3 documentation

# describe_workspace_configuration method definition

def describe_workspace_configuration(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeWorkspaceConfigurationResponseTypeDef 
# describe_workspace_configuration method usage example with argument unpacking

kwargs: DescribeWorkspaceConfigurationRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.describe_workspace_configuration(**kwargs)
  1. See DescribeWorkspaceConfigurationRequestRequestTypeDef

disassociate_license#

Removes the Grafana Enterprise license from a workspace.

Type annotations and code completion for boto3.client("grafana").disassociate_license method. boto3 documentation

# disassociate_license method definition

def disassociate_license(
    self,
    *,
    licenseType: LicenseTypeType,  # (1)
    workspaceId: str,
) -> DisassociateLicenseResponseTypeDef:  # (2)
    ...
  1. See LicenseTypeType
  2. See DisassociateLicenseResponseTypeDef 
# disassociate_license method usage example with argument unpacking

kwargs: DisassociateLicenseRequestRequestTypeDef = {  # (1)
    "licenseType": ...,
    "workspaceId": ...,
}

parent.disassociate_license(**kwargs)
  1. See DisassociateLicenseRequestRequestTypeDef

list_permissions#

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.

Type annotations and code completion for boto3.client("grafana").list_permissions method. boto3 documentation

# list_permissions method definition

def list_permissions(
    self,
    *,
    workspaceId: str,
    groupId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    userId: str = ...,
    userType: UserTypeType = ...,  # (1)
) -> ListPermissionsResponseTypeDef:  # (2)
    ...
  1. See UserTypeType
  2. See ListPermissionsResponseTypeDef 
# list_permissions method usage example with argument unpacking

kwargs: ListPermissionsRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.list_permissions(**kwargs)
  1. See ListPermissionsRequestRequestTypeDef

list_tags_for_resource#

The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn.

Type annotations and code completion for boto3.client("grafana").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_versions#

Lists available versions of Grafana.

Type annotations and code completion for boto3.client("grafana").list_versions method. boto3 documentation

# list_versions method definition

def list_versions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    workspaceId: str = ...,
) -> ListVersionsResponseTypeDef:  # (1)
    ...
  1. See ListVersionsResponseTypeDef 
# list_versions method usage example with argument unpacking

kwargs: ListVersionsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_versions(**kwargs)
  1. See ListVersionsRequestRequestTypeDef

list_workspace_service_account_tokens#

Returns a list of tokens for a workspace service account.

Type annotations and code completion for boto3.client("grafana").list_workspace_service_account_tokens method. boto3 documentation

# list_workspace_service_account_tokens method definition

def list_workspace_service_account_tokens(
    self,
    *,
    serviceAccountId: str,
    workspaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspaceServiceAccountTokensResponseTypeDef:  # (1)
    ...
  1. See ListWorkspaceServiceAccountTokensResponseTypeDef 
# list_workspace_service_account_tokens method usage example with argument unpacking

kwargs: ListWorkspaceServiceAccountTokensRequestRequestTypeDef = {  # (1)
    "serviceAccountId": ...,
    "workspaceId": ...,
}

parent.list_workspace_service_account_tokens(**kwargs)
  1. See ListWorkspaceServiceAccountTokensRequestRequestTypeDef

list_workspace_service_accounts#

Returns a list of service accounts for a workspace.

Type annotations and code completion for boto3.client("grafana").list_workspace_service_accounts method. boto3 documentation

# list_workspace_service_accounts method definition

def list_workspace_service_accounts(
    self,
    *,
    workspaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspaceServiceAccountsResponseTypeDef:  # (1)
    ...
  1. See ListWorkspaceServiceAccountsResponseTypeDef 
# list_workspace_service_accounts method usage example with argument unpacking

kwargs: ListWorkspaceServiceAccountsRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.list_workspace_service_accounts(**kwargs)
  1. See ListWorkspaceServiceAccountsRequestRequestTypeDef

list_workspaces#

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.

Type annotations and code completion for boto3.client("grafana").list_workspaces method. boto3 documentation

# list_workspaces method definition

def list_workspaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef:  # (1)
    ...
  1. See ListWorkspacesResponseTypeDef 
# list_workspaces method usage example with argument unpacking

kwargs: ListWorkspacesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_workspaces(**kwargs)
  1. See ListWorkspacesRequestRequestTypeDef

tag_resource#

The TagResource operation associates tags with an Amazon Managed Grafana resource.

Type annotations and code completion for boto3.client("grafana").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

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

Type annotations and code completion for boto3.client("grafana").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_permissions#

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

Type annotations and code completion for boto3.client("grafana").update_permissions method. boto3 documentation

# update_permissions method definition

def update_permissions(
    self,
    *,
    updateInstructionBatch: Sequence[UpdateInstructionUnionTypeDef],  # (1)
    workspaceId: str,
) -> UpdatePermissionsResponseTypeDef:  # (2)
    ...
  1. See UpdateInstructionTypeDef UpdateInstructionOutputTypeDef
  2. See UpdatePermissionsResponseTypeDef 
# update_permissions method usage example with argument unpacking

kwargs: UpdatePermissionsRequestRequestTypeDef = {  # (1)
    "updateInstructionBatch": ...,
    "workspaceId": ...,
}

parent.update_permissions(**kwargs)
  1. See UpdatePermissionsRequestRequestTypeDef

update_workspace#

Modifies an existing Amazon Managed Grafana workspace.

Type annotations and code completion for boto3.client("grafana").update_workspace method. boto3 documentation

# update_workspace method definition

def update_workspace(
    self,
    *,
    workspaceId: str,
    accountAccessType: AccountAccessTypeType = ...,  # (1)
    networkAccessControl: NetworkAccessConfigurationTypeDef = ...,  # (2)
    organizationRoleName: str = ...,
    permissionType: PermissionTypeType = ...,  # (3)
    removeNetworkAccessConfiguration: bool = ...,
    removeVpcConfiguration: bool = ...,
    stackSetName: str = ...,
    vpcConfiguration: VpcConfigurationTypeDef = ...,  # (4)
    workspaceDataSources: Sequence[DataSourceTypeType] = ...,  # (5)
    workspaceDescription: str = ...,
    workspaceName: str = ...,
    workspaceNotificationDestinations: Sequence[NotificationDestinationTypeType] = ...,  # (6)
    workspaceOrganizationalUnits: Sequence[str] = ...,
    workspaceRoleArn: str = ...,
) -> UpdateWorkspaceResponseTypeDef:  # (7)
    ...
  1. See AccountAccessTypeType
  2. See NetworkAccessConfigurationTypeDef
  3. See PermissionTypeType
  4. See VpcConfigurationTypeDef
  5. See DataSourceTypeType
  6. See NotificationDestinationTypeType
  7. See UpdateWorkspaceResponseTypeDef 
# update_workspace method usage example with argument unpacking

kwargs: UpdateWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

parent.update_workspace(**kwargs)
  1. See UpdateWorkspaceRequestRequestTypeDef

update_workspace_authentication#

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.

Type annotations and code completion for boto3.client("grafana").update_workspace_authentication method. boto3 documentation

# update_workspace_authentication method definition

def update_workspace_authentication(
    self,
    *,
    authenticationProviders: Sequence[AuthenticationProviderTypesType],  # (1)
    workspaceId: str,
    samlConfiguration: SamlConfigurationTypeDef = ...,  # (2)
) -> UpdateWorkspaceAuthenticationResponseTypeDef:  # (3)
    ...
  1. See AuthenticationProviderTypesType
  2. See SamlConfigurationTypeDef
  3. See UpdateWorkspaceAuthenticationResponseTypeDef 
# update_workspace_authentication method usage example with argument unpacking

kwargs: UpdateWorkspaceAuthenticationRequestRequestTypeDef = {  # (1)
    "authenticationProviders": ...,
    "workspaceId": ...,
}

parent.update_workspace_authentication(**kwargs)
  1. See UpdateWorkspaceAuthenticationRequestRequestTypeDef

update_workspace_configuration#

Updates the configuration string for the given workspace.

Type annotations and code completion for boto3.client("grafana").update_workspace_configuration method. boto3 documentation

# update_workspace_configuration method definition

def update_workspace_configuration(
    self,
    *,
    configuration: str,
    workspaceId: str,
    grafanaVersion: str = ...,
) -> dict[str, Any]:
    ...
# update_workspace_configuration method usage example with argument unpacking

kwargs: UpdateWorkspaceConfigurationRequestRequestTypeDef = {  # (1)
    "configuration": ...,
    "workspaceId": ...,
}

parent.update_workspace_configuration(**kwargs)
  1. See UpdateWorkspaceConfigurationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("grafana").get_paginator method with overloads.