Skip to content

GetEnvironmentResponse

Source code in docs_src/capo_m2/types/get_environment_response.py
class GetEnvironmentResponse(TypedDict, closed=True):
    name: "capo_m2.types.entity_name.EntityName"
    """<p>The name of the runtime environment. Must be unique within the account.</p>"""
    description: NotRequired["capo_m2.types.entity_description.EntityDescription"]
    """<p>The description of the runtime environment.</p>"""
    environment_arn: "capo_m2.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the runtime environment.</p>"""
    environment_id: "capo_m2.types.identifier.Identifier"
    """<p>The unique identifier of the runtime environment.</p>"""
    instance_type: "capo_m2.types.string20.String20"
    """<p>The type of instance underlying the runtime environment.</p>"""
    status: "capo_m2.types.environment_lifecycle.EnvironmentLifecycle"
    """<p>The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be <code>Unhealthy</code>.</p>"""
    engine_type: "capo_m2.types.engine_type.EngineType"
    """<p>The target platform for the runtime environment.</p>"""
    engine_version: "capo_m2.types.engine_version.EngineVersion"
    """<p>The version of the runtime engine.</p>"""
    vpc_id: "capo_m2.types.string50.String50"
    """<p>The unique identifier for the VPC used with this runtime environment.</p>"""
    subnet_ids: "capo_m2.types.string50_list.String50List"
    """<p>The unique identifiers of the subnets assigned to this runtime environment.</p>"""
    security_group_ids: "capo_m2.types.string50_list.String50List"
    """<p>The unique identifiers of the security groups assigned to this runtime environment.</p>"""
    creation_time: "capo_m2.types.timestamp.Timestamp"
    """<p>The timestamp when the runtime environment was created.</p>"""
    storage_configurations: NotRequired[
        "capo_m2.types.storage_configuration_list.StorageConfigurationList"
    ]
    """<p>The storage configurations defined for the runtime environment.</p>"""
    tags: NotRequired["capo_m2.types.tag_map.TagMap"]
    """<p>The tags defined for this runtime environment.</p>"""
    high_availability_config: NotRequired[
        "capo_m2.types.high_availability_config.HighAvailabilityConfig"
    ]
    """<p>The desired capacity of the high availability configuration for the runtime environment.</p>"""
    publicly_accessible: "capo_m2.types.boolean.Boolean"
    """<p>Whether applications running in this runtime environment are publicly accessible. </p>"""
    actual_capacity: NotRequired["capo_m2.types.capacity_value.CapacityValue"]
    """<p>The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances. </p>"""
    load_balancer_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.</p>"""
    status_reason: NotRequired["str"]
    """<p>The reason for the reported status.</p>"""
    preferred_maintenance_window: NotRequired["capo_m2.types.string50.String50"]
    """<p>The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.</p>"""
    pending_maintenance: NotRequired[
        "capo_m2.types.pending_maintenance.PendingMaintenance"
    ]
    """<p>Indicates the pending maintenance scheduled on this environment.</p>"""
    kms_key_id: NotRequired["str"]
    """<p>The identifier of a customer managed key.</p>"""
    network_type: NotRequired["capo_m2.types.network_type.NetworkType"]
    """<p>The network type supported by the runtime environment.</p>"""

actual_capacity instance-attribute

actual_capacity: NotRequired[CapacityValue]

The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

creation_time instance-attribute

creation_time: Timestamp

The timestamp when the runtime environment was created.

description instance-attribute

description: NotRequired[EntityDescription]

The description of the runtime environment.

engine_type instance-attribute

engine_type: EngineType

The target platform for the runtime environment.

engine_version instance-attribute

engine_version: EngineVersion

The version of the runtime engine.

environment_arn instance-attribute

environment_arn: Arn

The Amazon Resource Name (ARN) of the runtime environment.

environment_id instance-attribute

environment_id: Identifier

The unique identifier of the runtime environment.

high_availability_config instance-attribute

high_availability_config: NotRequired[HighAvailabilityConfig]

The desired capacity of the high availability configuration for the runtime environment.

instance_type instance-attribute

instance_type: String20

The type of instance underlying the runtime environment.

kms_key_id instance-attribute

kms_key_id: NotRequired[str]

The identifier of a customer managed key.

load_balancer_arn instance-attribute

load_balancer_arn: NotRequired[str]

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

name instance-attribute

name: EntityName

The name of the runtime environment. Must be unique within the account.

network_type instance-attribute

network_type: NotRequired[NetworkType]

The network type supported by the runtime environment.

pending_maintenance instance-attribute

pending_maintenance: NotRequired[PendingMaintenance]

Indicates the pending maintenance scheduled on this environment.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[String50]

The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

publicly_accessible instance-attribute

publicly_accessible: Boolean

Whether applications running in this runtime environment are publicly accessible.

security_group_ids instance-attribute

security_group_ids: String50List

The unique identifiers of the security groups assigned to this runtime environment.

status instance-attribute

The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.

status_reason instance-attribute

status_reason: NotRequired[str]

The reason for the reported status.

storage_configurations instance-attribute

storage_configurations: NotRequired[StorageConfigurationList]

The storage configurations defined for the runtime environment.

subnet_ids instance-attribute

subnet_ids: String50List

The unique identifiers of the subnets assigned to this runtime environment.

tags instance-attribute

tags: NotRequired[TagMap]

The tags defined for this runtime environment.

vpc_id instance-attribute

vpc_id: String50

The unique identifier for the VPC used with this runtime environment.