Type definitions#
Index > ManagedGrafana > Type definitions
Auto-generated documentation for ManagedGrafana type annotations stubs module types-boto3-grafana.
NetworkAccessConfigurationUnionTypeDef#
# NetworkAccessConfigurationUnionTypeDef Union usage example
from types_boto3_grafana.type_defs import NetworkAccessConfigurationUnionTypeDef
def get_value() -> NetworkAccessConfigurationUnionTypeDef:
return ...
# NetworkAccessConfigurationUnionTypeDef definition
NetworkAccessConfigurationUnionTypeDef = Union[
NetworkAccessConfigurationTypeDef, # (1)
NetworkAccessConfigurationOutputTypeDef, # (2)
]
VpcConfigurationUnionTypeDef#
# VpcConfigurationUnionTypeDef Union usage example
from types_boto3_grafana.type_defs import VpcConfigurationUnionTypeDef
def get_value() -> VpcConfigurationUnionTypeDef:
return ...
# VpcConfigurationUnionTypeDef definition
VpcConfigurationUnionTypeDef = Union[
VpcConfigurationTypeDef, # (1)
VpcConfigurationOutputTypeDef, # (2)
]
UpdateInstructionUnionTypeDef#
# UpdateInstructionUnionTypeDef Union usage example
from types_boto3_grafana.type_defs import UpdateInstructionUnionTypeDef
def get_value() -> UpdateInstructionUnionTypeDef:
return ...
# UpdateInstructionUnionTypeDef definition
UpdateInstructionUnionTypeDef = Union[
UpdateInstructionTypeDef, # (1)
UpdateInstructionOutputTypeDef, # (2)
]
SamlConfigurationUnionTypeDef#
# SamlConfigurationUnionTypeDef Union usage example
from types_boto3_grafana.type_defs import SamlConfigurationUnionTypeDef
def get_value() -> SamlConfigurationUnionTypeDef:
return ...
# SamlConfigurationUnionTypeDef definition
SamlConfigurationUnionTypeDef = Union[
SamlConfigurationTypeDef, # (1)
SamlConfigurationOutputTypeDef, # (2)
]
AssertionAttributesTypeDef#
# AssertionAttributesTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import AssertionAttributesTypeDef
def get_value() -> AssertionAttributesTypeDef:
return {
"email": ...,
}
# AssertionAttributesTypeDef definition
class AssertionAttributesTypeDef(TypedDict):
email: NotRequired[str],
groups: NotRequired[str],
login: NotRequired[str],
name: NotRequired[str],
org: NotRequired[str],
role: NotRequired[str],
AssociateLicenseRequestTypeDef#
# AssociateLicenseRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import AssociateLicenseRequestTypeDef
def get_value() -> AssociateLicenseRequestTypeDef:
return {
"licenseType": ...,
}
# AssociateLicenseRequestTypeDef definition
class AssociateLicenseRequestTypeDef(TypedDict):
licenseType: LicenseTypeType, # (1)
workspaceId: str,
grafanaToken: NotRequired[str],
- See LicenseTypeType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
AwsSsoAuthenticationTypeDef#
# AwsSsoAuthenticationTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import AwsSsoAuthenticationTypeDef
def get_value() -> AwsSsoAuthenticationTypeDef:
return {
"ssoClientId": ...,
}
# AwsSsoAuthenticationTypeDef definition
class AwsSsoAuthenticationTypeDef(TypedDict):
ssoClientId: NotRequired[str],
AuthenticationSummaryTypeDef#
# AuthenticationSummaryTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import AuthenticationSummaryTypeDef
def get_value() -> AuthenticationSummaryTypeDef:
return {
"providers": ...,
}
# AuthenticationSummaryTypeDef definition
class AuthenticationSummaryTypeDef(TypedDict):
providers: List[AuthenticationProviderTypesType], # (1)
samlConfigurationStatus: NotRequired[SamlConfigurationStatusType], # (2)
CreateWorkspaceApiKeyRequestTypeDef#
# CreateWorkspaceApiKeyRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceApiKeyRequestTypeDef
def get_value() -> CreateWorkspaceApiKeyRequestTypeDef:
return {
"keyName": ...,
}
# CreateWorkspaceApiKeyRequestTypeDef definition
class CreateWorkspaceApiKeyRequestTypeDef(TypedDict):
keyName: str,
keyRole: str,
secondsToLive: int,
workspaceId: str,
CreateWorkspaceServiceAccountRequestTypeDef#
# CreateWorkspaceServiceAccountRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceServiceAccountRequestTypeDef
def get_value() -> CreateWorkspaceServiceAccountRequestTypeDef:
return {
"grafanaRole": ...,
}
# CreateWorkspaceServiceAccountRequestTypeDef definition
class CreateWorkspaceServiceAccountRequestTypeDef(TypedDict):
grafanaRole: RoleType, # (1)
name: str,
workspaceId: str,
- See RoleType
CreateWorkspaceServiceAccountTokenRequestTypeDef#
# CreateWorkspaceServiceAccountTokenRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceServiceAccountTokenRequestTypeDef
def get_value() -> CreateWorkspaceServiceAccountTokenRequestTypeDef:
return {
"name": ...,
}
# CreateWorkspaceServiceAccountTokenRequestTypeDef definition
class CreateWorkspaceServiceAccountTokenRequestTypeDef(TypedDict):
name: str,
secondsToLive: int,
serviceAccountId: str,
workspaceId: str,
ServiceAccountTokenSummaryWithKeyTypeDef#
# ServiceAccountTokenSummaryWithKeyTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ServiceAccountTokenSummaryWithKeyTypeDef
def get_value() -> ServiceAccountTokenSummaryWithKeyTypeDef:
return {
"id": ...,
}
# ServiceAccountTokenSummaryWithKeyTypeDef definition
class ServiceAccountTokenSummaryWithKeyTypeDef(TypedDict):
id: str,
key: str,
name: str,
DeleteWorkspaceApiKeyRequestTypeDef#
# DeleteWorkspaceApiKeyRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceApiKeyRequestTypeDef
def get_value() -> DeleteWorkspaceApiKeyRequestTypeDef:
return {
"keyName": ...,
}
# DeleteWorkspaceApiKeyRequestTypeDef definition
class DeleteWorkspaceApiKeyRequestTypeDef(TypedDict):
keyName: str,
workspaceId: str,
DeleteWorkspaceRequestTypeDef#
# DeleteWorkspaceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceRequestTypeDef
def get_value() -> DeleteWorkspaceRequestTypeDef:
return {
"workspaceId": ...,
}
# DeleteWorkspaceRequestTypeDef definition
class DeleteWorkspaceRequestTypeDef(TypedDict):
workspaceId: str,
DeleteWorkspaceServiceAccountRequestTypeDef#
# DeleteWorkspaceServiceAccountRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceServiceAccountRequestTypeDef
def get_value() -> DeleteWorkspaceServiceAccountRequestTypeDef:
return {
"serviceAccountId": ...,
}
# DeleteWorkspaceServiceAccountRequestTypeDef definition
class DeleteWorkspaceServiceAccountRequestTypeDef(TypedDict):
serviceAccountId: str,
workspaceId: str,
DeleteWorkspaceServiceAccountTokenRequestTypeDef#
# DeleteWorkspaceServiceAccountTokenRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceServiceAccountTokenRequestTypeDef
def get_value() -> DeleteWorkspaceServiceAccountTokenRequestTypeDef:
return {
"serviceAccountId": ...,
}
# DeleteWorkspaceServiceAccountTokenRequestTypeDef definition
class DeleteWorkspaceServiceAccountTokenRequestTypeDef(TypedDict):
serviceAccountId: str,
tokenId: str,
workspaceId: str,
DescribeWorkspaceAuthenticationRequestTypeDef#
# DescribeWorkspaceAuthenticationRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DescribeWorkspaceAuthenticationRequestTypeDef
def get_value() -> DescribeWorkspaceAuthenticationRequestTypeDef:
return {
"workspaceId": ...,
}
# DescribeWorkspaceAuthenticationRequestTypeDef definition
class DescribeWorkspaceAuthenticationRequestTypeDef(TypedDict):
workspaceId: str,
DescribeWorkspaceConfigurationRequestTypeDef#
# DescribeWorkspaceConfigurationRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DescribeWorkspaceConfigurationRequestTypeDef
def get_value() -> DescribeWorkspaceConfigurationRequestTypeDef:
return {
"workspaceId": ...,
}
# DescribeWorkspaceConfigurationRequestTypeDef definition
class DescribeWorkspaceConfigurationRequestTypeDef(TypedDict):
workspaceId: str,
DescribeWorkspaceRequestTypeDef#
# DescribeWorkspaceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DescribeWorkspaceRequestTypeDef
def get_value() -> DescribeWorkspaceRequestTypeDef:
return {
"workspaceId": ...,
}
# DescribeWorkspaceRequestTypeDef definition
class DescribeWorkspaceRequestTypeDef(TypedDict):
workspaceId: str,
DisassociateLicenseRequestTypeDef#
# DisassociateLicenseRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DisassociateLicenseRequestTypeDef
def get_value() -> DisassociateLicenseRequestTypeDef:
return {
"licenseType": ...,
}
# DisassociateLicenseRequestTypeDef definition
class DisassociateLicenseRequestTypeDef(TypedDict):
licenseType: LicenseTypeType, # (1)
workspaceId: str,
- See LicenseTypeType
IdpMetadataTypeDef#
# IdpMetadataTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import IdpMetadataTypeDef
def get_value() -> IdpMetadataTypeDef:
return {
"url": ...,
}
# IdpMetadataTypeDef definition
class IdpMetadataTypeDef(TypedDict):
url: NotRequired[str],
xml: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListPermissionsRequestTypeDef#
# ListPermissionsRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListPermissionsRequestTypeDef
def get_value() -> ListPermissionsRequestTypeDef:
return {
"workspaceId": ...,
}
# ListPermissionsRequestTypeDef definition
class ListPermissionsRequestTypeDef(TypedDict):
workspaceId: str,
groupId: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
userId: NotRequired[str],
userType: NotRequired[UserTypeType], # (1)
- See UserTypeType
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceArn: str,
ListVersionsRequestTypeDef#
# ListVersionsRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListVersionsRequestTypeDef
def get_value() -> ListVersionsRequestTypeDef:
return {
"maxResults": ...,
}
# ListVersionsRequestTypeDef definition
class ListVersionsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
workspaceId: NotRequired[str],
ListWorkspaceServiceAccountTokensRequestTypeDef#
# ListWorkspaceServiceAccountTokensRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspaceServiceAccountTokensRequestTypeDef
def get_value() -> ListWorkspaceServiceAccountTokensRequestTypeDef:
return {
"serviceAccountId": ...,
}
# ListWorkspaceServiceAccountTokensRequestTypeDef definition
class ListWorkspaceServiceAccountTokensRequestTypeDef(TypedDict):
serviceAccountId: str,
workspaceId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ServiceAccountTokenSummaryTypeDef#
# ServiceAccountTokenSummaryTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ServiceAccountTokenSummaryTypeDef
def get_value() -> ServiceAccountTokenSummaryTypeDef:
return {
"createdAt": ...,
}
# ServiceAccountTokenSummaryTypeDef definition
class ServiceAccountTokenSummaryTypeDef(TypedDict):
createdAt: datetime,
expiresAt: datetime,
id: str,
name: str,
lastUsedAt: NotRequired[datetime],
ListWorkspaceServiceAccountsRequestTypeDef#
# ListWorkspaceServiceAccountsRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspaceServiceAccountsRequestTypeDef
def get_value() -> ListWorkspaceServiceAccountsRequestTypeDef:
return {
"workspaceId": ...,
}
# ListWorkspaceServiceAccountsRequestTypeDef definition
class ListWorkspaceServiceAccountsRequestTypeDef(TypedDict):
workspaceId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ServiceAccountSummaryTypeDef#
# ServiceAccountSummaryTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ServiceAccountSummaryTypeDef
def get_value() -> ServiceAccountSummaryTypeDef:
return {
"grafanaRole": ...,
}
# ServiceAccountSummaryTypeDef definition
class ServiceAccountSummaryTypeDef(TypedDict):
grafanaRole: RoleType, # (1)
id: str,
isDisabled: str,
name: str,
- See RoleType
ListWorkspacesRequestTypeDef#
# ListWorkspacesRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspacesRequestTypeDef
def get_value() -> ListWorkspacesRequestTypeDef:
return {
"maxResults": ...,
}
# ListWorkspacesRequestTypeDef definition
class ListWorkspacesRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
NetworkAccessConfigurationOutputTypeDef#
# NetworkAccessConfigurationOutputTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import NetworkAccessConfigurationOutputTypeDef
def get_value() -> NetworkAccessConfigurationOutputTypeDef:
return {
"prefixListIds": ...,
}
# NetworkAccessConfigurationOutputTypeDef definition
class NetworkAccessConfigurationOutputTypeDef(TypedDict):
prefixListIds: List[str],
vpceIds: List[str],
NetworkAccessConfigurationTypeDef#
# NetworkAccessConfigurationTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import NetworkAccessConfigurationTypeDef
def get_value() -> NetworkAccessConfigurationTypeDef:
return {
"prefixListIds": ...,
}
# NetworkAccessConfigurationTypeDef definition
class NetworkAccessConfigurationTypeDef(TypedDict):
prefixListIds: Sequence[str],
vpceIds: Sequence[str],
UserTypeDef#
# UserTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UserTypeDef
def get_value() -> UserTypeDef:
return {
"id": ...,
}
# UserTypeDef definition
class UserTypeDef(TypedDict):
id: str,
type: UserTypeType, # (1)
- See UserTypeType
RoleValuesOutputTypeDef#
# RoleValuesOutputTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import RoleValuesOutputTypeDef
def get_value() -> RoleValuesOutputTypeDef:
return {
"admin": ...,
}
# RoleValuesOutputTypeDef definition
class RoleValuesOutputTypeDef(TypedDict):
admin: NotRequired[List[str]],
editor: NotRequired[List[str]],
RoleValuesTypeDef#
# RoleValuesTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import RoleValuesTypeDef
def get_value() -> RoleValuesTypeDef:
return {
"admin": ...,
}
# RoleValuesTypeDef definition
class RoleValuesTypeDef(TypedDict):
admin: NotRequired[Sequence[str]],
editor: NotRequired[Sequence[str]],
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateWorkspaceConfigurationRequestTypeDef#
# UpdateWorkspaceConfigurationRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateWorkspaceConfigurationRequestTypeDef
def get_value() -> UpdateWorkspaceConfigurationRequestTypeDef:
return {
"configuration": ...,
}
# UpdateWorkspaceConfigurationRequestTypeDef definition
class UpdateWorkspaceConfigurationRequestTypeDef(TypedDict):
configuration: str,
workspaceId: str,
grafanaVersion: NotRequired[str],
VpcConfigurationOutputTypeDef#
# VpcConfigurationOutputTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import VpcConfigurationOutputTypeDef
def get_value() -> VpcConfigurationOutputTypeDef:
return {
"securityGroupIds": ...,
}
# VpcConfigurationOutputTypeDef definition
class VpcConfigurationOutputTypeDef(TypedDict):
securityGroupIds: List[str],
subnetIds: List[str],
VpcConfigurationTypeDef#
# VpcConfigurationTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import VpcConfigurationTypeDef
def get_value() -> VpcConfigurationTypeDef:
return {
"securityGroupIds": ...,
}
# VpcConfigurationTypeDef definition
class VpcConfigurationTypeDef(TypedDict):
securityGroupIds: Sequence[str],
subnetIds: Sequence[str],
CreateWorkspaceApiKeyResponseTypeDef#
# CreateWorkspaceApiKeyResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceApiKeyResponseTypeDef
def get_value() -> CreateWorkspaceApiKeyResponseTypeDef:
return {
"key": ...,
}
# CreateWorkspaceApiKeyResponseTypeDef definition
class CreateWorkspaceApiKeyResponseTypeDef(TypedDict):
key: str,
keyName: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWorkspaceServiceAccountResponseTypeDef#
# CreateWorkspaceServiceAccountResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceServiceAccountResponseTypeDef
def get_value() -> CreateWorkspaceServiceAccountResponseTypeDef:
return {
"grafanaRole": ...,
}
# CreateWorkspaceServiceAccountResponseTypeDef definition
class CreateWorkspaceServiceAccountResponseTypeDef(TypedDict):
grafanaRole: RoleType, # (1)
id: str,
name: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See RoleType
- See ResponseMetadataTypeDef
DeleteWorkspaceApiKeyResponseTypeDef#
# DeleteWorkspaceApiKeyResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceApiKeyResponseTypeDef
def get_value() -> DeleteWorkspaceApiKeyResponseTypeDef:
return {
"keyName": ...,
}
# DeleteWorkspaceApiKeyResponseTypeDef definition
class DeleteWorkspaceApiKeyResponseTypeDef(TypedDict):
keyName: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteWorkspaceServiceAccountResponseTypeDef#
# DeleteWorkspaceServiceAccountResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceServiceAccountResponseTypeDef
def get_value() -> DeleteWorkspaceServiceAccountResponseTypeDef:
return {
"serviceAccountId": ...,
}
# DeleteWorkspaceServiceAccountResponseTypeDef definition
class DeleteWorkspaceServiceAccountResponseTypeDef(TypedDict):
serviceAccountId: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteWorkspaceServiceAccountTokenResponseTypeDef#
# DeleteWorkspaceServiceAccountTokenResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceServiceAccountTokenResponseTypeDef
def get_value() -> DeleteWorkspaceServiceAccountTokenResponseTypeDef:
return {
"serviceAccountId": ...,
}
# DeleteWorkspaceServiceAccountTokenResponseTypeDef definition
class DeleteWorkspaceServiceAccountTokenResponseTypeDef(TypedDict):
serviceAccountId: str,
tokenId: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeWorkspaceConfigurationResponseTypeDef#
# DescribeWorkspaceConfigurationResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DescribeWorkspaceConfigurationResponseTypeDef
def get_value() -> DescribeWorkspaceConfigurationResponseTypeDef:
return {
"configuration": ...,
}
# DescribeWorkspaceConfigurationResponseTypeDef definition
class DescribeWorkspaceConfigurationResponseTypeDef(TypedDict):
configuration: str,
grafanaVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListVersionsResponseTypeDef#
# ListVersionsResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListVersionsResponseTypeDef
def get_value() -> ListVersionsResponseTypeDef:
return {
"grafanaVersions": ...,
}
# ListVersionsResponseTypeDef definition
class ListVersionsResponseTypeDef(TypedDict):
grafanaVersions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],
WorkspaceSummaryTypeDef#
# WorkspaceSummaryTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import WorkspaceSummaryTypeDef
def get_value() -> WorkspaceSummaryTypeDef:
return {
"authentication": ...,
}
# WorkspaceSummaryTypeDef definition
class WorkspaceSummaryTypeDef(TypedDict):
authentication: AuthenticationSummaryTypeDef, # (1)
created: datetime,
endpoint: str,
grafanaVersion: str,
id: str,
modified: datetime,
status: WorkspaceStatusType, # (4)
description: NotRequired[str],
grafanaToken: NotRequired[str],
licenseType: NotRequired[LicenseTypeType], # (2)
name: NotRequired[str],
notificationDestinations: NotRequired[List[NotificationDestinationTypeType]], # (3)
tags: NotRequired[Dict[str, str]],
- See AuthenticationSummaryTypeDef
- See LicenseTypeType
- See NotificationDestinationTypeType
- See WorkspaceStatusType
CreateWorkspaceServiceAccountTokenResponseTypeDef#
# CreateWorkspaceServiceAccountTokenResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceServiceAccountTokenResponseTypeDef
def get_value() -> CreateWorkspaceServiceAccountTokenResponseTypeDef:
return {
"serviceAccountId": ...,
}
# CreateWorkspaceServiceAccountTokenResponseTypeDef definition
class CreateWorkspaceServiceAccountTokenResponseTypeDef(TypedDict):
serviceAccountId: str,
serviceAccountToken: ServiceAccountTokenSummaryWithKeyTypeDef, # (1)
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPermissionsRequestPaginateTypeDef#
# ListPermissionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListPermissionsRequestPaginateTypeDef
def get_value() -> ListPermissionsRequestPaginateTypeDef:
return {
"workspaceId": ...,
}
# ListPermissionsRequestPaginateTypeDef definition
class ListPermissionsRequestPaginateTypeDef(TypedDict):
workspaceId: str,
groupId: NotRequired[str],
userId: NotRequired[str],
userType: NotRequired[UserTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See UserTypeType
- See PaginatorConfigTypeDef
ListVersionsRequestPaginateTypeDef#
# ListVersionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListVersionsRequestPaginateTypeDef
def get_value() -> ListVersionsRequestPaginateTypeDef:
return {
"workspaceId": ...,
}
# ListVersionsRequestPaginateTypeDef definition
class ListVersionsRequestPaginateTypeDef(TypedDict):
workspaceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWorkspaceServiceAccountTokensRequestPaginateTypeDef#
# ListWorkspaceServiceAccountTokensRequestPaginateTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspaceServiceAccountTokensRequestPaginateTypeDef
def get_value() -> ListWorkspaceServiceAccountTokensRequestPaginateTypeDef:
return {
"serviceAccountId": ...,
}
# ListWorkspaceServiceAccountTokensRequestPaginateTypeDef definition
class ListWorkspaceServiceAccountTokensRequestPaginateTypeDef(TypedDict):
serviceAccountId: str,
workspaceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWorkspaceServiceAccountsRequestPaginateTypeDef#
# ListWorkspaceServiceAccountsRequestPaginateTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspaceServiceAccountsRequestPaginateTypeDef
def get_value() -> ListWorkspaceServiceAccountsRequestPaginateTypeDef:
return {
"workspaceId": ...,
}
# ListWorkspaceServiceAccountsRequestPaginateTypeDef definition
class ListWorkspaceServiceAccountsRequestPaginateTypeDef(TypedDict):
workspaceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWorkspacesRequestPaginateTypeDef#
# ListWorkspacesRequestPaginateTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspacesRequestPaginateTypeDef
def get_value() -> ListWorkspacesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListWorkspacesRequestPaginateTypeDef definition
class ListWorkspacesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWorkspaceServiceAccountTokensResponseTypeDef#
# ListWorkspaceServiceAccountTokensResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspaceServiceAccountTokensResponseTypeDef
def get_value() -> ListWorkspaceServiceAccountTokensResponseTypeDef:
return {
"nextToken": ...,
}
# ListWorkspaceServiceAccountTokensResponseTypeDef definition
class ListWorkspaceServiceAccountTokensResponseTypeDef(TypedDict):
serviceAccountId: str,
serviceAccountTokens: List[ServiceAccountTokenSummaryTypeDef], # (1)
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListWorkspaceServiceAccountsResponseTypeDef#
# ListWorkspaceServiceAccountsResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspaceServiceAccountsResponseTypeDef
def get_value() -> ListWorkspaceServiceAccountsResponseTypeDef:
return {
"nextToken": ...,
}
# ListWorkspaceServiceAccountsResponseTypeDef definition
class ListWorkspaceServiceAccountsResponseTypeDef(TypedDict):
serviceAccounts: List[ServiceAccountSummaryTypeDef], # (1)
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
PermissionEntryTypeDef#
# PermissionEntryTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import PermissionEntryTypeDef
def get_value() -> PermissionEntryTypeDef:
return {
"role": ...,
}
# PermissionEntryTypeDef definition
class PermissionEntryTypeDef(TypedDict):
role: RoleType, # (1)
user: UserTypeDef, # (2)
- See RoleType
- See UserTypeDef
UpdateInstructionOutputTypeDef#
# UpdateInstructionOutputTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateInstructionOutputTypeDef
def get_value() -> UpdateInstructionOutputTypeDef:
return {
"action": ...,
}
# UpdateInstructionOutputTypeDef definition
class UpdateInstructionOutputTypeDef(TypedDict):
action: UpdateActionType, # (1)
role: RoleType, # (2)
users: List[UserTypeDef], # (3)
- See UpdateActionType
- See RoleType
- See UserTypeDef
UpdateInstructionTypeDef#
# UpdateInstructionTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateInstructionTypeDef
def get_value() -> UpdateInstructionTypeDef:
return {
"action": ...,
}
# UpdateInstructionTypeDef definition
class UpdateInstructionTypeDef(TypedDict):
action: UpdateActionType, # (1)
role: RoleType, # (2)
users: Sequence[UserTypeDef], # (3)
- See UpdateActionType
- See RoleType
- See UserTypeDef
SamlConfigurationOutputTypeDef#
# SamlConfigurationOutputTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import SamlConfigurationOutputTypeDef
def get_value() -> SamlConfigurationOutputTypeDef:
return {
"allowedOrganizations": ...,
}
# SamlConfigurationOutputTypeDef definition
class SamlConfigurationOutputTypeDef(TypedDict):
idpMetadata: IdpMetadataTypeDef, # (2)
allowedOrganizations: NotRequired[List[str]],
assertionAttributes: NotRequired[AssertionAttributesTypeDef], # (1)
loginValidityDuration: NotRequired[int],
roleValues: NotRequired[RoleValuesOutputTypeDef], # (3)
SamlConfigurationTypeDef#
# SamlConfigurationTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import SamlConfigurationTypeDef
def get_value() -> SamlConfigurationTypeDef:
return {
"allowedOrganizations": ...,
}
# SamlConfigurationTypeDef definition
class SamlConfigurationTypeDef(TypedDict):
idpMetadata: IdpMetadataTypeDef, # (2)
allowedOrganizations: NotRequired[Sequence[str]],
assertionAttributes: NotRequired[AssertionAttributesTypeDef], # (1)
loginValidityDuration: NotRequired[int],
roleValues: NotRequired[RoleValuesTypeDef], # (3)
WorkspaceDescriptionTypeDef#
# WorkspaceDescriptionTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import WorkspaceDescriptionTypeDef
def get_value() -> WorkspaceDescriptionTypeDef:
return {
"accountAccessType": ...,
}
# WorkspaceDescriptionTypeDef definition
class WorkspaceDescriptionTypeDef(TypedDict):
authentication: AuthenticationSummaryTypeDef, # (2)
created: datetime,
dataSources: List[DataSourceTypeType], # (3)
endpoint: str,
grafanaVersion: str,
id: str,
modified: datetime,
status: WorkspaceStatusType, # (8)
accountAccessType: NotRequired[AccountAccessTypeType], # (1)
description: NotRequired[str],
freeTrialConsumed: NotRequired[bool],
freeTrialExpiration: NotRequired[datetime],
grafanaToken: NotRequired[str],
licenseExpiration: NotRequired[datetime],
licenseType: NotRequired[LicenseTypeType], # (4)
name: NotRequired[str],
networkAccessControl: NotRequired[NetworkAccessConfigurationOutputTypeDef], # (5)
notificationDestinations: NotRequired[List[NotificationDestinationTypeType]], # (6)
organizationRoleName: NotRequired[str],
organizationalUnits: NotRequired[List[str]],
permissionType: NotRequired[PermissionTypeType], # (7)
stackSetName: NotRequired[str],
tags: NotRequired[Dict[str, str]],
vpcConfiguration: NotRequired[VpcConfigurationOutputTypeDef], # (9)
workspaceRoleArn: NotRequired[str],
- See AccountAccessTypeType
- See AuthenticationSummaryTypeDef
- See DataSourceTypeType
- See LicenseTypeType
- See NetworkAccessConfigurationOutputTypeDef
- See NotificationDestinationTypeType
- See PermissionTypeType
- See WorkspaceStatusType
- See VpcConfigurationOutputTypeDef
ListWorkspacesResponseTypeDef#
# ListWorkspacesResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListWorkspacesResponseTypeDef
def get_value() -> ListWorkspacesResponseTypeDef:
return {
"nextToken": ...,
}
# ListWorkspacesResponseTypeDef definition
class ListWorkspacesResponseTypeDef(TypedDict):
workspaces: List[WorkspaceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListPermissionsResponseTypeDef#
# ListPermissionsResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import ListPermissionsResponseTypeDef
def get_value() -> ListPermissionsResponseTypeDef:
return {
"nextToken": ...,
}
# ListPermissionsResponseTypeDef definition
class ListPermissionsResponseTypeDef(TypedDict):
permissions: List[PermissionEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
UpdateErrorTypeDef#
# UpdateErrorTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateErrorTypeDef
def get_value() -> UpdateErrorTypeDef:
return {
"causedBy": ...,
}
# UpdateErrorTypeDef definition
class UpdateErrorTypeDef(TypedDict):
causedBy: UpdateInstructionOutputTypeDef, # (1)
code: int,
message: str,
SamlAuthenticationTypeDef#
# SamlAuthenticationTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import SamlAuthenticationTypeDef
def get_value() -> SamlAuthenticationTypeDef:
return {
"configuration": ...,
}
# SamlAuthenticationTypeDef definition
class SamlAuthenticationTypeDef(TypedDict):
status: SamlConfigurationStatusType, # (2)
configuration: NotRequired[SamlConfigurationOutputTypeDef], # (1)
AssociateLicenseResponseTypeDef#
# AssociateLicenseResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import AssociateLicenseResponseTypeDef
def get_value() -> AssociateLicenseResponseTypeDef:
return {
"workspace": ...,
}
# AssociateLicenseResponseTypeDef definition
class AssociateLicenseResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkspaceResponseTypeDef#
# CreateWorkspaceResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceResponseTypeDef
def get_value() -> CreateWorkspaceResponseTypeDef:
return {
"workspace": ...,
}
# CreateWorkspaceResponseTypeDef definition
class CreateWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteWorkspaceResponseTypeDef#
# DeleteWorkspaceResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DeleteWorkspaceResponseTypeDef
def get_value() -> DeleteWorkspaceResponseTypeDef:
return {
"workspace": ...,
}
# DeleteWorkspaceResponseTypeDef definition
class DeleteWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceResponseTypeDef#
# DescribeWorkspaceResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DescribeWorkspaceResponseTypeDef
def get_value() -> DescribeWorkspaceResponseTypeDef:
return {
"workspace": ...,
}
# DescribeWorkspaceResponseTypeDef definition
class DescribeWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociateLicenseResponseTypeDef#
# DisassociateLicenseResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DisassociateLicenseResponseTypeDef
def get_value() -> DisassociateLicenseResponseTypeDef:
return {
"workspace": ...,
}
# DisassociateLicenseResponseTypeDef definition
class DisassociateLicenseResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkspaceResponseTypeDef#
# UpdateWorkspaceResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateWorkspaceResponseTypeDef
def get_value() -> UpdateWorkspaceResponseTypeDef:
return {
"workspace": ...,
}
# UpdateWorkspaceResponseTypeDef definition
class UpdateWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkspaceRequestTypeDef#
# CreateWorkspaceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import CreateWorkspaceRequestTypeDef
def get_value() -> CreateWorkspaceRequestTypeDef:
return {
"accountAccessType": ...,
}
# CreateWorkspaceRequestTypeDef definition
class CreateWorkspaceRequestTypeDef(TypedDict):
accountAccessType: AccountAccessTypeType, # (1)
authenticationProviders: Sequence[AuthenticationProviderTypesType], # (2)
permissionType: PermissionTypeType, # (3)
clientToken: NotRequired[str],
configuration: NotRequired[str],
grafanaVersion: NotRequired[str],
networkAccessControl: NotRequired[NetworkAccessConfigurationUnionTypeDef], # (4)
organizationRoleName: NotRequired[str],
stackSetName: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
vpcConfiguration: NotRequired[VpcConfigurationUnionTypeDef], # (5)
workspaceDataSources: NotRequired[Sequence[DataSourceTypeType]], # (6)
workspaceDescription: NotRequired[str],
workspaceName: NotRequired[str],
workspaceNotificationDestinations: NotRequired[Sequence[NotificationDestinationTypeType]], # (7)
workspaceOrganizationalUnits: NotRequired[Sequence[str]],
workspaceRoleArn: NotRequired[str],
- See AccountAccessTypeType
- See AuthenticationProviderTypesType
- See PermissionTypeType
- See NetworkAccessConfigurationTypeDef NetworkAccessConfigurationOutputTypeDef
- See VpcConfigurationTypeDef VpcConfigurationOutputTypeDef
- See DataSourceTypeType
- See NotificationDestinationTypeType
UpdateWorkspaceRequestTypeDef#
# UpdateWorkspaceRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateWorkspaceRequestTypeDef
def get_value() -> UpdateWorkspaceRequestTypeDef:
return {
"workspaceId": ...,
}
# UpdateWorkspaceRequestTypeDef definition
class UpdateWorkspaceRequestTypeDef(TypedDict):
workspaceId: str,
accountAccessType: NotRequired[AccountAccessTypeType], # (1)
networkAccessControl: NotRequired[NetworkAccessConfigurationUnionTypeDef], # (2)
organizationRoleName: NotRequired[str],
permissionType: NotRequired[PermissionTypeType], # (3)
removeNetworkAccessConfiguration: NotRequired[bool],
removeVpcConfiguration: NotRequired[bool],
stackSetName: NotRequired[str],
vpcConfiguration: NotRequired[VpcConfigurationUnionTypeDef], # (4)
workspaceDataSources: NotRequired[Sequence[DataSourceTypeType]], # (5)
workspaceDescription: NotRequired[str],
workspaceName: NotRequired[str],
workspaceNotificationDestinations: NotRequired[Sequence[NotificationDestinationTypeType]], # (6)
workspaceOrganizationalUnits: NotRequired[Sequence[str]],
workspaceRoleArn: NotRequired[str],
- See AccountAccessTypeType
- See NetworkAccessConfigurationTypeDef NetworkAccessConfigurationOutputTypeDef
- See PermissionTypeType
- See VpcConfigurationTypeDef VpcConfigurationOutputTypeDef
- See DataSourceTypeType
- See NotificationDestinationTypeType
UpdatePermissionsResponseTypeDef#
# UpdatePermissionsResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdatePermissionsResponseTypeDef
def get_value() -> UpdatePermissionsResponseTypeDef:
return {
"errors": ...,
}
# UpdatePermissionsResponseTypeDef definition
class UpdatePermissionsResponseTypeDef(TypedDict):
errors: List[UpdateErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdatePermissionsRequestTypeDef#
# UpdatePermissionsRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdatePermissionsRequestTypeDef
def get_value() -> UpdatePermissionsRequestTypeDef:
return {
"updateInstructionBatch": ...,
}
# UpdatePermissionsRequestTypeDef definition
class UpdatePermissionsRequestTypeDef(TypedDict):
updateInstructionBatch: Sequence[UpdateInstructionUnionTypeDef], # (1)
workspaceId: str,
AuthenticationDescriptionTypeDef#
# AuthenticationDescriptionTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import AuthenticationDescriptionTypeDef
def get_value() -> AuthenticationDescriptionTypeDef:
return {
"awsSso": ...,
}
# AuthenticationDescriptionTypeDef definition
class AuthenticationDescriptionTypeDef(TypedDict):
providers: List[AuthenticationProviderTypesType], # (2)
awsSso: NotRequired[AwsSsoAuthenticationTypeDef], # (1)
saml: NotRequired[SamlAuthenticationTypeDef], # (3)
UpdateWorkspaceAuthenticationRequestTypeDef#
# UpdateWorkspaceAuthenticationRequestTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateWorkspaceAuthenticationRequestTypeDef
def get_value() -> UpdateWorkspaceAuthenticationRequestTypeDef:
return {
"authenticationProviders": ...,
}
# UpdateWorkspaceAuthenticationRequestTypeDef definition
class UpdateWorkspaceAuthenticationRequestTypeDef(TypedDict):
authenticationProviders: Sequence[AuthenticationProviderTypesType], # (1)
workspaceId: str,
samlConfiguration: NotRequired[SamlConfigurationUnionTypeDef], # (2)
DescribeWorkspaceAuthenticationResponseTypeDef#
# DescribeWorkspaceAuthenticationResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import DescribeWorkspaceAuthenticationResponseTypeDef
def get_value() -> DescribeWorkspaceAuthenticationResponseTypeDef:
return {
"authentication": ...,
}
# DescribeWorkspaceAuthenticationResponseTypeDef definition
class DescribeWorkspaceAuthenticationResponseTypeDef(TypedDict):
authentication: AuthenticationDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkspaceAuthenticationResponseTypeDef#
# UpdateWorkspaceAuthenticationResponseTypeDef TypedDict usage example
from types_boto3_grafana.type_defs import UpdateWorkspaceAuthenticationResponseTypeDef
def get_value() -> UpdateWorkspaceAuthenticationResponseTypeDef:
return {
"authentication": ...,
}
# UpdateWorkspaceAuthenticationResponseTypeDef definition
class UpdateWorkspaceAuthenticationResponseTypeDef(TypedDict):
authentication: AuthenticationDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)