Skip to content

Typed dictionaries

Index > ManagedGrafana > Typed dictionaries

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

AssertionAttributesTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import AssertionAttributesTypeDef

def get_value() -> AssertionAttributesTypeDef:
    return {
        "email": ...,
    }
Definition
class AssertionAttributesTypeDef(TypedDict):
    email: NotRequired[str],
    groups: NotRequired[str],
    login: NotRequired[str],
    name: NotRequired[str],
    org: NotRequired[str],
    role: NotRequired[str],

AssociateLicenseRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import AssociateLicenseRequestRequestTypeDef

def get_value() -> AssociateLicenseRequestRequestTypeDef:
    return {
        "licenseType": ...,
        "workspaceId": ...,
    }
Definition
class AssociateLicenseRequestRequestTypeDef(TypedDict):
    licenseType: LicenseTypeType,  # (1)
    workspaceId: str,
  1. See LicenseTypeType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AwsSsoAuthenticationTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import AwsSsoAuthenticationTypeDef

def get_value() -> AwsSsoAuthenticationTypeDef:
    return {
        "ssoClientId": ...,
    }
Definition
class AwsSsoAuthenticationTypeDef(TypedDict):
    ssoClientId: NotRequired[str],

AuthenticationSummaryTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import AuthenticationSummaryTypeDef

def get_value() -> AuthenticationSummaryTypeDef:
    return {
        "providers": ...,
    }
Definition
class AuthenticationSummaryTypeDef(TypedDict):
    providers: List[AuthenticationProviderTypesType],  # (1)
    samlConfigurationStatus: NotRequired[SamlConfigurationStatusType],  # (2)
  1. See AuthenticationProviderTypesType
  2. See SamlConfigurationStatusType

CreateWorkspaceApiKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import CreateWorkspaceApiKeyRequestRequestTypeDef

def get_value() -> CreateWorkspaceApiKeyRequestRequestTypeDef:
    return {
        "keyName": ...,
        "keyRole": ...,
        "secondsToLive": ...,
        "workspaceId": ...,
    }
Definition
class CreateWorkspaceApiKeyRequestRequestTypeDef(TypedDict):
    keyName: str,
    keyRole: str,
    secondsToLive: int,
    workspaceId: str,

CreateWorkspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import CreateWorkspaceRequestRequestTypeDef

def get_value() -> CreateWorkspaceRequestRequestTypeDef:
    return {
        "accountAccessType": ...,
        "authenticationProviders": ...,
        "permissionType": ...,
    }
Definition
class CreateWorkspaceRequestRequestTypeDef(TypedDict):
    accountAccessType: AccountAccessTypeType,  # (1)
    authenticationProviders: Sequence[AuthenticationProviderTypesType],  # (2)
    permissionType: PermissionTypeType,  # (3)
    clientToken: NotRequired[str],
    organizationRoleName: NotRequired[str],
    stackSetName: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    workspaceDataSources: NotRequired[Sequence[DataSourceTypeType]],  # (4)
    workspaceDescription: NotRequired[str],
    workspaceName: NotRequired[str],
    workspaceNotificationDestinations: NotRequired[Sequence[NotificationDestinationTypeType]],  # (5)
    workspaceOrganizationalUnits: NotRequired[Sequence[str]],
    workspaceRoleArn: NotRequired[str],
  1. See AccountAccessTypeType
  2. See AuthenticationProviderTypesType
  3. See PermissionTypeType
  4. See DataSourceTypeType
  5. See NotificationDestinationTypeType

DeleteWorkspaceApiKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DeleteWorkspaceApiKeyRequestRequestTypeDef

def get_value() -> DeleteWorkspaceApiKeyRequestRequestTypeDef:
    return {
        "keyName": ...,
        "workspaceId": ...,
    }
Definition
class DeleteWorkspaceApiKeyRequestRequestTypeDef(TypedDict):
    keyName: str,
    workspaceId: str,

DeleteWorkspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DeleteWorkspaceRequestRequestTypeDef

def get_value() -> DeleteWorkspaceRequestRequestTypeDef:
    return {
        "workspaceId": ...,
    }
Definition
class DeleteWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,

DescribeWorkspaceAuthenticationRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DescribeWorkspaceAuthenticationRequestRequestTypeDef

def get_value() -> DescribeWorkspaceAuthenticationRequestRequestTypeDef:
    return {
        "workspaceId": ...,
    }
Definition
class DescribeWorkspaceAuthenticationRequestRequestTypeDef(TypedDict):
    workspaceId: str,

DescribeWorkspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DescribeWorkspaceRequestRequestTypeDef

def get_value() -> DescribeWorkspaceRequestRequestTypeDef:
    return {
        "workspaceId": ...,
    }
