BedrockAgentCoreControlPlaneFrontingLayerClient

Index > BedrockAgentCoreControlPlaneFrontingLayer > BedrockAgentCoreControlPlaneFrontingLayerClient

Auto-generated documentation for BedrockAgentCoreControlPlaneFrontingLayer type annotations stubs module mypy-boto3-bedrock-agentcore-control.

BedrockAgentCoreControlPlaneFrontingLayerClient

Type annotations and code completion for boto3.client("bedrock-agentcore-control"). boto3 documentation

# BedrockAgentCoreControlPlaneFrontingLayerClient usage example

from boto3.session import Session
from mypy_boto3_bedrock_agentcore_control.client import BedrockAgentCoreControlPlaneFrontingLayerClient

def get_bedrock-agentcore-control_client() -> BedrockAgentCoreControlPlaneFrontingLayerClient:
    return Session().client("bedrock-agentcore-control")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("bedrock-agentcore-control").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("bedrock-agentcore-control")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConflictException,
    client.exceptions.DecryptionFailure,
    client.exceptions.EncryptionFailure,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottledException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnauthorizedException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_bedrock_agentcore_control.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("bedrock-agentcore-control").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("bedrock-agentcore-control").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_agent_runtime

Creates an Amazon Secure Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_agent_runtime method. boto3 documentation

# create_agent_runtime method definition

def create_agent_runtime(
    self,
    *,
    agentRuntimeName: str,
    agentRuntimeArtifact: AgentArtifactTypeDef,  # (1)
    roleArn: str,
    networkConfiguration: NetworkConfigurationTypeDef,  # (2)
    description: str = ...,
    protocolConfiguration: ProtocolConfigurationTypeDef = ...,  # (3)
    clientToken: str = ...,
    environmentVariables: Mapping[str, str] = ...,
    authorizerConfiguration: AuthorizerConfigurationUnionTypeDef = ...,  # (4)
) -> CreateAgentRuntimeResponseTypeDef:  # (5)
    ...

1. See AgentArtifactTypeDef
2. See NetworkConfigurationTypeDef
3. See ProtocolConfigurationTypeDef
4. See AuthorizerConfigurationUnionTypeDef
5. See CreateAgentRuntimeResponseTypeDef

# create_agent_runtime method usage example with argument unpacking

kwargs: CreateAgentRuntimeRequestTypeDef = {  # (1)
    "agentRuntimeName": ...,
    "agentRuntimeArtifact": ...,
    "roleArn": ...,
    "networkConfiguration": ...,
}

parent.create_agent_runtime(**kwargs)

1. See CreateAgentRuntimeRequestTypeDef

create_agent_runtime_endpoint

Creates an Amazon Secure AgentEndpoint.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_agent_runtime_endpoint method. boto3 documentation

# create_agent_runtime_endpoint method definition

def create_agent_runtime_endpoint(
    self,
    *,
    agentRuntimeId: str,
    name: str,
    agentRuntimeVersion: str = ...,
    description: str = ...,
    clientToken: str = ...,
) -> CreateAgentRuntimeEndpointResponseTypeDef:  # (1)
    ...

1. See CreateAgentRuntimeEndpointResponseTypeDef

# create_agent_runtime_endpoint method usage example with argument unpacking

kwargs: CreateAgentRuntimeEndpointRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
    "name": ...,
}

parent.create_agent_runtime_endpoint(**kwargs)

1. See CreateAgentRuntimeEndpointRequestTypeDef

create_api_key_credential_provider

Creates a new API key credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_api_key_credential_provider method. boto3 documentation

# create_api_key_credential_provider method definition

def create_api_key_credential_provider(
    self,
    *,
    name: str,
    apiKey: str,
) -> CreateApiKeyCredentialProviderResponseTypeDef:  # (1)
    ...

1. See CreateApiKeyCredentialProviderResponseTypeDef

# create_api_key_credential_provider method usage example with argument unpacking

kwargs: CreateApiKeyCredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
    "apiKey": ...,
}

parent.create_api_key_credential_provider(**kwargs)

1. See CreateApiKeyCredentialProviderRequestTypeDef

create_browser

Creates a custom browser.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_browser method. boto3 documentation

# create_browser method definition

def create_browser(
    self,
    *,
    name: str,
    networkConfiguration: BrowserNetworkConfigurationTypeDef,  # (1)
    description: str = ...,
    executionRoleArn: str = ...,
    recording: RecordingConfigTypeDef = ...,  # (2)
    clientToken: str = ...,
) -> CreateBrowserResponseTypeDef:  # (3)
    ...

1. See BrowserNetworkConfigurationTypeDef
2. See RecordingConfigTypeDef
3. See CreateBrowserResponseTypeDef

# create_browser method usage example with argument unpacking

