Skip to content

WorkspaceDescription

Source code in docs_src/capo_amp/types/workspace_description.py
class WorkspaceDescription(TypedDict, closed=True):
    workspace_id: "capo_amp.types.workspace_id.WorkspaceId"
    """<p>The unique ID for the workspace. For example, <code>ws-example1-1234-abcd-5678-ef90abcd1234</code>.</p>"""
    alias: NotRequired["capo_amp.types.workspace_alias.WorkspaceAlias"]
    """<p>The alias that is assigned to this workspace to help identify it. It does not need to be unique.</p>"""
    arn: "capo_amp.types.workspace_arn.WorkspaceArn"
    """<p>The ARN of the workspace. For example, <code>arn:aws:aps:&lt;region&gt;:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234</code>.</p>"""
    status: "capo_amp.types.workspace_status.WorkspaceStatus"
    """<p>The current status of the workspace.</p>"""
    prometheus_endpoint: NotRequired["capo_amp.types.uri.Uri"]
    """<p>The Prometheus endpoint available for this workspace. For example, <code>https://aps-workspaces.&lt;region&gt;.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/</code>.</p>"""
    created_at: "datetime.datetime"
    """<p>The date and time that the workspace was created.</p>"""
    tags: NotRequired["capo_amp.types.tag_map.TagMap"]
    """<p>The list of tag keys and values that are associated with the workspace.</p>"""
    kms_key_arn: NotRequired["capo_amp.types.kms_key_arn.KmsKeyArn"]
    """<p>(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.</p>"""

alias instance-attribute

alias: NotRequired[WorkspaceAlias]

The alias that is assigned to this workspace to help identify it. It does not need to be unique.

arn instance-attribute

The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.

created_at instance-attribute

created_at: datetime

The date and time that the workspace was created.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

prometheus_endpoint instance-attribute

prometheus_endpoint: NotRequired[Uri]

The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/.

status instance-attribute

The current status of the workspace.

tags instance-attribute

tags: NotRequired[TagMap]

The list of tag keys and values that are associated with the workspace.

workspace_id instance-attribute

workspace_id: WorkspaceId

The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.