create_agent_runtime¶
Operation¶
create_agent_runtime
¶
create_agent_runtime(request: CreateAgentRuntimeInput | CreateAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAgentRuntimeInputDict]) -> CreateAgentRuntimeOutput
Creates an Amazon Bedrock AgentCore Runtime.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateAgentRuntimeInput | CreateAgentRuntimeInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateAgentRuntimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateAgentRuntimeOutput
|
An instance of |
create_agent_runtime
async
¶
create_agent_runtime(request: CreateAgentRuntimeInput | CreateAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAgentRuntimeInputDict]) -> CreateAgentRuntimeOutput
Creates an Amazon Bedrock AgentCore Runtime.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateAgentRuntimeInput | CreateAgentRuntimeInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateAgentRuntimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateAgentRuntimeOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateAgentRuntimeInputDict
¶
Bases: TypedDict
Dictionary form of CreateAgentRuntimeInput.
Attributes¶
agent_runtime_artifact
instance-attribute
¶
agent_runtime_artifact: Required[AgentRuntimeArtifact | AgentRuntimeArtifactDict]
The artifact of the AgentCore Runtime.
agent_runtime_name
instance-attribute
¶
The name of the AgentCore Runtime.
allowed_ports
instance-attribute
¶
allowed_ports: Sequence[AllowedPort | AllowedPortDict] | None
The additional ports on the AgentCore Runtime that are reachable through
the runtime's session URL. Specify one to five non-overlapping entries,
each containing either a single port or an inclusive port range. Ports
must be between 8000 and 12000, excluding the reserved port 8443.
authorizer_configuration
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | AuthorizerConfigurationDict | None
The authorizer configuration for the AgentCore Runtime.
capacity_provider_configuration
instance-attribute
¶
capacity_provider_configuration: CapacityProviderConfiguration | CapacityProviderConfigurationDict | None
The capacity provider configuration for the AgentCore Runtime. Use a capacity provider to run the AgentCore Runtime on the Instances compute type, which provisions Amazon Web Services managed compute in your account.
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
environment_variables
instance-attribute
¶
Environment variables to set in the AgentCore Runtime environment.
filesystem_configurations
instance-attribute
¶
filesystem_configurations: Sequence[FilesystemConfiguration | FilesystemConfigurationDict] | None
The filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.
hooks_configuration
instance-attribute
¶
hooks_configuration: RuntimeHooksConfiguration | RuntimeHooksConfigurationDict | None
The lifecycle hooks configuration for the AgentCore Runtime. Use lifecycle hooks to run actions in the agent's container at fixed points in the runtime's lifecycle, such as warming up the agent before sessions are created.
lifecycle_configuration
instance-attribute
¶
lifecycle_configuration: LifecycleConfiguration | LifecycleConfigurationDict | None
The life cycle configuration for the AgentCore Runtime.
network_configuration
instance-attribute
¶
network_configuration: NetworkConfiguration | NetworkConfigurationDict | None
The network configuration for the AgentCore Runtime.
platform_version
instance-attribute
¶
platform_version: str | None
The version of the runtime platform to use for the AgentCore Runtime.
protocol_configuration
instance-attribute
¶
protocol_configuration: ProtocolConfiguration | ProtocolConfigurationDict | None
The protocol configuration for the AgentCore Runtime, including the protocol, port, and path on which the agent server is available.
request_header_configuration
instance-attribute
¶
request_header_configuration: RequestHeaderConfiguration | RequestHeaderConfigurationDict | None
Configuration for HTTP request headers that will be passed through to the runtime.
resource_configurations
instance-attribute
¶
resource_configurations: Sequence[ResourceConfiguration | ResourceConfigurationDict] | None
The resource configurations for the AgentCore Runtime, such as the minimum amount of memory to allocate to the runtime. You can specify at most one resource configuration.
role_arn
instance-attribute
¶
The IAM role ARN that provides permissions for the AgentCore Runtime.
CreateAgentRuntimeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateAgentRuntimeInput structure.
Attributes¶
agent_runtime_artifact
class-attribute
instance-attribute
¶
agent_runtime_artifact: AgentRuntimeArtifact | None = ...
The artifact of the AgentCore Runtime.
agent_runtime_name
class-attribute
instance-attribute
¶
agent_runtime_name: str | None = ...
The name of the AgentCore Runtime.
allowed_ports
class-attribute
instance-attribute
¶
allowed_ports: list[AllowedPort] | None = ...
The additional ports on the AgentCore Runtime that are reachable through
the runtime's session URL. Specify one to five non-overlapping entries,
each containing either a single port or an inclusive port range. Ports
must be between 8000 and 12000, excluding the reserved port 8443.
authorizer_configuration
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = ...
The authorizer configuration for the AgentCore Runtime.
capacity_provider_configuration
class-attribute
instance-attribute
¶
capacity_provider_configuration: CapacityProviderConfiguration | None = ...
The capacity provider configuration for the AgentCore Runtime. Use a capacity provider to run the AgentCore Runtime on the Instances compute type, which provisions Amazon Web Services managed compute in your account.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the AgentCore Runtime.
environment_variables
class-attribute
instance-attribute
¶
Environment variables to set in the AgentCore Runtime environment.
filesystem_configurations
class-attribute
instance-attribute
¶
filesystem_configurations: list[FilesystemConfiguration] | None = ...
The filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.
hooks_configuration
class-attribute
instance-attribute
¶
hooks_configuration: RuntimeHooksConfiguration | None = ...
The lifecycle hooks configuration for the AgentCore Runtime. Use lifecycle hooks to run actions in the agent's container at fixed points in the runtime's lifecycle, such as warming up the agent before sessions are created.
lifecycle_configuration
class-attribute
instance-attribute
¶
lifecycle_configuration: LifecycleConfiguration | None = ...
The life cycle configuration for the AgentCore Runtime.
network_configuration
class-attribute
instance-attribute
¶
network_configuration: NetworkConfiguration | None = ...
The network configuration for the AgentCore Runtime.
platform_version
class-attribute
instance-attribute
¶
platform_version: str | None = ...
The version of the runtime platform to use for the AgentCore Runtime.
protocol_configuration
class-attribute
instance-attribute
¶
protocol_configuration: ProtocolConfiguration | None = ...
The protocol configuration for the AgentCore Runtime, including the protocol, port, and path on which the agent server is available.
request_header_configuration
class-attribute
instance-attribute
¶
request_header_configuration: RequestHeaderConfiguration | None = ...
Configuration for HTTP request headers that will be passed through to the runtime.
resource_configurations
class-attribute
instance-attribute
¶
resource_configurations: list[ResourceConfiguration] | None = ...
The resource configurations for the AgentCore Runtime, such as the minimum amount of memory to allocate to the runtime. You can specify at most one resource configuration.
Output¶
CreateAgentRuntimeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateAgentRuntimeOutput structure.
Attributes¶
agent_runtime_arn
instance-attribute
¶
agent_runtime_arn: str
The Amazon Resource Name (ARN) of the AgentCore Runtime.
agent_runtime_id
instance-attribute
¶
agent_runtime_id: str
The unique identifier of the AgentCore Runtime.
agent_runtime_version
instance-attribute
¶
agent_runtime_version: str
The version of the AgentCore Runtime.
created_at
instance-attribute
¶
created_at: datetime
The timestamp when the AgentCore Runtime was created.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
workload_identity_details
class-attribute
instance-attribute
¶
workload_identity_details: WorkloadIdentityDetails | None = ...
The workload identity details for the AgentCore Runtime.