kwargs: CreateBrowserRequestTypeDef = {  # (1)
    "name": ...,
    "networkConfiguration": ...,
}

parent.create_browser(**kwargs)

1. See CreateBrowserRequestTypeDef

create_code_interpreter

Creates a custom code interpreter.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_code_interpreter method. boto3 documentation

# create_code_interpreter method definition

def create_code_interpreter(
    self,
    *,
    name: str,
    networkConfiguration: CodeInterpreterNetworkConfigurationTypeDef,  # (1)
    description: str = ...,
    executionRoleArn: str = ...,
    clientToken: str = ...,
) -> CreateCodeInterpreterResponseTypeDef:  # (2)
    ...

1. See CodeInterpreterNetworkConfigurationTypeDef
2. See CreateCodeInterpreterResponseTypeDef

# create_code_interpreter method usage example with argument unpacking

kwargs: CreateCodeInterpreterRequestTypeDef = {  # (1)
    "name": ...,
    "networkConfiguration": ...,
}

parent.create_code_interpreter(**kwargs)

1. See CreateCodeInterpreterRequestTypeDef

create_gateway

Creates a gateway for Amazon Bedrock Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_gateway method. boto3 documentation

# create_gateway method definition

def create_gateway(
    self,
    *,
    name: str,
    roleArn: str,
    protocolType: GatewayProtocolTypeType,  # (1)
    authorizerType: AuthorizerTypeType,  # (2)
    authorizerConfiguration: AuthorizerConfigurationUnionTypeDef,  # (3)
    description: str = ...,
    clientToken: str = ...,
    protocolConfiguration: GatewayProtocolConfigurationUnionTypeDef = ...,  # (4)
    kmsKeyArn: str = ...,
    exceptionLevel: ExceptionLevelType = ...,  # (5)
) -> CreateGatewayResponseTypeDef:  # (6)
    ...

1. See GatewayProtocolTypeType
2. See AuthorizerTypeType
3. See AuthorizerConfigurationUnionTypeDef
4. See GatewayProtocolConfigurationUnionTypeDef
5. See ExceptionLevelType
6. See CreateGatewayResponseTypeDef

# create_gateway method usage example with argument unpacking

kwargs: CreateGatewayRequestTypeDef = {  # (1)
    "name": ...,
    "roleArn": ...,
    "protocolType": ...,
    "authorizerType": ...,
    "authorizerConfiguration": ...,
}

parent.create_gateway(**kwargs)

1. See CreateGatewayRequestTypeDef

create_gateway_target

Creates a target for a gateway.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_gateway_target method. boto3 documentation

# create_gateway_target method definition

def create_gateway_target(
    self,
    *,
    gatewayIdentifier: str,
    name: str,
    targetConfiguration: TargetConfigurationUnionTypeDef,  # (1)
    credentialProviderConfigurations: Sequence[CredentialProviderConfigurationUnionTypeDef],  # (2)
    description: str = ...,
    clientToken: str = ...,
) -> CreateGatewayTargetResponseTypeDef:  # (3)
    ...

1. See TargetConfigurationUnionTypeDef
2. See Sequence[CredentialProviderConfigurationUnionTypeDef]
3. See CreateGatewayTargetResponseTypeDef

# create_gateway_target method usage example with argument unpacking

kwargs: CreateGatewayTargetRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
    "name": ...,
    "targetConfiguration": ...,
    "credentialProviderConfigurations": ...,
}

parent.create_gateway_target(**kwargs)

1. See CreateGatewayTargetRequestTypeDef

create_memory

Creates a new memory.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_memory method. boto3 documentation

# create_memory method definition

def create_memory(
    self,
    *,
    name: str,
    eventExpiryDuration: int,
    clientToken: str = ...,
    description: str = ...,
    encryptionKeyArn: str = ...,
    memoryExecutionRoleArn: str = ...,
    memoryStrategies: Sequence[MemoryStrategyInputTypeDef] = ...,  # (1)
) -> CreateMemoryOutputTypeDef:  # (2)
    ...

1. See Sequence[MemoryStrategyInputTypeDef]
2. See CreateMemoryOutputTypeDef

# create_memory method usage example with argument unpacking

kwargs: CreateMemoryInputTypeDef = {  # (1)
    "name": ...,
    "eventExpiryDuration": ...,
}

parent.create_memory(**kwargs)

1. See CreateMemoryInputTypeDef

create_oauth2_credential_provider

Creates a new OAuth2 credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_oauth2_credential_provider method. boto3 documentation

# create_oauth2_credential_provider method definition

def create_oauth2_credential_provider(
    self,
    *,
    name: str,
    credentialProviderVendor: CredentialProviderVendorTypeType,  # (1)
    oauth2ProviderConfigInput: Oauth2ProviderConfigInputTypeDef,  # (2)
) -> CreateOauth2CredentialProviderResponseTypeDef:  # (3)
    ...

