BedrockAgentCoreControlPlaneFrontingLayer / Client / create_agent_runtime
create_agent_runtime¶
- BedrockAgentCoreControlPlaneFrontingLayer.Client.create_agent_runtime(**kwargs)¶
Creates an Amazon Bedrock AgentCore Runtime.
See also: AWS API Documentation
Request Syntax
response = client.create_agent_runtime( agentRuntimeName='string', description='string', agentRuntimeArtifact={ 'containerConfiguration': { 'containerUri': 'string' } }, roleArn='string', networkConfiguration={ 'networkMode': 'PUBLIC'|'VPC', 'networkModeConfig': { 'securityGroups': [ 'string', ], 'subnets': [ 'string', ] } }, protocolConfiguration={ 'serverProtocol': 'MCP'|'HTTP' }, clientToken='string', environmentVariables={ 'string': 'string' }, authorizerConfiguration={ 'customJWTAuthorizer': { 'discoveryUrl': 'string', 'allowedAudience': [ 'string', ], 'allowedClients': [ 'string', ] } }, requestHeaderConfiguration={ 'requestHeaderAllowlist': [ 'string', ] }, tags={ 'string': 'string' } )
- Parameters:
agentRuntimeName (string) –
[REQUIRED]
The name of the AgentCore Runtime.
description (string) – The description of the AgentCore Runtime.
agentRuntimeArtifact (dict) –
[REQUIRED]
The artifact of the AgentCore Runtime.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
containerConfiguration
.containerConfiguration (dict) –
The container configuration for the agent artifact.
containerUri (string) – [REQUIRED]
The ECR URI of the container.
roleArn (string) –
[REQUIRED]
The IAM role ARN that provides permissions for the AgentCore Runtime.
networkConfiguration (dict) –
[REQUIRED]
The network configuration for the AgentCore Runtime.
networkMode (string) – [REQUIRED]
The network mode for the AgentCore Runtime.
networkModeConfig (dict) –
The network mode configuration for the AgentCore Runtime.
securityGroups (list) – [REQUIRED]
The security groups associated with the VPC configuration.
(string) –
subnets (list) – [REQUIRED]
The subnets associated with the VPC configuration.
(string) –
protocolConfiguration (dict) –
The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
serverProtocol (string) – [REQUIRED]
The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.
clientToken (string) –
A unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
environmentVariables (dict) –
Environment variables to set in the AgentCore Runtime environment.
(string) –
(string) –
authorizerConfiguration (dict) –
The authorizer configuration for the AgentCore Runtime.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
customJWTAuthorizer
.customJWTAuthorizer (dict) –
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.
discoveryUrl (string) – [REQUIRED]
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
allowedAudience (list) –
Represents individual audience values that are validated in the incoming JWT token validation process.
(string) –
allowedClients (list) –
Represents individual client IDs that are validated in the incoming JWT token validation process.
(string) –
requestHeaderConfiguration (dict) –
Configuration for HTTP request headers that will be passed through to the runtime.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
requestHeaderAllowlist
.requestHeaderAllowlist (list) –
A list of HTTP request headers that are allowed to be passed through to the runtime.
(string) –
tags (dict) –
A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
(string) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'agentRuntimeArn': 'string', 'workloadIdentityDetails': { 'workloadIdentityArn': 'string' }, 'agentRuntimeId': 'string', 'agentRuntimeVersion': 'string', 'createdAt': datetime(2015, 1, 1), 'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING' }
Response Structure
(dict) –
agentRuntimeArn (string) –
The Amazon Resource Name (ARN) of the AgentCore Runtime.
workloadIdentityDetails (dict) –
The workload identity details for the AgentCore Runtime.
workloadIdentityArn (string) –
The ARN associated with the workload identity.
agentRuntimeId (string) –
The unique identifier of the AgentCore Runtime.
agentRuntimeVersion (string) –
The version of the AgentCore Runtime.
createdAt (datetime) –
The timestamp when the AgentCore Runtime was created.
status (string) –
The current status of the AgentCore Runtime.
Exceptions
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.AccessDeniedException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ConflictException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ValidationException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ThrottlingException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.InternalServerException