WorkspaceDescription ¶

class WorkspaceDescription(TypedDict, closed=True):
    account_access_type: NotRequired[
        "capo_grafana.types.account_access_type.AccountAccessType"
    ]
    """<p>Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is <code>ORGANIZATION</code>, the <code>workspaceOrganizationalUnits</code> parameter specifies which organizational units the workspace can access.</p>"""
    created: "datetime.datetime"
    """<p>The date that the workspace was created.</p>"""
    data_sources: "capo_grafana.types.data_source_types_list.DataSourceTypesList"
    """<p>Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.</p> <p>This list is only used when the workspace was created through the Amazon Web Services console, and the <code>permissionType</code> is <code>SERVICE_MANAGED</code>.</p>"""
    description: NotRequired["capo_grafana.types.description.Description"]
    """<p>The user-defined description of the workspace.</p>"""
    endpoint: "capo_grafana.types.endpoint.Endpoint"
    """<p>The URL that users can use to access the Grafana console in the workspace.</p>"""
    grafana_version: "capo_grafana.types.grafana_version.GrafanaVersion"
    """<p>The version of Grafana supported in this workspace.</p>"""
    id: "capo_grafana.types.workspace_id.WorkspaceId"
    """<p>The unique ID of this 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>"""
    organization_role_name: NotRequired[
        "capo_grafana.types.organization_role_name.OrganizationRoleName"
    ]
    """<p>The name of the IAM role that is used to access resources through Organizations.</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, to allow Amazon Managed Grafana to use these channels.</p>"""
    organizational_units: NotRequired[
        "capo_grafana.types.organizational_unit_list.OrganizationalUnitList"
    ]
    """<p>Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.</p>"""
    permission_type: NotRequired["capo_grafana.types.permission_type.PermissionType"]
    """<p>If this is <code>SERVICE_MANAGED</code>, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</p> <p>If this is <code>CUSTOMER_MANAGED</code>, you must manage those roles and permissions yourself.</p> <p>If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, this parameter must be set to <code>CUSTOMER_MANAGED</code>.</p> <p>For more information about converting between customer and service managed, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html">Managing permissions for data sources and notification channels</a>. For more information about the roles and permissions that must be managed for customer managed workspaces, see <a href="https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a> </p>"""
    stack_set_name: NotRequired["capo_grafana.types.stack_set_name.StackSetName"]
    """<p>The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.</p>"""
    status: "capo_grafana.types.workspace_status.WorkspaceStatus"
    """<p>The current status of the workspace.</p>"""
    workspace_role_arn: NotRequired["capo_grafana.types.iam_role_arn.IamRoleArn"]
    """<p>The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.</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>"""
    free_trial_consumed: NotRequired["bool"]
    """<p>Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>"""
    license_expiration: NotRequired["datetime.datetime"]
    """<p>If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed.</p>"""
    free_trial_expiration: NotRequired["datetime.datetime"]
    """<p>If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.</p> <note> <p>Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.</p> </note>"""
    authentication: "capo_grafana.types.authentication_summary.AuthenticationSummary"
    """<p>A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.</p>"""
    tags: NotRequired["capo_grafana.types.tag_map.TagMap"]
    """<p>The list of tags associated with the workspace.</p>"""
    vpc_configuration: NotRequired[
        "capo_grafana.types.vpc_configuration.VpcConfiguration"
    ]
    """<p>The configuration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud).</p>"""
    network_access_control: NotRequired[
        "capo_grafana.types.network_access_configuration.NetworkAccessConfiguration"
    ]
    """<p>The configuration settings for network access to your workspace.</p>"""
    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>"""
    ip_address_type: NotRequired["capo_grafana.types.ip_address_type.IPAddressType"]
    """<p>The type of IP addresses supported for connection to the workspace. Valid values are <code>IPv4</code> and <code>DualStack</code>.</p>"""
    kms_key_id: NotRequired["capo_grafana.types.kms_key_id.KmsKeyId"]
    """<p>The ID or ARN of the Key Management Service key used for encrypting workspace data.</p>"""
    degraded_workspace_reason: NotRequired[
        "capo_grafana.types.degraded_workspace_reason.DegradedWorkspaceReason"
    ]
    """<p>If the workspace is in the <code>DEGRADED</code> status, this field describes the reason the workspace is degraded.</p>"""