1. See CredentialProviderVendorTypeType
2. See Oauth2ProviderConfigInputTypeDef
3. See CreateOauth2CredentialProviderResponseTypeDef

# create_oauth2_credential_provider method usage example with argument unpacking

kwargs: CreateOauth2CredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
    "credentialProviderVendor": ...,
    "oauth2ProviderConfigInput": ...,
}

parent.create_oauth2_credential_provider(**kwargs)

1. See CreateOauth2CredentialProviderRequestTypeDef

create_workload_identity

Creates a new workload identity.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").create_workload_identity method. boto3 documentation

# create_workload_identity method definition

def create_workload_identity(
    self,
    *,
    name: str,
    allowedResourceOauth2ReturnUrls: Sequence[str] = ...,
) -> CreateWorkloadIdentityResponseTypeDef:  # (1)
    ...

1. See CreateWorkloadIdentityResponseTypeDef

# create_workload_identity method usage example with argument unpacking

kwargs: CreateWorkloadIdentityRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_workload_identity(**kwargs)

1. See CreateWorkloadIdentityRequestTypeDef

delete_agent_runtime

Deletes an Amazon Secure Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_agent_runtime method. boto3 documentation

# delete_agent_runtime method definition

def delete_agent_runtime(
    self,
    *,
    agentRuntimeId: str,
) -> DeleteAgentRuntimeResponseTypeDef:  # (1)
    ...

1. See DeleteAgentRuntimeResponseTypeDef

# delete_agent_runtime method usage example with argument unpacking

kwargs: DeleteAgentRuntimeRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
}

parent.delete_agent_runtime(**kwargs)

1. See DeleteAgentRuntimeRequestTypeDef

delete_agent_runtime_endpoint

Deletes an Amazon Secure AgentEndpoint.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_agent_runtime_endpoint method. boto3 documentation

# delete_agent_runtime_endpoint method definition

def delete_agent_runtime_endpoint(
    self,
    *,
    agentRuntimeId: str,
    endpointName: str,
    clientToken: str = ...,
) -> DeleteAgentRuntimeEndpointResponseTypeDef:  # (1)
    ...

1. See DeleteAgentRuntimeEndpointResponseTypeDef

# delete_agent_runtime_endpoint method usage example with argument unpacking

kwargs: DeleteAgentRuntimeEndpointRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
    "endpointName": ...,
}

parent.delete_agent_runtime_endpoint(**kwargs)

1. See DeleteAgentRuntimeEndpointRequestTypeDef

delete_api_key_credential_provider

Deletes an API key credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_api_key_credential_provider method. boto3 documentation

# delete_api_key_credential_provider method definition

def delete_api_key_credential_provider(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...

# delete_api_key_credential_provider method usage example with argument unpacking

kwargs: DeleteApiKeyCredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_api_key_credential_provider(**kwargs)

1. See DeleteApiKeyCredentialProviderRequestTypeDef

delete_browser

Deletes a custom browser.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_browser method. boto3 documentation

# delete_browser method definition

def delete_browser(
    self,
    *,
    browserId: str,
    clientToken: str = ...,
) -> DeleteBrowserResponseTypeDef:  # (1)
    ...

1. See DeleteBrowserResponseTypeDef

# delete_browser method usage example with argument unpacking

kwargs: DeleteBrowserRequestTypeDef = {  # (1)
    "browserId": ...,
}

parent.delete_browser(**kwargs)

1. See DeleteBrowserRequestTypeDef

delete_code_interpreter

Deletes a custom code interpreter.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_code_interpreter method. boto3 documentation

# delete_code_interpreter method definition

def delete_code_interpreter(
    self,
    *,
    codeInterpreterId: str,
    clientToken: str = ...,
) -> DeleteCodeInterpreterResponseTypeDef:  # (1)
    ...

1. See DeleteCodeInterpreterResponseTypeDef

# delete_code_interpreter method usage example with argument unpacking

kwargs: DeleteCodeInterpreterRequestTypeDef = {  # (1)
    "codeInterpreterId": ...,
}

parent.delete_code_interpreter(**kwargs)

1. See DeleteCodeInterpreterRequestTypeDef

delete_gateway

Deletes a Gateway.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_gateway method. boto3 documentation

# delete_gateway method definition

def delete_gateway(
    self,
    *,
    gatewayIdentifier: str,
) -> DeleteGatewayResponseTypeDef:  # (1)
    ...

1. See DeleteGatewayResponseTypeDef

# delete_gateway method usage example with argument unpacking

kwargs: DeleteGatewayRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
}

parent.delete_gateway(**kwargs)

1. See DeleteGatewayRequestTypeDef

delete_gateway_target

Deletes a Gateway Target.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_gateway_target method. boto3 documentation

# delete_gateway_target method definition

