Skip to content

WorkspaceSummary

Source code in docs_src/capo_grafana/types/workspace_summary.py
class WorkspaceSummary(TypedDict, closed=True):
    created: "datetime.datetime"
    """<p>The date that the workspace was created.</p>"""
    description: NotRequired["capo_grafana.types.description.Description"]
    """<p>The customer-entered description of the workspace.</p>"""
    endpoint: "capo_grafana.types.endpoint.Endpoint"
    """<p>The URL endpoint to use to access the Grafana console in the workspace.</p>"""
    grafana_version: "capo_grafana.types.grafana_version.GrafanaVersion"
    """<p>The Grafana version that the workspace is running.</p>"""
    id: "capo_grafana.types.workspace_id.WorkspaceId"
    """<p>The unique ID of the workspace.</p>"""
    modified: "datetime.datetime"
    """<p>The most recent date that the workspace was modified.</p>"""
    name: NotRequired["capo_grafana.types.workspace_name.WorkspaceName"]
    """<p>The name of the workspace.</p>"""
    notification_destinations: NotRequired[
        "capo_grafana.types.notification_destinations_list.NotificationDestinationsList"
    ]
    """<p>The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.</p>"""
    status: "capo_grafana.types.workspace_status.WorkspaceStatus"
    """<p>The current status of the workspace.</p>"""
    authentication: "capo_grafana.types.authentication_summary.AuthenticationSummary"
    """<p>A structure containing information about the authentication methods used in the workspace.</p>"""
    tags: NotRequired["capo_grafana.types.tag_map.TagMap"]
    """<p>The list of tags associated with the workspace.</p>"""
    license_type: NotRequired["capo_grafana.types.license_type.LicenseType"]
    """<p>Specifies whether this workspace has a full Grafana Enterprise license.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>"""
    grafana_token: NotRequired["capo_grafana.types.grafana_token.GrafanaToken"]
    """<p>The token that ties this workspace to a Grafana Labs account. For more information, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise">Link your account with Grafana Labs</a>.</p>"""

authentication instance-attribute

authentication: AuthenticationSummary

A structure containing information about the authentication methods used in the workspace.

created instance-attribute

created: datetime

The date that the workspace was created.

description instance-attribute

description: NotRequired[Description]

The customer-entered description of the workspace.

endpoint instance-attribute

endpoint: Endpoint

The URL endpoint to use to access the Grafana console in the workspace.

grafana_token instance-attribute

grafana_token: NotRequired[GrafanaToken]

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

grafana_version instance-attribute

grafana_version: GrafanaVersion

The Grafana version that the workspace is running.

id instance-attribute

The unique ID of the workspace.

license_type instance-attribute

license_type: NotRequired[LicenseType]

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

modified instance-attribute

modified: datetime

The most recent date that the workspace was modified.

name instance-attribute

name: NotRequired[WorkspaceName]

The name of the workspace.

notification_destinations instance-attribute

notification_destinations: NotRequired[NotificationDestinationsList]

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

status instance-attribute

The current status of the workspace.

tags instance-attribute

tags: NotRequired[TagMap]

The list of tags associated with the workspace.