ManagedGrafanaClient#
Index > ManagedGrafana > ManagedGrafanaClient
Auto-generated documentation for ManagedGrafana type annotations stubs module types-aiobotocore-grafana.
ManagedGrafanaClient#
Type annotations and code completion for session.create_client("grafana")
boto3 documentation
ManagedGrafanaClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_grafana.client import ManagedGrafanaClient
session = get_session()
async with session.create_client("grafana") as client:
client: ManagedGrafanaClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("grafana").exceptions
structure.
ManagedGrafanaClient.exceptions usage example
async with session.create_client("grafana") as client:
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)
ManagedGrafanaClient usage type checking example
from types_aiobotocore_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 session.create_client("grafana").associate_license
method.
boto3 documentation
# associate_license method definition
await def associate_license(
self,
*,
licenseType: LicenseTypeType, # (1)
workspaceId: str,
) -> AssociateLicenseResponseTypeDef: # (2)
...
# associate_license method usage example with argument unpacking
kwargs: AssociateLicenseRequestRequestTypeDef = { # (1)
"licenseType": ...,
"workspaceId": ...,
}
parent.associate_license(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("grafana").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("grafana").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_workspace#
Creates a workspace.
Type annotations and code completion for session.create_client("grafana").create_workspace
method.
boto3 documentation
# create_workspace method definition
await 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)
...
- See AccountAccessTypeType
- See AuthenticationProviderTypesType
- See PermissionTypeType
- See NetworkAccessConfigurationTypeDef
- See VpcConfigurationTypeDef
- See DataSourceTypeType
- See NotificationDestinationTypeType
- See CreateWorkspaceResponseTypeDef
# create_workspace method usage example with argument unpacking
kwargs: CreateWorkspaceRequestRequestTypeDef = { # (1)
"accountAccessType": ...,
"authenticationProviders": ...,
"permissionType": ...,
}
parent.create_workspace(**kwargs)
create_workspace_api_key#
Creates a Grafana API key for the workspace.
Type annotations and code completion for session.create_client("grafana").create_workspace_api_key
method.
boto3 documentation
# create_workspace_api_key method definition
await def create_workspace_api_key(
self,
*,
keyName: str,
keyRole: str,
secondsToLive: int,
workspaceId: str,
) -> CreateWorkspaceApiKeyResponseTypeDef: # (1)
...
# create_workspace_api_key method usage example with argument unpacking
kwargs: CreateWorkspaceApiKeyRequestRequestTypeDef = { # (1)
"keyName": ...,
"keyRole": ...,
"secondsToLive": ...,
"workspaceId": ...,
}
parent.create_workspace_api_key(**kwargs)
delete_workspace#
Deletes an Amazon Managed Grafana workspace.
Type annotations and code completion for session.create_client("grafana").delete_workspace
method.
boto3 documentation
# delete_workspace method definition
await def delete_workspace(
self,
*,
workspaceId: str,
) -> DeleteWorkspaceResponseTypeDef: # (1)
...
# delete_workspace method usage example with argument unpacking
kwargs: DeleteWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.delete_workspace(**kwargs)
delete_workspace_api_key#
Deletes a Grafana API key for the workspace.
Type annotations and code completion for session.create_client("grafana").delete_workspace_api_key
method.
boto3 documentation
# delete_workspace_api_key method definition
await def delete_workspace_api_key(
self,
*,
keyName: str,
workspaceId: str,
) -> DeleteWorkspaceApiKeyResponseTypeDef: # (1)
...
# delete_workspace_api_key method usage example with argument unpacking
kwargs: DeleteWorkspaceApiKeyRequestRequestTypeDef = { # (1)
"keyName": ...,
"workspaceId": ...,
}
parent.delete_workspace_api_key(**kwargs)
describe_workspace#
Displays information about one Amazon Managed Grafana workspace.
Type annotations and code completion for session.create_client("grafana").describe_workspace
method.
boto3 documentation
# describe_workspace method definition
await def describe_workspace(
self,
*,
workspaceId: str,
) -> DescribeWorkspaceResponseTypeDef: # (1)
...
# describe_workspace method usage example with argument unpacking
kwargs: DescribeWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.describe_workspace(**kwargs)
describe_workspace_authentication#
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
Type annotations and code completion for session.create_client("grafana").describe_workspace_authentication
method.
boto3 documentation
# describe_workspace_authentication method definition
await def describe_workspace_authentication(
self,
*,
workspaceId: str,
) -> DescribeWorkspaceAuthenticationResponseTypeDef: # (1)
...
# describe_workspace_authentication method usage example with argument unpacking
kwargs: DescribeWorkspaceAuthenticationRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.describe_workspace_authentication(**kwargs)
describe_workspace_configuration#
Gets the current configuration string for the given workspace.
Type annotations and code completion for session.create_client("grafana").describe_workspace_configuration
method.
boto3 documentation
# describe_workspace_configuration method definition
await def describe_workspace_configuration(
self,
*,
workspaceId: str,
) -> DescribeWorkspaceConfigurationResponseTypeDef: # (1)
...
# describe_workspace_configuration method usage example with argument unpacking
kwargs: DescribeWorkspaceConfigurationRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.describe_workspace_configuration(**kwargs)
disassociate_license#
Removes the Grafana Enterprise license from a workspace.
Type annotations and code completion for session.create_client("grafana").disassociate_license
method.
boto3 documentation
# disassociate_license method definition
await def disassociate_license(
self,
*,
licenseType: LicenseTypeType, # (1)
workspaceId: str,
) -> DisassociateLicenseResponseTypeDef: # (2)
...
# disassociate_license method usage example with argument unpacking
kwargs: DisassociateLicenseRequestRequestTypeDef = { # (1)
"licenseType": ...,
"workspaceId": ...,
}
parent.disassociate_license(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("grafana").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("grafana").list_permissions
method.
boto3 documentation
# list_permissions method definition
await def list_permissions(
self,
*,
workspaceId: str,
groupId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
userId: str = ...,
userType: UserTypeType = ..., # (1)
) -> ListPermissionsResponseTypeDef: # (2)
...
# list_permissions method usage example with argument unpacking
kwargs: ListPermissionsRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.list_permissions(**kwargs)
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 session.create_client("grafana").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_versions#
Lists available versions of Grafana.
Type annotations and code completion for session.create_client("grafana").list_versions
method.
boto3 documentation
# list_versions method definition
await def list_versions(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
workspaceId: str = ...,
) -> ListVersionsResponseTypeDef: # (1)
...
# list_versions method usage example with argument unpacking
kwargs: ListVersionsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_versions(**kwargs)
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 session.create_client("grafana").list_workspaces
method.
boto3 documentation
# list_workspaces method definition
await def list_workspaces(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListWorkspacesResponseTypeDef: # (1)
...
# list_workspaces method usage example with argument unpacking
kwargs: ListWorkspacesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_workspaces(**kwargs)
tag_resource#
The TagResource
operation associates tags with an Amazon Managed Grafana
resource.
Type annotations and code completion for session.create_client("grafana").tag_resource
method.
boto3 documentation
# tag_resource method definition
await 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)
untag_resource#
The UntagResource
operation removes the association of the tag with the Amazon
Managed Grafana resource.
Type annotations and code completion for session.create_client("grafana").untag_resource
method.
boto3 documentation
# untag_resource method definition
await 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)
update_permissions#
Updates which users in a workspace have the Grafana Admin
or Editor
roles.
Type annotations and code completion for session.create_client("grafana").update_permissions
method.
boto3 documentation
# update_permissions method definition
await def update_permissions(
self,
*,
updateInstructionBatch: Sequence[UpdateInstructionTypeDef], # (1)
workspaceId: str,
) -> UpdatePermissionsResponseTypeDef: # (2)
...
# update_permissions method usage example with argument unpacking
kwargs: UpdatePermissionsRequestRequestTypeDef = { # (1)
"updateInstructionBatch": ...,
"workspaceId": ...,
}
parent.update_permissions(**kwargs)
update_workspace#
Modifies an existing Amazon Managed Grafana workspace.
Type annotations and code completion for session.create_client("grafana").update_workspace
method.
boto3 documentation
# update_workspace method definition
await 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)
...
- See AccountAccessTypeType
- See NetworkAccessConfigurationTypeDef
- See PermissionTypeType
- See VpcConfigurationTypeDef
- See DataSourceTypeType
- See NotificationDestinationTypeType
- See UpdateWorkspaceResponseTypeDef
# update_workspace method usage example with argument unpacking
kwargs: UpdateWorkspaceRequestRequestTypeDef = { # (1)
"workspaceId": ...,
}
parent.update_workspace(**kwargs)
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 session.create_client("grafana").update_workspace_authentication
method.
boto3 documentation
# update_workspace_authentication method definition
await def update_workspace_authentication(
self,
*,
authenticationProviders: Sequence[AuthenticationProviderTypesType], # (1)
workspaceId: str,
samlConfiguration: SamlConfigurationTypeDef = ..., # (2)
) -> UpdateWorkspaceAuthenticationResponseTypeDef: # (3)
...
- See AuthenticationProviderTypesType
- See SamlConfigurationTypeDef
- See UpdateWorkspaceAuthenticationResponseTypeDef
# update_workspace_authentication method usage example with argument unpacking
kwargs: UpdateWorkspaceAuthenticationRequestRequestTypeDef = { # (1)
"authenticationProviders": ...,
"workspaceId": ...,
}
parent.update_workspace_authentication(**kwargs)
update_workspace_configuration#
Updates the configuration string for the given workspace See also: AWS API Documentation.
Type annotations and code completion for session.create_client("grafana").update_workspace_configuration
method.
boto3 documentation
# update_workspace_configuration method definition
await 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)
__aenter__#
Type annotations and code completion for session.create_client("grafana").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ManagedGrafanaClient:
...
__aexit__#
Type annotations and code completion for session.create_client("grafana").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("grafana").get_paginator
method with overloads.
client.get_paginator("list_permissions")
-> ListPermissionsPaginatorclient.get_paginator("list_versions")
-> ListVersionsPaginatorclient.get_paginator("list_workspaces")
-> ListWorkspacesPaginator