def delete_gateway_target(
    self,
    *,
    gatewayIdentifier: str,
    targetId: str,
) -> DeleteGatewayTargetResponseTypeDef:  # (1)
    ...

1. See DeleteGatewayTargetResponseTypeDef

# delete_gateway_target method usage example with argument unpacking

kwargs: DeleteGatewayTargetRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
    "targetId": ...,
}

parent.delete_gateway_target(**kwargs)

1. See DeleteGatewayTargetRequestTypeDef

delete_memory

Deletes a memory.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_memory method. boto3 documentation

# delete_memory method definition

def delete_memory(
    self,
    *,
    memoryId: str,
    clientToken: str = ...,
) -> DeleteMemoryOutputTypeDef:  # (1)
    ...

1. See DeleteMemoryOutputTypeDef

# delete_memory method usage example with argument unpacking

kwargs: DeleteMemoryInputTypeDef = {  # (1)
    "memoryId": ...,
}

parent.delete_memory(**kwargs)

1. See DeleteMemoryInputTypeDef

delete_oauth2_credential_provider

Deletes an OAuth2 credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_oauth2_credential_provider method. boto3 documentation

# delete_oauth2_credential_provider method definition

def delete_oauth2_credential_provider(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...

# delete_oauth2_credential_provider method usage example with argument unpacking

kwargs: DeleteOauth2CredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_oauth2_credential_provider(**kwargs)

1. See DeleteOauth2CredentialProviderRequestTypeDef

delete_workload_identity

Deletes a workload identity.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").delete_workload_identity method. boto3 documentation

# delete_workload_identity method definition

def delete_workload_identity(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...

# delete_workload_identity method usage example with argument unpacking

kwargs: DeleteWorkloadIdentityRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_workload_identity(**kwargs)

1. See DeleteWorkloadIdentityRequestTypeDef

get_agent_runtime

Gets an Amazon Secure Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_agent_runtime method. boto3 documentation

# get_agent_runtime method definition

def get_agent_runtime(
    self,
    *,
    agentRuntimeId: str,
    agentRuntimeVersion: str = ...,
) -> GetAgentRuntimeResponseTypeDef:  # (1)
    ...

1. See GetAgentRuntimeResponseTypeDef

# get_agent_runtime method usage example with argument unpacking

kwargs: GetAgentRuntimeRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
}

parent.get_agent_runtime(**kwargs)

1. See GetAgentRuntimeRequestTypeDef

get_agent_runtime_endpoint

Gets information about an Amazon Secure AgentEndpoint.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_agent_runtime_endpoint method. boto3 documentation

# get_agent_runtime_endpoint method definition

def get_agent_runtime_endpoint(
    self,
    *,
    agentRuntimeId: str,
    endpointName: str,
) -> GetAgentRuntimeEndpointResponseTypeDef:  # (1)
    ...

1. See GetAgentRuntimeEndpointResponseTypeDef

# get_agent_runtime_endpoint method usage example with argument unpacking

kwargs: GetAgentRuntimeEndpointRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
    "endpointName": ...,
}

parent.get_agent_runtime_endpoint(**kwargs)

1. See GetAgentRuntimeEndpointRequestTypeDef

get_api_key_credential_provider

Retrieves information about an API key credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_api_key_credential_provider method. boto3 documentation

# get_api_key_credential_provider method definition

def get_api_key_credential_provider(
    self,
    *,
    name: str,
) -> GetApiKeyCredentialProviderResponseTypeDef:  # (1)
    ...

1. See GetApiKeyCredentialProviderResponseTypeDef

# get_api_key_credential_provider method usage example with argument unpacking

kwargs: GetApiKeyCredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_api_key_credential_provider(**kwargs)

1. See GetApiKeyCredentialProviderRequestTypeDef

get_browser

Gets information about a custom browser.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_browser method. boto3 documentation

# get_browser method definition

def get_browser(
    self,
    *,
    browserId: str,
) -> GetBrowserResponseTypeDef:  # (1)
    ...

1. See GetBrowserResponseTypeDef

# get_browser method usage example with argument unpacking

kwargs: GetBrowserRequestTypeDef = {  # (1)
    "browserId": ...,
}

parent.get_browser(**kwargs)

1. See GetBrowserRequestTypeDef

get_code_interpreter

Gets information about a custom code interpreter.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_code_interpreter method. boto3 documentation

# get_code_interpreter method definition

def get_code_interpreter(
    self,
    *,
    codeInterpreterId: str,
) -> GetCodeInterpreterResponseTypeDef:  # (1)
    ...

1. See GetCodeInterpreterResponseTypeDef

# get_code_interpreter method usage example with argument unpacking

kwargs: GetCodeInterpreterRequestTypeDef = {  # (1)
    "codeInterpreterId": ...,
}

parent.get_code_interpreter(**kwargs)

