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

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.

Usage example
client = boto3.client("grafana")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_grafana.client import Exceptions

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

Methods

associate_license

Assigns a Grafana Enterprise license to a workspace.

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

Method definition
def associate_license(
    self,
    *,
    licenseType: LicenseTypeType,  # (1)
    workspaceId: str,
) -> AssociateLicenseResponseTypeDef:  # (2)
    ...
  1. See LicenseTypeType
  2. See AssociateLicenseResponseTypeDef
Usage example with kwargs
kwargs: AssociateLicenseRequestRequestTypeDef = {  # (1)
    "licenseType": ...,
    "workspaceId": ...,
}

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

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

create_workspace

Creates a workspace.

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

Method definition
def create_workspace(
    self,
    *,
    accountAccessType: AccountAccessTypeType,  # (1)
    authenticationProviders: Sequence[AuthenticationProviderTypesType],  # (2)
    permissionType: PermissionTypeType,  # (3)
    clientToken: str = ...,
    organizationRoleName: str = ...,
    stackSetName: str = ...,
    tags: Mapping[str, str] = ...,
    workspaceDataSources: Sequence[DataSourceTypeType] = ...,  # (4)
    workspaceDescription: str = ...,
    workspaceName: str = ...,
    workspaceNotificationDestinations: Sequence[NotificationDestinationTypeType] = ...,  # (5)
    workspaceOrganizationalUnits: Sequence[str] = ...,
    workspaceRoleArn: str = ...,
) -> CreateWorkspaceResponseTypeDef:  # (6)
    ...
  1. See AccountAccessTypeType
  2. See AuthenticationProviderTypesType
  3. See PermissionTypeType
  4. See DataSourceTypeType
  5. See NotificationDestinationTypeType
  6. See CreateWorkspaceResponseTypeDef
Usage example with kwargs
kwargs: CreateWorkspaceRequestRequestTypeDef = {  # (1)
    "accountAccessType": ...,
    "authenticationProviders": ...,
    "permissionType": ...,
}

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

create_workspace_api_key

Creates an API key for the workspace.

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

Method definition
def create_workspace_api_key(
    self,
    *,
    keyName: str,
    keyRole: str,
    secondsToLive: int,
    workspaceId: str,
) -> CreateWorkspaceApiKeyResponseTypeDef:  # (1)
    ...
  1. See CreateWorkspaceApiKeyResponseTypeDef
Usage example with kwargs
kwargs: CreateWorkspaceApiKeyRequestRequestTypeDef = {  # (1)
    "keyName": ...,
    "keyRole": ...,
    "secondsToLive": ...,
    "workspaceId": ...,
}

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

delete_workspace

Deletes an Amazon Managed Grafana workspace.

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

Method definition
def delete_workspace(
    self,
    *,
    workspaceId: str,
) -> DeleteWorkspaceResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkspaceResponseTypeDef
Usage example with kwargs
kwargs: DeleteWorkspaceRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

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

delete_workspace_api_key

Deletes an API key for a workspace.

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

Method definition
def delete_workspace_api_key(
    self,
    *,
    keyName: str,
    workspaceId: str,
) -> DeleteWorkspaceApiKeyResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkspaceApiKeyResponseTypeDef
Usage example with kwargs
kwargs: DeleteWorkspaceApiKeyRequestRequestTypeDef = {  # (1)
    "keyName": ...,
    "workspaceId": ...,
}

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

describe_workspace

Displays information about one Amazon Managed Grafana workspace.

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

Method definition
def describe_workspace(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceResponseTypeDef:  # (1)
    ...
  1. See DescribeWorkspaceResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_workspace_authentication(
    self,
    *,
    workspaceId: str,
) -> DescribeWorkspaceAuthenticationResponseTypeDef:  # (1)
    ...
  1. See DescribeWorkspaceAuthenticationResponseTypeDef
Usage example with kwargs
kwargs: DescribeWorkspaceAuthenticationRequestRequestTypeDef = {  # (1)
    "workspaceId": ...,
}

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

disassociate_license

Removes the Grafana Enterprise license from a workspace.

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

Method definition
def disassociate_license(
    self,
    *,
    licenseType: LicenseTypeType,  # (1)
    workspaceId: str,
) -> DisassociateLicenseResponseTypeDef:  # (2)
    ...
  1. See LicenseTypeType
  2. See DisassociateLicenseResponseTypeDef
Usage example with kwargs
kwargs: DisassociateLicenseRequestRequestTypeDef = {  # (1)
    "licenseType": ...,
    "workspaceId": ...,
}

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

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

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

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
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

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

Method definition
def list_workspaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef:  # (1)
    ...
  1. See ListWorkspacesResponseTypeDef
Usage example with kwargs
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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def update_permissions(
    self,
    *,
    updateInstructionBatch: Sequence[UpdateInstructionTypeDef],  # (1)
    workspaceId: str,
) -> UpdatePermissionsResponseTypeDef:  # (2)
    ...
  1. See UpdateInstructionTypeDef
  2. See UpdatePermissionsResponseTypeDef
Usage example with kwargs
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

Method definition
def update_workspace(
    self,
    *,
    workspaceId: str,
    accountAccessType: AccountAccessTypeType = ...,  # (1)
    organizationRoleName: str = ...,
    permissionType: PermissionTypeType = ...,  # (2)
    stackSetName: str = ...,
    workspaceDataSources: Sequence[DataSourceTypeType] = ...,  # (3)
    workspaceDescription: str = ...,
    workspaceName: str = ...,
    workspaceNotificationDestinations: Sequence[NotificationDestinationTypeType] = ...,  # (4)
    workspaceOrganizationalUnits: Sequence[str] = ...,
    workspaceRoleArn: str = ...,
) -> UpdateWorkspaceResponseTypeDef:  # (5)
    ...
  1. See AccountAccessTypeType
  2. See PermissionTypeType
  3. See DataSourceTypeType
  4. See NotificationDestinationTypeType
  5. See UpdateWorkspaceResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
kwargs: UpdateWorkspaceAuthenticationRequestRequestTypeDef = {  # (1)
    "authenticationProviders": ...,
    "workspaceId": ...,
}

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

get_paginator

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