Skip to content

Type definitions#

Index > ManagedGrafana > Type definitions

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

NetworkAccessConfigurationUnionTypeDef#

# NetworkAccessConfigurationUnionTypeDef definition

NetworkAccessConfigurationUnionTypeDef = Union[
    NetworkAccessConfigurationTypeDef,  # (1)
    NetworkAccessConfigurationOutputTypeDef,  # (2)
]
  1. See NetworkAccessConfigurationTypeDef
  2. See NetworkAccessConfigurationOutputTypeDef

VpcConfigurationUnionTypeDef#

# VpcConfigurationUnionTypeDef definition

VpcConfigurationUnionTypeDef = Union[
    VpcConfigurationTypeDef,  # (1)
    VpcConfigurationOutputTypeDef,  # (2)
]
  1. See VpcConfigurationTypeDef
  2. See VpcConfigurationOutputTypeDef

UpdateInstructionUnionTypeDef#

# UpdateInstructionUnionTypeDef definition

UpdateInstructionUnionTypeDef = Union[
    UpdateInstructionTypeDef,  # (1)
    UpdateInstructionOutputTypeDef,  # (2)
]
  1. See UpdateInstructionTypeDef
  2. See UpdateInstructionOutputTypeDef

SamlConfigurationUnionTypeDef#

# SamlConfigurationUnionTypeDef definition

SamlConfigurationUnionTypeDef = Union[
    SamlConfigurationTypeDef,  # (1)
    SamlConfigurationOutputTypeDef,  # (2)
]
  1. See SamlConfigurationTypeDef
  2. See SamlConfigurationOutputTypeDef

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,
    grafanaToken: NotRequired[str],
  1. See LicenseTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AwsSsoAuthenticationTypeDef#

# AwsSsoAuthenticationTypeDef definition

class AwsSsoAuthenticationTypeDef(TypedDict):
    ssoClientId: NotRequired[str],

AuthenticationSummaryTypeDef#

# AuthenticationSummaryTypeDef definition

class AuthenticationSummaryTypeDef(TypedDict):
    providers: List[AuthenticationProviderTypesType],  # (1)
    samlConfigurationStatus: NotRequired[SamlConfigurationStatusType],  # (2)
  1. See AuthenticationProviderTypesType
  2. See SamlConfigurationStatusType

CreateWorkspaceApiKeyRequestRequestTypeDef#

# CreateWorkspaceApiKeyRequestRequestTypeDef definition

class CreateWorkspaceApiKeyRequestRequestTypeDef(TypedDict):
    keyName: str,
    keyRole: str,
    secondsToLive: int,
    workspaceId: str,

NetworkAccessConfigurationTypeDef#

# NetworkAccessConfigurationTypeDef definition

class NetworkAccessConfigurationTypeDef(TypedDict):
    prefixListIds: Sequence[str],
    vpceIds: Sequence[str],

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef definition

class VpcConfigurationTypeDef(TypedDict):
    securityGroupIds: Sequence[str],
    subnetIds: Sequence[str],

CreateWorkspaceServiceAccountRequestRequestTypeDef#

# CreateWorkspaceServiceAccountRequestRequestTypeDef definition

class CreateWorkspaceServiceAccountRequestRequestTypeDef(TypedDict):
    grafanaRole: RoleType,  # (1)
    name: str,
    workspaceId: str,
  1. See RoleType

CreateWorkspaceServiceAccountTokenRequestRequestTypeDef#

# CreateWorkspaceServiceAccountTokenRequestRequestTypeDef definition

class CreateWorkspaceServiceAccountTokenRequestRequestTypeDef(TypedDict):
    name: str,
    secondsToLive: int,
    serviceAccountId: str,
    workspaceId: str,

ServiceAccountTokenSummaryWithKeyTypeDef#

# ServiceAccountTokenSummaryWithKeyTypeDef definition

class ServiceAccountTokenSummaryWithKeyTypeDef(TypedDict):
    id: str,
    key: str,
    name: str,

DeleteWorkspaceApiKeyRequestRequestTypeDef#

# DeleteWorkspaceApiKeyRequestRequestTypeDef definition

class DeleteWorkspaceApiKeyRequestRequestTypeDef(TypedDict):
    keyName: str,
    workspaceId: str,

DeleteWorkspaceRequestRequestTypeDef#

# DeleteWorkspaceRequestRequestTypeDef definition

class DeleteWorkspaceRequestRequestTypeDef(TypedDict):
    workspaceId: str,

DeleteWorkspaceServiceAccountRequestRequestTypeDef#

# DeleteWorkspaceServiceAccountRequestRequestTypeDef definition

class DeleteWorkspaceServiceAccountRequestRequestTypeDef(TypedDict):
    serviceAccountId: str,
    workspaceId: str,