1. See GetCodeInterpreterRequestTypeDef

get_gateway

Retrieves information about a specific Gateway.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_gateway method. boto3 documentation

# get_gateway method definition

def get_gateway(
    self,
    *,
    gatewayIdentifier: str,
) -> GetGatewayResponseTypeDef:  # (1)
    ...

1. See GetGatewayResponseTypeDef

# get_gateway method usage example with argument unpacking

kwargs: GetGatewayRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
}

parent.get_gateway(**kwargs)

1. See GetGatewayRequestTypeDef

get_gateway_target

Retrieves information about a specific Gateway Target.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_gateway_target method. boto3 documentation

# get_gateway_target method definition

def get_gateway_target(
    self,
    *,
    gatewayIdentifier: str,
    targetId: str,
) -> GetGatewayTargetResponseTypeDef:  # (1)
    ...

1. See GetGatewayTargetResponseTypeDef

# get_gateway_target method usage example with argument unpacking

kwargs: GetGatewayTargetRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
    "targetId": ...,
}

parent.get_gateway_target(**kwargs)

1. See GetGatewayTargetRequestTypeDef

get_memory

Retrieve an existing memory.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_memory method. boto3 documentation

# get_memory method definition

def get_memory(
    self,
    *,
    memoryId: str,
) -> GetMemoryOutputTypeDef:  # (1)
    ...

1. See GetMemoryOutputTypeDef

# get_memory method usage example with argument unpacking

kwargs: GetMemoryInputTypeDef = {  # (1)
    "memoryId": ...,
}

parent.get_memory(**kwargs)

1. See GetMemoryInputTypeDef

get_oauth2_credential_provider

Retrieves information about an OAuth2 credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_oauth2_credential_provider method. boto3 documentation

# get_oauth2_credential_provider method definition

def get_oauth2_credential_provider(
    self,
    *,
    name: str,
) -> GetOauth2CredentialProviderResponseTypeDef:  # (1)
    ...

1. See GetOauth2CredentialProviderResponseTypeDef

# get_oauth2_credential_provider method usage example with argument unpacking

kwargs: GetOauth2CredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_oauth2_credential_provider(**kwargs)

1. See GetOauth2CredentialProviderRequestTypeDef

get_token_vault

Retrieves information about a token vault.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_token_vault method. boto3 documentation

# get_token_vault method definition

def get_token_vault(
    self,
    *,
    tokenVaultId: str = ...,
) -> GetTokenVaultResponseTypeDef:  # (1)
    ...

1. See GetTokenVaultResponseTypeDef

# get_token_vault method usage example with argument unpacking

kwargs: GetTokenVaultRequestTypeDef = {  # (1)
    "tokenVaultId": ...,
}

parent.get_token_vault(**kwargs)

1. See GetTokenVaultRequestTypeDef

get_workload_identity

Retrieves information about a workload identity.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_workload_identity method. boto3 documentation

# get_workload_identity method definition

def get_workload_identity(
    self,
    *,
    name: str,
) -> GetWorkloadIdentityResponseTypeDef:  # (1)
    ...

1. See GetWorkloadIdentityResponseTypeDef

# get_workload_identity method usage example with argument unpacking

kwargs: GetWorkloadIdentityRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_workload_identity(**kwargs)

1. See GetWorkloadIdentityRequestTypeDef

list_agent_runtime_endpoints

Lists all endpoints for a specific Amazon Secure Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_agent_runtime_endpoints method. boto3 documentation

# list_agent_runtime_endpoints method definition

def list_agent_runtime_endpoints(
    self,
    *,
    agentRuntimeId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentRuntimeEndpointsResponseTypeDef:  # (1)
    ...

1. See ListAgentRuntimeEndpointsResponseTypeDef

# list_agent_runtime_endpoints method usage example with argument unpacking

kwargs: ListAgentRuntimeEndpointsRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
}

parent.list_agent_runtime_endpoints(**kwargs)

1. See ListAgentRuntimeEndpointsRequestTypeDef

list_agent_runtime_versions

Lists all versions of a specific Amazon Secure Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_agent_runtime_versions method. boto3 documentation

# list_agent_runtime_versions method definition

def list_agent_runtime_versions(
    self,
    *,
    agentRuntimeId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentRuntimeVersionsResponseTypeDef:  # (1)
    ...

1. See ListAgentRuntimeVersionsResponseTypeDef

# list_agent_runtime_versions method usage example with argument unpacking

kwargs: ListAgentRuntimeVersionsRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
}

parent.list_agent_runtime_versions(**kwargs)

1. See ListAgentRuntimeVersionsRequestTypeDef

list_agent_runtimes

Lists all Amazon Secure Agents in your account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_agent_runtimes method. boto3 documentation

# list_agent_runtimes method definition

