update_agent_runtime¶
Operation¶
update_agent_runtime
¶
update_agent_runtime(request: UpdateAgentRuntimeInput | UpdateAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentRuntimeInputDict]) -> UpdateAgentRuntimeOutput
Updates an existing Amazon Secure Agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateAgentRuntimeInput | UpdateAgentRuntimeInputDict | 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[UpdateAgentRuntimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateAgentRuntimeOutput
|
An instance of |
update_agent_runtime
async
¶
update_agent_runtime(request: UpdateAgentRuntimeInput | UpdateAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentRuntimeInputDict]) -> UpdateAgentRuntimeOutput
Updates an existing Amazon Secure Agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateAgentRuntimeInput | UpdateAgentRuntimeInputDict | 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[UpdateAgentRuntimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateAgentRuntimeOutput
|
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.
UpdateAgentRuntimeInputDict
¶
Bases: TypedDict
Dictionary form of UpdateAgentRuntimeInput.
Attributes¶
agent_runtime_artifact
instance-attribute
¶
agent_runtime_artifact: Required[AgentRuntimeArtifact | AgentRuntimeArtifactDict]
The updated artifact of the AgentCore Runtime.
agent_runtime_id
instance-attribute
¶
The unique identifier of the AgentCore Runtime to update.
allowed_ports
instance-attribute
¶
allowed_ports: Sequence[AllowedPort | AllowedPortDict] | None
The updated 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 updated authorizer configuration for the AgentCore Runtime.
capacity_provider_configuration
instance-attribute
¶
capacity_provider_configuration: CapacityProviderConfiguration | CapacityProviderConfigurationDict | None
The updated capacity provider configuration for the AgentCore Runtime.
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.
description
instance-attribute
¶
description: str | None
The updated description of the AgentCore Runtime.
environment_variables
instance-attribute
¶
Updated environment variables to set in the AgentCore Runtime environment.
filesystem_configurations
instance-attribute
¶
filesystem_configurations: Sequence[FilesystemConfiguration | FilesystemConfigurationDict] | None
The updated filesystem configurations to mount into the AgentCore Runtime.
hooks_configuration
instance-attribute
¶
hooks_configuration: RuntimeHooksConfiguration | RuntimeHooksConfigurationDict | None
The updated lifecycle hooks configuration for the AgentCore Runtime.
lifecycle_configuration
instance-attribute
¶
lifecycle_configuration: LifecycleConfiguration | LifecycleConfigurationDict | None
The updated life cycle configuration for the AgentCore Runtime.
metadata_configuration
instance-attribute
¶
metadata_configuration: RuntimeMetadataConfiguration | RuntimeMetadataConfigurationDict | None
The updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
network_configuration
instance-attribute
¶
network_configuration: NetworkConfiguration | NetworkConfigurationDict | None
The updated network configuration for the AgentCore Runtime.
platform_version
instance-attribute
¶
platform_version: str | None
The updated version of the runtime platform to use for the AgentCore Runtime.
protocol_configuration
instance-attribute
¶
protocol_configuration: ProtocolConfiguration | ProtocolConfigurationDict | None
The updated 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
The updated configuration for HTTP request headers that will be passed through to the runtime.
resource_configurations
instance-attribute
¶
resource_configurations: Sequence[ResourceConfiguration | ResourceConfigurationDict] | None
The updated resource configurations for the AgentCore Runtime. You can specify at most one resource configuration.
UpdateAgentRuntimeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAgentRuntimeInput structure.
Attributes¶
agent_runtime_artifact
class-attribute
instance-attribute
¶
agent_runtime_artifact: AgentRuntimeArtifact | None = ...
The updated artifact of the AgentCore Runtime.
agent_runtime_id
class-attribute
instance-attribute
¶
agent_runtime_id: str | None = ...
The unique identifier of the AgentCore Runtime to update.
allowed_ports
class-attribute
instance-attribute
¶
allowed_ports: list[AllowedPort] | None = ...
The updated 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 updated authorizer configuration for the AgentCore Runtime.
capacity_provider_configuration
class-attribute
instance-attribute
¶
capacity_provider_configuration: CapacityProviderConfiguration | None = ...
The updated capacity provider configuration for the AgentCore Runtime.
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 updated description of the AgentCore Runtime.
environment_variables
class-attribute
instance-attribute
¶
Updated environment variables to set in the AgentCore Runtime environment.
filesystem_configurations
class-attribute
instance-attribute
¶
filesystem_configurations: list[FilesystemConfiguration] | None = ...
The updated filesystem configurations to mount into the AgentCore Runtime.
hooks_configuration
class-attribute
instance-attribute
¶
hooks_configuration: RuntimeHooksConfiguration | None = ...
The updated lifecycle hooks configuration for the AgentCore Runtime.
lifecycle_configuration
class-attribute
instance-attribute
¶
lifecycle_configuration: LifecycleConfiguration | None = ...
The updated life cycle configuration for the AgentCore Runtime.
metadata_configuration
class-attribute
instance-attribute
¶
metadata_configuration: RuntimeMetadataConfiguration | None = ...
The updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
network_configuration
class-attribute
instance-attribute
¶
network_configuration: NetworkConfiguration | None = ...
The updated network configuration for the AgentCore Runtime.
platform_version
class-attribute
instance-attribute
¶
platform_version: str | None = ...
The updated version of the runtime platform to use for the AgentCore Runtime.
protocol_configuration
class-attribute
instance-attribute
¶
protocol_configuration: ProtocolConfiguration | None = ...
The updated 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 = ...
The updated 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 updated resource configurations for the AgentCore Runtime. You can specify at most one resource configuration.
Output¶
UpdateAgentRuntimeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAgentRuntimeOutput structure.
Attributes¶
agent_runtime_arn
instance-attribute
¶
agent_runtime_arn: str
The Amazon Resource Name (ARN) of the updated AgentCore Runtime.
agent_runtime_id
instance-attribute
¶
agent_runtime_id: str
The unique identifier of the updated AgentCore Runtime.
agent_runtime_version
instance-attribute
¶
agent_runtime_version: str
The version of the updated AgentCore Runtime.
created_at
instance-attribute
¶
created_at: datetime
The timestamp when the AgentCore Runtime was created.
last_updated_at
instance-attribute
¶
last_updated_at: datetime
The timestamp when the AgentCore Runtime was last updated.
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 updated AgentCore Runtime.