Skip to content

CreateWorkspaceRequest

Source code in docs_src/capo_amp/types/create_workspace_request.py 
14
15
16
17
18
19
20
21
22
class CreateWorkspaceRequest(TypedDict, closed=True):
    alias: NotRequired["capo_amp.types.workspace_alias.WorkspaceAlias"]
    """<p>An alias that you assign to this workspace to help you identify it. It does not need to be unique.</p> <p>Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.</p>"""
    client_token: NotRequired["capo_amp.types.idempotency_token.IdempotencyToken"]
    """<p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>"""
    tags: NotRequired["capo_amp.types.tag_map.TagMap"]
    """<p>The list of tag keys and values to associate with the workspace.</p>"""
    kms_key_arn: NotRequired["capo_amp.types.kms_key_arn.KmsKeyArn"]
    """<p>(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html">Encryption at rest</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p>"""

alias instance-attribute 

alias: NotRequired[WorkspaceAlias]

An alias that you assign to this workspace to help you identify it. It does not need to be unique.

Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

client_token instance-attribute 

client_token: NotRequired[IdempotencyToken]

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

kms_key_arn instance-attribute 

kms_key_arn: NotRequired[KmsKeyArn]

(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

tags instance-attribute 

tags: NotRequired[TagMap]

The list of tag keys and values to associate with the workspace.