def list_agent_runtimes(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentRuntimesResponseTypeDef:  # (1)
    ...

1. See ListAgentRuntimesResponseTypeDef

# list_agent_runtimes method usage example with argument unpacking

kwargs: ListAgentRuntimesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_agent_runtimes(**kwargs)

1. See ListAgentRuntimesRequestTypeDef

list_api_key_credential_providers

Lists all API key credential providers in your account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_api_key_credential_providers method. boto3 documentation

# list_api_key_credential_providers method definition

def list_api_key_credential_providers(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListApiKeyCredentialProvidersResponseTypeDef:  # (1)
    ...

1. See ListApiKeyCredentialProvidersResponseTypeDef

# list_api_key_credential_providers method usage example with argument unpacking

kwargs: ListApiKeyCredentialProvidersRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_api_key_credential_providers(**kwargs)

1. See ListApiKeyCredentialProvidersRequestTypeDef

list_browsers

Lists all custom browsers in your account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_browsers method. boto3 documentation

# list_browsers method definition

def list_browsers(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    type: ResourceTypeType = ...,  # (1)
) -> ListBrowsersResponseTypeDef:  # (2)
    ...

1. See ResourceTypeType
2. See ListBrowsersResponseTypeDef

# list_browsers method usage example with argument unpacking

kwargs: ListBrowsersRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_browsers(**kwargs)

1. See ListBrowsersRequestTypeDef

list_code_interpreters

Lists all custom code interpreters in your account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_code_interpreters method. boto3 documentation

# list_code_interpreters method definition

def list_code_interpreters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    type: ResourceTypeType = ...,  # (1)
) -> ListCodeInterpretersResponseTypeDef:  # (2)
    ...

1. See ResourceTypeType
2. See ListCodeInterpretersResponseTypeDef

# list_code_interpreters method usage example with argument unpacking

kwargs: ListCodeInterpretersRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_code_interpreters(**kwargs)

1. See ListCodeInterpretersRequestTypeDef

list_gateway_targets

Lists all targets for a specific Gateway.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_gateway_targets method. boto3 documentation

# list_gateway_targets method definition

def list_gateway_targets(
    self,
    *,
    gatewayIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListGatewayTargetsResponseTypeDef:  # (1)
    ...

1. See ListGatewayTargetsResponseTypeDef

# list_gateway_targets method usage example with argument unpacking

kwargs: ListGatewayTargetsRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
}

parent.list_gateway_targets(**kwargs)

1. See ListGatewayTargetsRequestTypeDef

list_gateways

Lists all Gateways in the account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_gateways method. boto3 documentation

# list_gateways method definition

def list_gateways(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListGatewaysResponseTypeDef:  # (1)
    ...

1. See ListGatewaysResponseTypeDef

# list_gateways method usage example with argument unpacking

kwargs: ListGatewaysRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_gateways(**kwargs)

1. See ListGatewaysRequestTypeDef

list_memories

Lists the memory present.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_memories method. boto3 documentation

# list_memories method definition

def list_memories(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMemoriesOutputTypeDef:  # (1)
    ...

1. See ListMemoriesOutputTypeDef

# list_memories method usage example with argument unpacking

kwargs: ListMemoriesInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_memories(**kwargs)

1. See ListMemoriesInputTypeDef

list_oauth2_credential_providers

Lists all OAuth2 credential providers in your account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_oauth2_credential_providers method. boto3 documentation

# list_oauth2_credential_providers method definition

def list_oauth2_credential_providers(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListOauth2CredentialProvidersResponseTypeDef:  # (1)
    ...

1. See ListOauth2CredentialProvidersResponseTypeDef

# list_oauth2_credential_providers method usage example with argument unpacking

kwargs: ListOauth2CredentialProvidersRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_oauth2_credential_providers(**kwargs)

1. See ListOauth2CredentialProvidersRequestTypeDef

list_workload_identities

Lists all workload identities in your account.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").list_workload_identities method. boto3 documentation

# list_workload_identities method definition

def list_workload_identities(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWorkloadIdentitiesResponseTypeDef:  # (1)
    ...

1. See ListWorkloadIdentitiesResponseTypeDef

# list_workload_identities method usage example with argument unpacking

kwargs: ListWorkloadIdentitiesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_workload_identities(**kwargs)

1. See ListWorkloadIdentitiesRequestTypeDef

set_token_vault_cmk

Sets the customer master key (CMK) for a token vault.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").set_token_vault_cmk method. boto3 documentation

# set_token_vault_cmk method definition

def set_token_vault_cmk(
    self,
    *,
    kmsConfiguration: KmsConfigurationTypeDef,  # (1)
    tokenVaultId: str = ...,
) -> SetTokenVaultCMKResponseTypeDef:  # (2)
    ...

1. See KmsConfigurationTypeDef
2. See SetTokenVaultCMKResponseTypeDef

# set_token_vault_cmk method usage example with argument unpacking

kwargs: SetTokenVaultCMKRequestTypeDef = {  # (1)
    "kmsConfiguration": ...,
}

parent.set_token_vault_cmk(**kwargs)

1. See SetTokenVaultCMKRequestTypeDef

update_agent_runtime

Updates an existing Amazon Secure Agent.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_agent_runtime method. boto3 documentation

# update_agent_runtime method definition

def update_agent_runtime(
    self,
    *,
    agentRuntimeId: str,
    agentRuntimeArtifact: AgentArtifactTypeDef,  # (1)
    roleArn: str,
    networkConfiguration: NetworkConfigurationTypeDef,  # (2)
    description: str = ...,
    protocolConfiguration: ProtocolConfigurationTypeDef = ...,  # (3)
    clientToken: str = ...,
    environmentVariables: Mapping[str, str] = ...,
    authorizerConfiguration: AuthorizerConfigurationUnionTypeDef = ...,  # (4)
) -> UpdateAgentRuntimeResponseTypeDef:  # (5)
    ...

1. See AgentArtifactTypeDef
2. See NetworkConfigurationTypeDef
3. See ProtocolConfigurationTypeDef
4. See AuthorizerConfigurationUnionTypeDef
5. See UpdateAgentRuntimeResponseTypeDef

# update_agent_runtime method usage example with argument unpacking

kwargs: UpdateAgentRuntimeRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
    "agentRuntimeArtifact": ...,
    "roleArn": ...,
    "networkConfiguration": ...,
}

parent.update_agent_runtime(**kwargs)

1. See UpdateAgentRuntimeRequestTypeDef

update_agent_runtime_endpoint

Updates an existing Amazon Secure AgentEndpoint.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_agent_runtime_endpoint method. boto3 documentation

# update_agent_runtime_endpoint method definition

def update_agent_runtime_endpoint(
    self,
    *,
    agentRuntimeId: str,
    endpointName: str,
    agentRuntimeVersion: str = ...,
    description: str = ...,
    clientToken: str = ...,
) -> UpdateAgentRuntimeEndpointResponseTypeDef:  # (1)
    ...

1. See UpdateAgentRuntimeEndpointResponseTypeDef

# update_agent_runtime_endpoint method usage example with argument unpacking

kwargs: UpdateAgentRuntimeEndpointRequestTypeDef = {  # (1)
    "agentRuntimeId": ...,
    "endpointName": ...,
}

parent.update_agent_runtime_endpoint(**kwargs)

1. See UpdateAgentRuntimeEndpointRequestTypeDef

update_api_key_credential_provider

Updates an existing API key credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_api_key_credential_provider method. boto3 documentation

# update_api_key_credential_provider method definition

def update_api_key_credential_provider(
    self,
    *,
    name: str,
    apiKey: str,
) -> UpdateApiKeyCredentialProviderResponseTypeDef:  # (1)
    ...

1. See UpdateApiKeyCredentialProviderResponseTypeDef

# update_api_key_credential_provider method usage example with argument unpacking

kwargs: UpdateApiKeyCredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
    "apiKey": ...,
}

parent.update_api_key_credential_provider(**kwargs)

1. See UpdateApiKeyCredentialProviderRequestTypeDef

update_gateway

Updates an existing Gateway.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_gateway method. boto3 documentation

# update_gateway method definition

def update_gateway(
    self,
    *,
    gatewayIdentifier: str,
    name: str,
    roleArn: str,
    protocolType: GatewayProtocolTypeType,  # (1)
    authorizerType: AuthorizerTypeType,  # (2)
    authorizerConfiguration: AuthorizerConfigurationUnionTypeDef,  # (3)
    description: str = ...,
    protocolConfiguration: GatewayProtocolConfigurationUnionTypeDef = ...,  # (4)
    kmsKeyArn: str = ...,
    exceptionLevel: ExceptionLevelType = ...,  # (5)
) -> UpdateGatewayResponseTypeDef:  # (6)
    ...

1. See GatewayProtocolTypeType
2. See AuthorizerTypeType
3. See AuthorizerConfigurationUnionTypeDef
4. See GatewayProtocolConfigurationUnionTypeDef
5. See ExceptionLevelType
6. See UpdateGatewayResponseTypeDef

# update_gateway method usage example with argument unpacking

kwargs: UpdateGatewayRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
    "name": ...,
    "roleArn": ...,
    "protocolType": ...,
    "authorizerType": ...,
    "authorizerConfiguration": ...,
}

parent.update_gateway(**kwargs)

1. See UpdateGatewayRequestTypeDef

update_gateway_target

Updates an existing Gateway Target.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_gateway_target method. boto3 documentation

# update_gateway_target method definition

def update_gateway_target(
    self,
    *,
    gatewayIdentifier: str,
    targetId: str,
    name: str,
    targetConfiguration: TargetConfigurationUnionTypeDef,  # (1)
    credentialProviderConfigurations: Sequence[CredentialProviderConfigurationUnionTypeDef],  # (2)
    description: str = ...,
) -> UpdateGatewayTargetResponseTypeDef:  # (3)
    ...

1. See TargetConfigurationUnionTypeDef
2. See Sequence[CredentialProviderConfigurationUnionTypeDef]
3. See UpdateGatewayTargetResponseTypeDef

# update_gateway_target method usage example with argument unpacking

kwargs: UpdateGatewayTargetRequestTypeDef = {  # (1)
    "gatewayIdentifier": ...,
    "targetId": ...,
    "name": ...,
    "targetConfiguration": ...,
    "credentialProviderConfigurations": ...,
}

parent.update_gateway_target(**kwargs)

1. See UpdateGatewayTargetRequestTypeDef

update_memory

Update memory.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_memory method. boto3 documentation

# update_memory method definition

def update_memory(
    self,
    *,
    memoryId: str,
    clientToken: str = ...,
    description: str = ...,
    eventExpiryDuration: int = ...,
    memoryExecutionRoleArn: str = ...,
    memoryStrategies: ModifyMemoryStrategiesTypeDef = ...,  # (1)
) -> UpdateMemoryOutputTypeDef:  # (2)
    ...

1. See ModifyMemoryStrategiesTypeDef
2. See UpdateMemoryOutputTypeDef

# update_memory method usage example with argument unpacking

kwargs: UpdateMemoryInputTypeDef = {  # (1)
    "memoryId": ...,
}

parent.update_memory(**kwargs)

1. See UpdateMemoryInputTypeDef

update_oauth2_credential_provider

Updates an existing OAuth2 credential provider.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_oauth2_credential_provider method. boto3 documentation

# update_oauth2_credential_provider method definition

def update_oauth2_credential_provider(
    self,
    *,
    name: str,
    credentialProviderVendor: CredentialProviderVendorTypeType,  # (1)
    oauth2ProviderConfigInput: Oauth2ProviderConfigInputTypeDef,  # (2)
) -> UpdateOauth2CredentialProviderResponseTypeDef:  # (3)
    ...

1. See CredentialProviderVendorTypeType
2. See Oauth2ProviderConfigInputTypeDef
3. See UpdateOauth2CredentialProviderResponseTypeDef

# update_oauth2_credential_provider method usage example with argument unpacking

kwargs: UpdateOauth2CredentialProviderRequestTypeDef = {  # (1)
    "name": ...,
    "credentialProviderVendor": ...,
    "oauth2ProviderConfigInput": ...,
}

parent.update_oauth2_credential_provider(**kwargs)

1. See UpdateOauth2CredentialProviderRequestTypeDef

update_workload_identity

Updates an existing workload identity.

Type annotations and code completion for boto3.client("bedrock-agentcore-control").update_workload_identity method. boto3 documentation

# update_workload_identity method definition

def update_workload_identity(
    self,
    *,
    name: str,
    allowedResourceOauth2ReturnUrls: Sequence[str] = ...,
) -> UpdateWorkloadIdentityResponseTypeDef:  # (1)
    ...

1. See UpdateWorkloadIdentityResponseTypeDef

# update_workload_identity method usage example with argument unpacking

kwargs: UpdateWorkloadIdentityRequestTypeDef = {  # (1)
    "name": ...,
}

parent.update_workload_identity(**kwargs)

1. See UpdateWorkloadIdentityRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_paginator method with overloads.

• client.get_paginator("list_agent_runtime_endpoints") -> ListAgentRuntimeEndpointsPaginator
• client.get_paginator("list_agent_runtime_versions") -> ListAgentRuntimeVersionsPaginator
• client.get_paginator("list_agent_runtimes") -> ListAgentRuntimesPaginator
• client.get_paginator("list_api_key_credential_providers") -> ListApiKeyCredentialProvidersPaginator
• client.get_paginator("list_browsers") -> ListBrowsersPaginator
• client.get_paginator("list_code_interpreters") -> ListCodeInterpretersPaginator
• client.get_paginator("list_gateway_targets") -> ListGatewayTargetsPaginator
• client.get_paginator("list_gateways") -> ListGatewaysPaginator
• client.get_paginator("list_memories") -> ListMemoriesPaginator
• client.get_paginator("list_oauth2_credential_providers") -> ListOauth2CredentialProvidersPaginator
• client.get_paginator("list_workload_identities") -> ListWorkloadIdentitiesPaginator

get_waiter

Type annotations and code completion for boto3.client("bedrock-agentcore-control").get_waiter method with overloads.

• client.get_waiter("memory_created") -> MemoryCreatedWaiter