Type definitions#
Index > ManagedGrafana > Type definitions
Auto-generated documentation for ManagedGrafana type annotations stubs module mypy-boto3-grafana.
AssertionAttributesTypeDef#
# AssertionAttributesTypeDef definition
class AssertionAttributesTypeDef(TypedDict):
email: NotRequired[str],
groups: NotRequired[str],
login: NotRequired[str],
name: NotRequired[str],
org: NotRequired[str],
role: NotRequired[str],
AssociateLicenseRequestRequestTypeDef#
# AssociateLicenseRequestRequestTypeDef definition
class AssociateLicenseRequestRequestTypeDef(TypedDict):
licenseType: LicenseTypeType, # (1)
workspaceId: str,
- See LicenseTypeType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AwsSsoAuthenticationTypeDef#
# AwsSsoAuthenticationTypeDef definition
class AwsSsoAuthenticationTypeDef(TypedDict):
ssoClientId: NotRequired[str],
AuthenticationSummaryTypeDef#
# AuthenticationSummaryTypeDef definition
class AuthenticationSummaryTypeDef(TypedDict):
providers: List[AuthenticationProviderTypesType], # (1)
samlConfigurationStatus: NotRequired[SamlConfigurationStatusType], # (2)
CreateWorkspaceApiKeyRequestRequestTypeDef#
# CreateWorkspaceApiKeyRequestRequestTypeDef definition
class CreateWorkspaceApiKeyRequestRequestTypeDef(TypedDict):
keyName: str,
keyRole: str,
secondsToLive: int,
workspaceId: str,
NetworkAccessConfigurationTypeDef#
# NetworkAccessConfigurationTypeDef definition
class NetworkAccessConfigurationTypeDef(TypedDict):
prefixListIds: List[str],
vpceIds: List[str],
VpcConfigurationTypeDef#
# VpcConfigurationTypeDef definition
class VpcConfigurationTypeDef(TypedDict):
securityGroupIds: List[str],
subnetIds: List[str],
DeleteWorkspaceApiKeyRequestRequestTypeDef#
# DeleteWorkspaceApiKeyRequestRequestTypeDef definition
class DeleteWorkspaceApiKeyRequestRequestTypeDef(TypedDict):
keyName: str,
workspaceId: str,
DeleteWorkspaceRequestRequestTypeDef#
# DeleteWorkspaceRequestRequestTypeDef definition
class DeleteWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
DescribeWorkspaceAuthenticationRequestRequestTypeDef#
# DescribeWorkspaceAuthenticationRequestRequestTypeDef definition
class DescribeWorkspaceAuthenticationRequestRequestTypeDef(TypedDict):
workspaceId: str,
DescribeWorkspaceConfigurationRequestRequestTypeDef#
# DescribeWorkspaceConfigurationRequestRequestTypeDef definition
class DescribeWorkspaceConfigurationRequestRequestTypeDef(TypedDict):
workspaceId: str,
DescribeWorkspaceRequestRequestTypeDef#
# DescribeWorkspaceRequestRequestTypeDef definition
class DescribeWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
DisassociateLicenseRequestRequestTypeDef#
# DisassociateLicenseRequestRequestTypeDef definition
class DisassociateLicenseRequestRequestTypeDef(TypedDict):
licenseType: LicenseTypeType, # (1)
workspaceId: str,
- See LicenseTypeType
IdpMetadataTypeDef#
# IdpMetadataTypeDef definition
class IdpMetadataTypeDef(TypedDict):
url: NotRequired[str],
xml: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListPermissionsRequestRequestTypeDef#
# ListPermissionsRequestRequestTypeDef definition
class ListPermissionsRequestRequestTypeDef(TypedDict):
workspaceId: str,
groupId: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
userId: NotRequired[str],
userType: NotRequired[UserTypeType], # (1)
- See UserTypeType
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ListVersionsRequestRequestTypeDef#
# ListVersionsRequestRequestTypeDef definition
class ListVersionsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
workspaceId: NotRequired[str],
ListWorkspacesRequestRequestTypeDef#
# ListWorkspacesRequestRequestTypeDef definition
class ListWorkspacesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
UserTypeDef#
# UserTypeDef definition
class UserTypeDef(TypedDict):
id: str,
type: UserTypeType, # (1)
- See UserTypeType
RoleValuesTypeDef#
# RoleValuesTypeDef definition
class RoleValuesTypeDef(TypedDict):
admin: NotRequired[List[str]],
editor: NotRequired[List[str]],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateWorkspaceConfigurationRequestRequestTypeDef#
# UpdateWorkspaceConfigurationRequestRequestTypeDef definition
class UpdateWorkspaceConfigurationRequestRequestTypeDef(TypedDict):
configuration: str,
workspaceId: str,
grafanaVersion: NotRequired[str],
CreateWorkspaceApiKeyResponseTypeDef#
# CreateWorkspaceApiKeyResponseTypeDef definition
class CreateWorkspaceApiKeyResponseTypeDef(TypedDict):
key: str,
keyName: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteWorkspaceApiKeyResponseTypeDef#
# DeleteWorkspaceApiKeyResponseTypeDef definition
class DeleteWorkspaceApiKeyResponseTypeDef(TypedDict):
keyName: str,
workspaceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeWorkspaceConfigurationResponseTypeDef#
# DescribeWorkspaceConfigurationResponseTypeDef definition
class DescribeWorkspaceConfigurationResponseTypeDef(TypedDict):
configuration: str,
grafanaVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListVersionsResponseTypeDef#
# ListVersionsResponseTypeDef definition
class ListVersionsResponseTypeDef(TypedDict):
grafanaVersions: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
WorkspaceSummaryTypeDef#
# WorkspaceSummaryTypeDef definition
class WorkspaceSummaryTypeDef(TypedDict):
authentication: AuthenticationSummaryTypeDef, # (1)
created: datetime,
endpoint: str,
grafanaVersion: str,
id: str,
modified: datetime,
status: WorkspaceStatusType, # (3)
description: NotRequired[str],
name: NotRequired[str],
notificationDestinations: NotRequired[List[NotificationDestinationTypeType]], # (2)
tags: NotRequired[Dict[str, str]],
CreateWorkspaceRequestRequestTypeDef#
# CreateWorkspaceRequestRequestTypeDef definition
class CreateWorkspaceRequestRequestTypeDef(TypedDict):
accountAccessType: AccountAccessTypeType, # (1)
authenticationProviders: Sequence[AuthenticationProviderTypesType], # (2)
permissionType: PermissionTypeType, # (3)
clientToken: NotRequired[str],
configuration: NotRequired[str],
grafanaVersion: NotRequired[str],
networkAccessControl: NotRequired[NetworkAccessConfigurationTypeDef], # (4)
organizationRoleName: NotRequired[str],
stackSetName: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
vpcConfiguration: NotRequired[VpcConfigurationTypeDef], # (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
- See VpcConfigurationTypeDef
- See DataSourceTypeType
- See NotificationDestinationTypeType
UpdateWorkspaceRequestRequestTypeDef#
# UpdateWorkspaceRequestRequestTypeDef definition
class UpdateWorkspaceRequestRequestTypeDef(TypedDict):
workspaceId: str,
accountAccessType: NotRequired[AccountAccessTypeType], # (1)
networkAccessControl: NotRequired[NetworkAccessConfigurationTypeDef], # (2)
organizationRoleName: NotRequired[str],
permissionType: NotRequired[PermissionTypeType], # (3)
removeNetworkAccessConfiguration: NotRequired[bool],
removeVpcConfiguration: NotRequired[bool],
stackSetName: NotRequired[str],
vpcConfiguration: NotRequired[VpcConfigurationTypeDef], # (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
- See PermissionTypeType
- See VpcConfigurationTypeDef
- See DataSourceTypeType
- See NotificationDestinationTypeType
WorkspaceDescriptionTypeDef#
# 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],
licenseExpiration: NotRequired[datetime],
licenseType: NotRequired[LicenseTypeType], # (4)
name: NotRequired[str],
networkAccessControl: NotRequired[NetworkAccessConfigurationTypeDef], # (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[VpcConfigurationTypeDef], # (9)
workspaceRoleArn: NotRequired[str],
- See AccountAccessTypeType
- See AuthenticationSummaryTypeDef
- See DataSourceTypeType
- See LicenseTypeType
- See NetworkAccessConfigurationTypeDef
- See NotificationDestinationTypeType
- See PermissionTypeType
- See WorkspaceStatusType
- See VpcConfigurationTypeDef
ListPermissionsRequestListPermissionsPaginateTypeDef#
# ListPermissionsRequestListPermissionsPaginateTypeDef definition
class ListPermissionsRequestListPermissionsPaginateTypeDef(TypedDict):
workspaceId: str,
groupId: NotRequired[str],
userId: NotRequired[str],
userType: NotRequired[UserTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See UserTypeType
- See PaginatorConfigTypeDef
ListVersionsRequestListVersionsPaginateTypeDef#
# ListVersionsRequestListVersionsPaginateTypeDef definition
class ListVersionsRequestListVersionsPaginateTypeDef(TypedDict):
workspaceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWorkspacesRequestListWorkspacesPaginateTypeDef#
# ListWorkspacesRequestListWorkspacesPaginateTypeDef definition
class ListWorkspacesRequestListWorkspacesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
PermissionEntryTypeDef#
# PermissionEntryTypeDef definition
class PermissionEntryTypeDef(TypedDict):
role: RoleType, # (1)
user: UserTypeDef, # (2)
- See RoleType
- See UserTypeDef
UpdateInstructionTypeDef#
# UpdateInstructionTypeDef definition
class UpdateInstructionTypeDef(TypedDict):
action: UpdateActionType, # (1)
role: RoleType, # (2)
users: Sequence[UserTypeDef], # (3)
- See UpdateActionType
- See RoleType
- See UserTypeDef
SamlConfigurationTypeDef#
# SamlConfigurationTypeDef definition
class SamlConfigurationTypeDef(TypedDict):
idpMetadata: IdpMetadataTypeDef, # (2)
allowedOrganizations: NotRequired[List[str]],
assertionAttributes: NotRequired[AssertionAttributesTypeDef], # (1)
loginValidityDuration: NotRequired[int],
roleValues: NotRequired[RoleValuesTypeDef], # (3)
ListWorkspacesResponseTypeDef#
# ListWorkspacesResponseTypeDef definition
class ListWorkspacesResponseTypeDef(TypedDict):
nextToken: str,
workspaces: List[WorkspaceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssociateLicenseResponseTypeDef#
# AssociateLicenseResponseTypeDef definition
class AssociateLicenseResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkspaceResponseTypeDef#
# CreateWorkspaceResponseTypeDef definition
class CreateWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteWorkspaceResponseTypeDef#
# DeleteWorkspaceResponseTypeDef definition
class DeleteWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWorkspaceResponseTypeDef#
# DescribeWorkspaceResponseTypeDef definition
class DescribeWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociateLicenseResponseTypeDef#
# DisassociateLicenseResponseTypeDef definition
class DisassociateLicenseResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkspaceResponseTypeDef#
# UpdateWorkspaceResponseTypeDef definition
class UpdateWorkspaceResponseTypeDef(TypedDict):
workspace: WorkspaceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPermissionsResponseTypeDef#
# ListPermissionsResponseTypeDef definition
class ListPermissionsResponseTypeDef(TypedDict):
nextToken: str,
permissions: List[PermissionEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateErrorTypeDef#
# UpdateErrorTypeDef definition
class UpdateErrorTypeDef(TypedDict):
causedBy: UpdateInstructionTypeDef, # (1)
code: int,
message: str,
UpdatePermissionsRequestRequestTypeDef#
# UpdatePermissionsRequestRequestTypeDef definition
class UpdatePermissionsRequestRequestTypeDef(TypedDict):
updateInstructionBatch: Sequence[UpdateInstructionTypeDef], # (1)
workspaceId: str,
SamlAuthenticationTypeDef#
# SamlAuthenticationTypeDef definition
class SamlAuthenticationTypeDef(TypedDict):
status: SamlConfigurationStatusType, # (2)
configuration: NotRequired[SamlConfigurationTypeDef], # (1)
UpdateWorkspaceAuthenticationRequestRequestTypeDef#
# UpdateWorkspaceAuthenticationRequestRequestTypeDef definition
class UpdateWorkspaceAuthenticationRequestRequestTypeDef(TypedDict):
authenticationProviders: Sequence[AuthenticationProviderTypesType], # (1)
workspaceId: str,
samlConfiguration: NotRequired[SamlConfigurationTypeDef], # (2)
UpdatePermissionsResponseTypeDef#
# UpdatePermissionsResponseTypeDef definition
class UpdatePermissionsResponseTypeDef(TypedDict):
errors: List[UpdateErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AuthenticationDescriptionTypeDef#
# AuthenticationDescriptionTypeDef definition
class AuthenticationDescriptionTypeDef(TypedDict):
providers: List[AuthenticationProviderTypesType], # (2)
awsSso: NotRequired[AwsSsoAuthenticationTypeDef], # (1)
saml: NotRequired[SamlAuthenticationTypeDef], # (3)
DescribeWorkspaceAuthenticationResponseTypeDef#
# DescribeWorkspaceAuthenticationResponseTypeDef definition
class DescribeWorkspaceAuthenticationResponseTypeDef(TypedDict):
authentication: AuthenticationDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkspaceAuthenticationResponseTypeDef#
# UpdateWorkspaceAuthenticationResponseTypeDef definition
class UpdateWorkspaceAuthenticationResponseTypeDef(TypedDict):
authentication: AuthenticationDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)