Definition
class DescribeWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,

DisassociateLicenseRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DisassociateLicenseRequestRequestTypeDef

def get_value() -> DisassociateLicenseRequestRequestTypeDef:
    return {
        "licenseType": ...,
        "workspaceId": ...,
    }
Definition
class DisassociateLicenseRequestRequestTypeDef(TypedDict):
    licenseType: LicenseTypeType,  # (1)
    workspaceId: str,
  1. See LicenseTypeType

IdpMetadataTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import IdpMetadataTypeDef

def get_value() -> IdpMetadataTypeDef:
    return {
        "url": ...,
    }
Definition
class IdpMetadataTypeDef(TypedDict):
    url: NotRequired[str],
    xml: NotRequired[str],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListPermissionsRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListPermissionsRequestRequestTypeDef

def get_value() -> ListPermissionsRequestRequestTypeDef:
    return {
        "workspaceId": ...,
    }
Definition
class ListPermissionsRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    groupId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    userId: NotRequired[str],
    userType: NotRequired[UserTypeType],  # (1)
  1. See UserTypeType

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListWorkspacesRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListWorkspacesRequestRequestTypeDef

def get_value() -> ListWorkspacesRequestRequestTypeDef:
    return {
        "maxResults": ...,
    }
Definition
class ListWorkspacesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

UserTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UserTypeDef

def get_value() -> UserTypeDef:
    return {
        "id": ...,
        "type": ...,
    }
Definition
class UserTypeDef(TypedDict):
    id: str,
    type: UserTypeType,  # (1)
  1. See UserTypeType

RoleValuesTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import RoleValuesTypeDef

def get_value() -> RoleValuesTypeDef:
    return {
        "admin": ...,
    }
Definition
class RoleValuesTypeDef(TypedDict):
    admin: NotRequired[List[str]],
    editor: NotRequired[List[str]],

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateWorkspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdateWorkspaceRequestRequestTypeDef

def get_value() -> UpdateWorkspaceRequestRequestTypeDef:
    return {
        "workspaceId": ...,
    }
Definition
class UpdateWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    accountAccessType: NotRequired[AccountAccessTypeType],  # (1)
    organizationRoleName: NotRequired[str],
    permissionType: NotRequired[PermissionTypeType],  # (2)
    stackSetName: NotRequired[str],
    workspaceDataSources: NotRequired[Sequence[DataSourceTypeType]],  # (3)
    workspaceDescription: NotRequired[str],
    workspaceName: NotRequired[str],
    workspaceNotificationDestinations: NotRequired[Sequence[NotificationDestinationTypeType]],  # (4)
    workspaceOrganizationalUnits: NotRequired[Sequence[str]],
    workspaceRoleArn: NotRequired[str],
  1. See AccountAccessTypeType
  2. See PermissionTypeType
  3. See DataSourceTypeType
  4. See NotificationDestinationTypeType

CreateWorkspaceApiKeyResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import CreateWorkspaceApiKeyResponseTypeDef

def get_value() -> CreateWorkspaceApiKeyResponseTypeDef:
    return {
        "key": ...,
        "keyName": ...,
        "workspaceId": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateWorkspaceApiKeyResponseTypeDef(TypedDict):
    key: str,
    keyName: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteWorkspaceApiKeyResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DeleteWorkspaceApiKeyResponseTypeDef

def get_value() -> DeleteWorkspaceApiKeyResponseTypeDef:
    return {
        "keyName": ...,
        "workspaceId": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteWorkspaceApiKeyResponseTypeDef(TypedDict):
    keyName: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

WorkspaceDescriptionTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import WorkspaceDescriptionTypeDef

def get_value() -> WorkspaceDescriptionTypeDef:
    return {
        "authentication": ...,
        "created": ...,
        "dataSources": ...,
        "endpoint": ...,
        "grafanaVersion": ...,
        "id": ...,
        "modified": ...,
        "status": ...,
    }
Definition
class WorkspaceDescriptionTypeDef(TypedDict):
    authentication: AuthenticationSummaryTypeDef,  # (2)
    created: datetime,
    dataSources: List[DataSourceTypeType],  # (3)
    endpoint: str,
    grafanaVersion: str,
    id: str,
    modified: datetime,
    status: WorkspaceStatusType,  # (7)
    accountAccessType: NotRequired[AccountAccessTypeType],  # (1)
    description: NotRequired[str],
    freeTrialConsumed: NotRequired[bool],
    freeTrialExpiration: NotRequired[datetime],
    licenseExpiration: NotRequired[datetime],
    licenseType: NotRequired[LicenseTypeType],  # (4)
    name: NotRequired[str],
    notificationDestinations: NotRequired[List[NotificationDestinationTypeType]],  # (5)
    organizationRoleName: NotRequired[str],
    organizationalUnits: NotRequired[List[str]],
    permissionType: NotRequired[PermissionTypeType],  # (6)
    stackSetName: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    workspaceRoleArn: NotRequired[str],
  1. See AccountAccessTypeType
  2. See AuthenticationSummaryTypeDef
  3. See DataSourceTypeType
  4. See LicenseTypeType
  5. See NotificationDestinationTypeType
  6. See PermissionTypeType
  7. See WorkspaceStatusType

WorkspaceSummaryTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import WorkspaceSummaryTypeDef

def get_value() -> WorkspaceSummaryTypeDef:
    return {
        "authentication": ...,
        "created": ...,
        "endpoint": ...,
        "grafanaVersion": ...,
        "id": ...,
        "modified": ...,
        "status": ...,
    }
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]],
  1. See AuthenticationSummaryTypeDef
  2. See NotificationDestinationTypeType
  3. See WorkspaceStatusType

