Skip to content

Environment

Source code in docs_src/capo_finspace/types/environment.py
class Environment(TypedDict, closed=True):
    name: NotRequired["capo_finspace.types.environment_name.EnvironmentName"]
    """<p>The name of the FinSpace environment.</p>"""
    environment_id: NotRequired["capo_finspace.types.id_type.IdType"]
    """<p>The identifier of the FinSpace environment.</p>"""
    aws_account_id: NotRequired["capo_finspace.types.id_type.IdType"]
    """<p>The ID of the AWS account in which the FinSpace environment is created.</p>"""
    status: NotRequired["capo_finspace.types.environment_status.EnvironmentStatus"]
    """<p>The current status of creation of the FinSpace environment.</p>"""
    environment_url: NotRequired["capo_finspace.types.url.url"]
    """<p>The sign-in URL for the web application of your FinSpace environment.</p>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>The description of the FinSpace environment.</p>"""
    environment_arn: NotRequired["capo_finspace.types.environment_arn.EnvironmentArn"]
    """<p>The Amazon Resource Name (ARN) of your FinSpace environment.</p>"""
    sage_maker_studio_domain_url: NotRequired[
        "capo_finspace.types.sms_domain_url.SmsDomainUrl"
    ]
    """<p>The URL of the integrated FinSpace notebook environment in your web application.</p>"""
    kms_key_id: NotRequired["capo_finspace.types.kms_key_id.KmsKeyId"]
    """<p>The KMS key id used to encrypt in the FinSpace environment.</p>"""
    dedicated_service_account_id: NotRequired["capo_finspace.types.id_type.IdType"]
    """<p>The AWS account ID of the dedicated service account associated with your FinSpace environment.</p>"""
    federation_mode: NotRequired["capo_finspace.types.federation_mode.FederationMode"]
    """<p>The authentication mode for the environment.</p>"""
    federation_parameters: NotRequired[
        "capo_finspace.types.federation_parameters.FederationParameters"
    ]
    """<p>Configuration information when authentication mode is FEDERATED.</p>"""

aws_account_id instance-attribute

aws_account_id: NotRequired[IdType]

The ID of the AWS account in which the FinSpace environment is created.

dedicated_service_account_id instance-attribute

dedicated_service_account_id: NotRequired[IdType]

The AWS account ID of the dedicated service account associated with your FinSpace environment.

description instance-attribute

description: NotRequired[Description]

The description of the FinSpace environment.

environment_arn instance-attribute

environment_arn: NotRequired[EnvironmentArn]

The Amazon Resource Name (ARN) of your FinSpace environment.

environment_id instance-attribute

environment_id: NotRequired[IdType]

The identifier of the FinSpace environment.

environment_url instance-attribute

environment_url: NotRequired[url]

The sign-in URL for the web application of your FinSpace environment.

federation_mode instance-attribute

federation_mode: NotRequired[FederationMode]

The authentication mode for the environment.

federation_parameters instance-attribute

federation_parameters: NotRequired[FederationParameters]

Configuration information when authentication mode is FEDERATED.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The KMS key id used to encrypt in the FinSpace environment.

name instance-attribute

name: NotRequired[EnvironmentName]

The name of the FinSpace environment.

sage_maker_studio_domain_url instance-attribute

sage_maker_studio_domain_url: NotRequired[SmsDomainUrl]

The URL of the integrated FinSpace notebook environment in your web application.

status instance-attribute

status: NotRequired[EnvironmentStatus]

The current status of creation of the FinSpace environment.