HostedApplicationIam¶

class oci.generative_ai.models.HostedApplicationIam(**kwargs)¶

Bases: object

Hosted Application IAM, defines shared configurations that apply across multiple deployments of the Agent or MCP application.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resources.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a HostedApplicationIam.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HostedApplicationIam.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HostedApplicationIam.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HostedApplicationIam.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a HostedApplicationIam.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a HostedApplicationIam.
`compartment_id`	Gets the compartment_id of this HostedApplicationIam.
`defined_tags`	Gets the defined_tags of this HostedApplicationIam.
`description`	Gets the description of this HostedApplicationIam.
`display_name`	[Required] Gets the display_name of this HostedApplicationIam.
`environment_variables`	Gets the environment_variables of this HostedApplicationIam.
`freeform_tags`	Gets the freeform_tags of this HostedApplicationIam.
`id`	[Required] Gets the id of this HostedApplicationIam.
`lifecycle_details`	Gets the lifecycle_details of this HostedApplicationIam.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HostedApplicationIam.
`networking_config`	Gets the networking_config of this HostedApplicationIam.
`scaling_config`	Gets the scaling_config of this HostedApplicationIam.
`storage_configs`	Gets the storage_configs of this HostedApplicationIam.
`system_tags`	Gets the system_tags of this HostedApplicationIam.
`time_created`	Gets the time_created of this HostedApplicationIam.
`time_updated`	Gets the time_updated of this HostedApplicationIam.

Methods

__init__(**kwargs) Initializes a new HostedApplicationIam object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a HostedApplicationIam. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a HostedApplicationIam. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a HostedApplicationIam. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a HostedApplicationIam. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a HostedApplicationIam. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a HostedApplicationIam. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new HostedApplicationIam object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this HostedApplicationIam.
display_name (str) – The value to assign to the display_name property of this HostedApplicationIam.
description (str) – The value to assign to the description property of this HostedApplicationIam.
compartment_id (str) – The value to assign to the compartment_id property of this HostedApplicationIam.
time_created (datetime) – The value to assign to the time_created property of this HostedApplicationIam.
time_updated (datetime) – The value to assign to the time_updated property of this HostedApplicationIam.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostedApplicationIam. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this HostedApplicationIam.
scaling_config (oci.generative_ai.models.ScalingConfig) – The value to assign to the scaling_config property of this HostedApplicationIam.
storage_configs (list[oci.generative_ai.models.StorageConfig]) – The value to assign to the storage_configs property of this HostedApplicationIam.
networking_config (oci.generative_ai.models.NetworkingConfig) – The value to assign to the networking_config property of this HostedApplicationIam.
environment_variables (list[oci.generative_ai.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this HostedApplicationIam.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostedApplicationIam.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostedApplicationIam.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostedApplicationIam.

compartment_id¶

Gets the compartment_id of this HostedApplicationIam. The compartment OCID to create the hosted application in.

Returns:	The compartment_id of this HostedApplicationIam.
Return type:	str

defined_tags¶

Gets the defined_tags of this HostedApplicationIam. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this HostedApplicationIam.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this HostedApplicationIam. An optional description of the hosted application.

Returns:	The description of this HostedApplicationIam.
Return type:	str

display_name¶

[Required] Gets the display_name of this HostedApplicationIam. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:	The display_name of this HostedApplicationIam.
Return type:	str

environment_variables¶

Gets the environment_variables of this HostedApplicationIam. The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime.

Returns:	The environment_variables of this HostedApplicationIam.
Return type:	list[oci.generative_ai.models.EnvironmentVariable]

freeform_tags¶

Gets the freeform_tags of this HostedApplicationIam. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this HostedApplicationIam.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this HostedApplicationIam. The OCID of the hosted application.

Returns:	The id of this HostedApplicationIam.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this HostedApplicationIam. A message describing the current state of the endpoint in more detail that can provide actionable information.

Returns:	The lifecycle_details of this HostedApplicationIam.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this HostedApplicationIam. The current state of the hosted application.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this HostedApplicationIam.
Return type:	str

networking_config¶

Gets the networking_config of this HostedApplicationIam.

Returns:	The networking_config of this HostedApplicationIam.
Return type:	oci.generative_ai.models.NetworkingConfig

scaling_config¶

Gets the scaling_config of this HostedApplicationIam.

Returns:	The scaling_config of this HostedApplicationIam.
Return type:	oci.generative_ai.models.ScalingConfig

storage_configs¶

Gets the storage_configs of this HostedApplicationIam. A list of storageConfigs managed by the OCI GenAI Platform and attached to the application.

Returns:	The storage_configs of this HostedApplicationIam.
Return type:	list[oci.generative_ai.models.StorageConfig]

system_tags¶

Gets the system_tags of this HostedApplicationIam. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this HostedApplicationIam.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this HostedApplicationIam. The date and time the hosted application was created, in the format defined by RFC 3339

Returns:	The time_created of this HostedApplicationIam.
Return type:	datetime

time_updated¶

Gets the time_updated of this HostedApplicationIam. The date and time the hosted application was updated, in the format defined by RFC 3339

Returns:	The time_updated of this HostedApplicationIam.
Return type:	datetime