ListPermissionsRequestListPermissionsPaginateTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListPermissionsRequestListPermissionsPaginateTypeDef

def get_value() -> ListPermissionsRequestListPermissionsPaginateTypeDef:
    return {
        "workspaceId": ...,
    }
Definition
class ListPermissionsRequestListPermissionsPaginateTypeDef(TypedDict):
    workspaceId: str,
    groupId: NotRequired[str],
    userId: NotRequired[str],
    userType: NotRequired[UserTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See UserTypeType
  2. See PaginatorConfigTypeDef

ListWorkspacesRequestListWorkspacesPaginateTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListWorkspacesRequestListWorkspacesPaginateTypeDef

def get_value() -> ListWorkspacesRequestListWorkspacesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListWorkspacesRequestListWorkspacesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

PermissionEntryTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import PermissionEntryTypeDef

def get_value() -> PermissionEntryTypeDef:
    return {
        "role": ...,
        "user": ...,
    }
Definition
class PermissionEntryTypeDef(TypedDict):
    role: RoleType,  # (1)
    user: UserTypeDef,  # (2)
  1. See RoleType
  2. See UserTypeDef

UpdateInstructionTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdateInstructionTypeDef

def get_value() -> UpdateInstructionTypeDef:
    return {
        "action": ...,
        "role": ...,
        "users": ...,
    }
Definition
class UpdateInstructionTypeDef(TypedDict):
    action: UpdateActionType,  # (1)
    role: RoleType,  # (2)
    users: Sequence[UserTypeDef],  # (3)
  1. See UpdateActionType
  2. See RoleType
  3. See UserTypeDef

SamlConfigurationTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import SamlConfigurationTypeDef

def get_value() -> SamlConfigurationTypeDef:
    return {
        "idpMetadata": ...,
    }
Definition
class SamlConfigurationTypeDef(TypedDict):
    idpMetadata: IdpMetadataTypeDef,  # (2)
    allowedOrganizations: NotRequired[List[str]],
    assertionAttributes: NotRequired[AssertionAttributesTypeDef],  # (1)
    loginValidityDuration: NotRequired[int],
    roleValues: NotRequired[RoleValuesTypeDef],  # (3)
  1. See AssertionAttributesTypeDef
  2. See IdpMetadataTypeDef
  3. See RoleValuesTypeDef

AssociateLicenseResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import AssociateLicenseResponseTypeDef

def get_value() -> AssociateLicenseResponseTypeDef:
    return {
        "workspace": ...,
        "ResponseMetadata": ...,
    }
Definition
class AssociateLicenseResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkspaceResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import CreateWorkspaceResponseTypeDef

def get_value() -> CreateWorkspaceResponseTypeDef:
    return {
        "workspace": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateWorkspaceResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DeleteWorkspaceResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DeleteWorkspaceResponseTypeDef

def get_value() -> DeleteWorkspaceResponseTypeDef:
    return {
        "workspace": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteWorkspaceResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeWorkspaceResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DescribeWorkspaceResponseTypeDef

def get_value() -> DescribeWorkspaceResponseTypeDef:
    return {
        "workspace": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeWorkspaceResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DisassociateLicenseResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DisassociateLicenseResponseTypeDef

def get_value() -> DisassociateLicenseResponseTypeDef:
    return {
        "workspace": ...,
        "ResponseMetadata": ...,
    }
Definition
class DisassociateLicenseResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

UpdateWorkspaceResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdateWorkspaceResponseTypeDef

def get_value() -> UpdateWorkspaceResponseTypeDef:
    return {
        "workspace": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateWorkspaceResponseTypeDef(TypedDict):
    workspace: WorkspaceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListWorkspacesResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListWorkspacesResponseTypeDef

def get_value() -> ListWorkspacesResponseTypeDef:
    return {
        "nextToken": ...,
        "workspaces": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListWorkspacesResponseTypeDef(TypedDict):
    nextToken: str,
    workspaces: List[WorkspaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkspaceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPermissionsResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import ListPermissionsResponseTypeDef

def get_value() -> ListPermissionsResponseTypeDef:
    return {
        "nextToken": ...,
        "permissions": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListPermissionsResponseTypeDef(TypedDict):
    nextToken: str,
    permissions: List[PermissionEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionEntryTypeDef
  2. See ResponseMetadataTypeDef

UpdateErrorTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdateErrorTypeDef

def get_value() -> UpdateErrorTypeDef:
    return {
        "causedBy": ...,
        "code": ...,
        "message": ...,
    }
Definition
class UpdateErrorTypeDef(TypedDict):
    causedBy: UpdateInstructionTypeDef,  # (1)
    code: int,
    message: str,
  1. See UpdateInstructionTypeDef

UpdatePermissionsRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdatePermissionsRequestRequestTypeDef

def get_value() -> UpdatePermissionsRequestRequestTypeDef:
    return {
        "updateInstructionBatch": ...,
        "workspaceId": ...,
    }
Definition
class UpdatePermissionsRequestRequestTypeDef(TypedDict):
    updateInstructionBatch: Sequence[UpdateInstructionTypeDef],  # (1)
    workspaceId: str,
  1. See UpdateInstructionTypeDef

SamlAuthenticationTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import SamlAuthenticationTypeDef

def get_value() -> SamlAuthenticationTypeDef:
    return {
        "status": ...,
    }
Definition
class SamlAuthenticationTypeDef(TypedDict):
    status: SamlConfigurationStatusType,  # (2)
    configuration: NotRequired[SamlConfigurationTypeDef],  # (1)
  1. See SamlConfigurationTypeDef
  2. See SamlConfigurationStatusType

UpdateWorkspaceAuthenticationRequestRequestTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdateWorkspaceAuthenticationRequestRequestTypeDef

def get_value() -> UpdateWorkspaceAuthenticationRequestRequestTypeDef:
    return {
        "authenticationProviders": ...,
        "workspaceId": ...,
    }
Definition
class UpdateWorkspaceAuthenticationRequestRequestTypeDef(TypedDict):
    authenticationProviders: Sequence[AuthenticationProviderTypesType],  # (1)
    workspaceId: str,
    samlConfiguration: NotRequired[SamlConfigurationTypeDef],  # (2)
  1. See AuthenticationProviderTypesType
  2. See SamlConfigurationTypeDef

UpdatePermissionsResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdatePermissionsResponseTypeDef

def get_value() -> UpdatePermissionsResponseTypeDef:
    return {
        "errors": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdatePermissionsResponseTypeDef(TypedDict):
    errors: List[UpdateErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UpdateErrorTypeDef
  2. See ResponseMetadataTypeDef

AuthenticationDescriptionTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import AuthenticationDescriptionTypeDef

def get_value() -> AuthenticationDescriptionTypeDef:
    return {
        "providers": ...,
    }
Definition
class AuthenticationDescriptionTypeDef(TypedDict):
    providers: List[AuthenticationProviderTypesType],  # (2)
    awsSso: NotRequired[AwsSsoAuthenticationTypeDef],  # (1)
    saml: NotRequired[SamlAuthenticationTypeDef],  # (3)
  1. See AwsSsoAuthenticationTypeDef
  2. See AuthenticationProviderTypesType
  3. See SamlAuthenticationTypeDef

DescribeWorkspaceAuthenticationResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import DescribeWorkspaceAuthenticationResponseTypeDef

def get_value() -> DescribeWorkspaceAuthenticationResponseTypeDef:
    return {
        "authentication": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeWorkspaceAuthenticationResponseTypeDef(TypedDict):
    authentication: AuthenticationDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthenticationDescriptionTypeDef
  2. See ResponseMetadataTypeDef

UpdateWorkspaceAuthenticationResponseTypeDef

Usage Example
from mypy_boto3_grafana.type_defs import UpdateWorkspaceAuthenticationResponseTypeDef

def get_value() -> UpdateWorkspaceAuthenticationResponseTypeDef:
    return {
        "authentication": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateWorkspaceAuthenticationResponseTypeDef(TypedDict):
    authentication: AuthenticationDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthenticationDescriptionTypeDef
  2. See ResponseMetadataTypeDef