DeleteWorkspaceServiceAccountTokenRequestRequestTypeDef#

# DeleteWorkspaceServiceAccountTokenRequestRequestTypeDef definition

class DeleteWorkspaceServiceAccountTokenRequestRequestTypeDef(TypedDict):
    serviceAccountId: str,
    tokenId: str,
    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,
  1. 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)
  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],

ListWorkspaceServiceAccountTokensRequestRequestTypeDef#

# ListWorkspaceServiceAccountTokensRequestRequestTypeDef definition

class ListWorkspaceServiceAccountTokensRequestRequestTypeDef(TypedDict):
    serviceAccountId: str,
    workspaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ServiceAccountTokenSummaryTypeDef#

# ServiceAccountTokenSummaryTypeDef definition

class ServiceAccountTokenSummaryTypeDef(TypedDict):
    createdAt: datetime,
    expiresAt: datetime,
    id: str,
    name: str,
    lastUsedAt: NotRequired[datetime],

ListWorkspaceServiceAccountsRequestRequestTypeDef#

# ListWorkspaceServiceAccountsRequestRequestTypeDef definition

class ListWorkspaceServiceAccountsRequestRequestTypeDef(TypedDict):
    workspaceId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ServiceAccountSummaryTypeDef#

# ServiceAccountSummaryTypeDef definition

class ServiceAccountSummaryTypeDef(TypedDict):
    grafanaRole: RoleType,  # (1)
    id: str,
    isDisabled: str,
    name: str,
  1. See RoleType

ListWorkspacesRequestRequestTypeDef#

# ListWorkspacesRequestRequestTypeDef definition

class ListWorkspacesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

NetworkAccessConfigurationOutputTypeDef#

# NetworkAccessConfigurationOutputTypeDef definition

class NetworkAccessConfigurationOutputTypeDef(TypedDict):
    prefixListIds: List[str],
    vpceIds: List[str],

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    id: str,
    type: UserTypeType,  # (1)
  1. See UserTypeType

RoleValuesOutputTypeDef#

# RoleValuesOutputTypeDef definition

class RoleValuesOutputTypeDef(TypedDict):
    admin: NotRequired[List[str]],
    editor: NotRequired[List[str]],

RoleValuesTypeDef#

# RoleValuesTypeDef definition

class RoleValuesTypeDef(TypedDict):
    admin: NotRequired[Sequence[str]],
    editor: NotRequired[Sequence[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],

VpcConfigurationOutputTypeDef#

# VpcConfigurationOutputTypeDef definition

class VpcConfigurationOutputTypeDef(TypedDict):
    securityGroupIds: List[str],
    subnetIds: List[str],

CreateWorkspaceApiKeyResponseTypeDef#

# CreateWorkspaceApiKeyResponseTypeDef definition

class CreateWorkspaceApiKeyResponseTypeDef(TypedDict):
    key: str,
    keyName: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWorkspaceServiceAccountResponseTypeDef#

# CreateWorkspaceServiceAccountResponseTypeDef definition

class CreateWorkspaceServiceAccountResponseTypeDef(TypedDict):
    grafanaRole: RoleType,  # (1)
    id: str,
    name: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RoleType
  2. See ResponseMetadataTypeDef

DeleteWorkspaceApiKeyResponseTypeDef#

# DeleteWorkspaceApiKeyResponseTypeDef definition

class DeleteWorkspaceApiKeyResponseTypeDef(TypedDict):
    keyName: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteWorkspaceServiceAccountResponseTypeDef#

# DeleteWorkspaceServiceAccountResponseTypeDef definition

class DeleteWorkspaceServiceAccountResponseTypeDef(TypedDict):
    serviceAccountId: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteWorkspaceServiceAccountTokenResponseTypeDef#

# DeleteWorkspaceServiceAccountTokenResponseTypeDef definition

class DeleteWorkspaceServiceAccountTokenResponseTypeDef(TypedDict):
    serviceAccountId: str,
    tokenId: str,
    workspaceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeWorkspaceConfigurationResponseTypeDef#

# DescribeWorkspaceConfigurationResponseTypeDef definition

class DescribeWorkspaceConfigurationResponseTypeDef(TypedDict):
    configuration: str,
    grafanaVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListVersionsResponseTypeDef#

# ListVersionsResponseTypeDef definition

class ListVersionsResponseTypeDef(TypedDict):
    grafanaVersions: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

WorkspaceSummaryTypeDef#

# 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]],
  1. See AuthenticationSummaryTypeDef
  2. See LicenseTypeType
  3. See NotificationDestinationTypeType
  4. See WorkspaceStatusType

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],
  1. See AccountAccessTypeType
  2. See