delete-harness¶

Description¶

Operation to delete a Harness.

Synopsis¶

  delete-harness
--harness-id <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--harness-id (string) [required]

The ID of the harness to delete.

Constraints:

pattern: [a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}

--client-token (string)

A unique, case-sensitive identifier to ensure idempotency of the request.

Constraints:

min: 33

max: 256

pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

harness -> (structure)

The harness that was deleted.

harnessId -> (string) [required]

The ID of the Harness.

Constraints:

pattern: [a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}

harnessName -> (string) [required]

The name of the Harness.

Constraints:

pattern: [a-zA-Z][a-zA-Z0-9_]{0,39}

arn -> (string) [required]

The ARN of the Harness.

Constraints:

pattern: arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}

status -> (string) [required]

The status of the Harness.

Possible values:

CREATING

CREATE_FAILED

UPDATING

UPDATE_FAILED

READY

DELETING

DELETE_FAILED

executionRoleArn -> (string) [required]

IAM role the Harness assumes when running.

Constraints:

min: 1

max: 2048

pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

createdAt -> (timestamp) [required]

The createdAt time of the Harness.

updatedAt -> (timestamp) [required]

The updatedAt time of the Harness.

model -> (tagged union structure) [required]

The configuration of the default model used by the Harness.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: bedrockModelConfig, openAiModelConfig, geminiModelConfig.

bedrockModelConfig -> (structure)

Configuration for an Amazon Bedrock model.

modelId -> (string) [required]

The Bedrock model ID.

maxTokens -> (integer)

The maximum number of tokens to allow in the generated response per iteration.

Constraints:

min: 1

temperature -> (float)

The temperature to set when calling the model.

Constraints:

min: 0.0

max: 2.0

topP -> (float)

The topP set when calling the model.

Constraints:

min: 0.0

max: 1.0

openAiModelConfig -> (structure)

Configuration for an OpenAI model.

modelId -> (string) [required]

The OpenAI model ID.

apiKeyArn -> (string) [required]

The ARN of your OpenAI API key on AgentCore Identity.

Constraints:

pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+

maxTokens -> (integer)

The maximum number of tokens to allow in the generated response per iteration.

Constraints:

min: 1

temperature -> (float)

The temperature to set when calling the model.

Constraints:

min: 0.0

max: 2.0

topP -> (float)

The topP set when calling the model.

Constraints:

min: 0.0

max: 1.0

geminiModelConfig -> (structure)

Configuration for a Google Gemini model.

modelId -> (string) [required]

The Gemini model ID.

apiKeyArn -> (string) [required]

The ARN of your Gemini API key on AgentCore Identity.

Constraints:

pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+

maxTokens -> (integer)

The maximum number of tokens to allow in the generated response per iteration.

Constraints:

min: 1

temperature -> (float)

The temperature to set when calling the model.

Constraints:

min: 0.0

max: 2.0

topP -> (float)

The topP set when calling the model.

Constraints:

min: 0.0

max: 1.0

topK -> (integer)

The topK set when calling the model.

Constraints:

min: 0

max: 500

systemPrompt -> (list) [required]

The system prompt of the Harness.

(tagged union structure)

A content block in the system prompt.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (string)

The text content of the system prompt block.

Constraints:

min: 1

tools -> (list) [required]

The tools of the Harness.

(structure)

A tool available to the agent loop.

type -> (string) [required]

The type of tool.

Possible values:

remote_mcp

agentcore_browser

agentcore_gateway

inline_function

agentcore_code_interpreter

name -> (string)

Unique name for the tool. If not provided, a name will be inferred or generated.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

config -> (tagged union structure)

Tool-specific configuration.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: remoteMcp, agentCoreBrowser, agentCoreGateway, inlineFunction, agentCoreCodeInterpreter.

remoteMcp -> (structure)

Configuration for remote MCP server.

url -> (string) [required]

URL of the MCP endpoint.

Constraints:

min: 1

max: 16383

headers -> (map)

Map of key/value pairs for HTTP headers.

key -> (string)

The key of an HTTP header.

Constraints:

min: 1

max: 16383

value -> (string)

The value of an HTTP header.

Constraints:

min: 1

max: 16383

agentCoreBrowser -> (structure)

Configuration for AgentCore Browser.

browserArn -> (string)

If not populated, the built-in Browser ARN is used.

Constraints:

pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\.browser\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})

agentCoreGateway -> (structure)

Configuration for AgentCore Gateway.

gatewayArn -> (string) [required]

The ARN of the desired AgentCore Gateway.

Constraints:

pattern: arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}

outboundAuth -> (tagged union structure)

How Loopy authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsIam, none, oauth.

awsIam -> (structure)

SigV4-sign requests using the agent’s execution role.

none -> (structure)

No authentication.

oauth -> (structure)

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

providerArn -> (string) [required]

The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.

Constraints:

pattern: arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)

scopes -> (list) [required]

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 1

max: 64

customParameters -> (map)

The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

Constraints:

min: 1

max: 10

key -> (string)

Constraints:

min: 1

max: 256

value -> (string)

Constraints:

min: 1

max: 2048

grantType -> (string)

Specifies the kind of credentials to use for authorization:

CLIENT_CREDENTIALS - Authorization with a client ID and secret.

AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

Possible values:

CLIENT_CREDENTIALS

AUTHORIZATION_CODE

defaultReturnUrl -> (string)

The URL where the end user’s browser is redirected after obtaining the authorization code. Generally points to the customer’s application.

Constraints:

min: 1

max: 2048

pattern: \w+:(\/?\/?)[^\s]+

inlineFunction -> (structure)

Configuration for an inline function tool.

description -> (string) [required]

Description of what the tool does, provided to the model.

Constraints:

min: 1

max: 4096

inputSchema -> (document) [required]

JSON Schema describing the tool’s input parameters.

agentCoreCodeInterpreter -> (structure)

Configuration for AgentCore Code Interpreter.

codeInterpreterArn -> (string)

If not populated, the built-in Code Interpreter ARN is used.

Constraints:

pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\.codeinterpreter\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})

skills -> (list) [required]

The skills of the Harness.

(tagged union structure)

A skill available to the agent.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: path.

path -> (string)

The filesystem path to the skill definition.

Constraints:

min: 1

allowedTools -> (list) [required]

The allowed tools of the Harness. All tools are allowed by default.

(string)

Constraints:

min: 1

max: 64

pattern: (\*|@?[^/]+(/[^/]+)?)

truncation -> (structure) [required]

Configuration for truncating model context.

strategy -> (string) [required]

The truncation strategy to use.

Possible values:

sliding_window

summarization

none

config -> (tagged union structure)

The strategy-specific configuration.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: slidingWindow, summarization.

slidingWindow -> (structure)

Configuration for sliding window truncation.

messagesCount -> (integer)

The number of recent messages to retain in the context window.

summarization -> (structure)

Configuration for summarization-based truncation.

summaryRatio -> (float)

The ratio of content to summarize.

preserveRecentMessages -> (integer)

The number of recent messages to preserve without summarization.

summarizationSystemPrompt -> (string)

The system prompt used for generating summaries.

environment -> (tagged union structure) [required]

The compute environment on which the Harness runs.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: agentCoreRuntimeEnvironment.

agentCoreRuntimeEnvironment -> (structure)

The AgentCore Runtime environment configuration.

agentRuntimeArn -> (string) [required]

The ARN of the underlying AgentCore Runtime.

Constraints:

min: 20

max: 1011

agentRuntimeName -> (string) [required]

The name of the underlying AgentCore Runtime.

agentRuntimeId -> (string) [required]

The ID of the underlying AgentCore Runtime.

lifecycleConfiguration -> (structure) [required]

LifecycleConfiguration lets you manage the lifecycle of runtime sessions and resources in AgentCore Runtime. This configuration helps optimize resource utilization by automatically cleaning up idle sessions and preventing long-running instances from consuming resources indefinitely.

idleRuntimeSessionTimeout -> (integer)

Timeout in seconds for idle runtime sessions. When a session remains idle for this duration, it will be automatically terminated. Default: 900 seconds (15 minutes).

Constraints:

min: 60

max: 28800

maxLifetime -> (integer)

Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated and replaced. Default: 28800 seconds (8 hours).

Constraints:

min: 60

max: 28800

networkConfiguration -> (structure) [required]

SecurityConfig for the Agent.

networkMode -> (string) [required]

The network mode for the AgentCore Runtime.

Possible values:

PUBLIC

VPC

networkModeConfig -> (structure)

The network mode configuration for the AgentCore Runtime.

securityGroups -> (list) [required]

The security groups associated with the VPC configuration.

Constraints:

min: 1

max: 16

(string)

Constraints:

pattern: sg-[0-9a-zA-Z]{8,17}

subnets -> (list) [required]

The subnets associated with the VPC configuration.

Constraints:

min: 1

max: 16

(string)

Constraints:

pattern: subnet-[0-9a-zA-Z]{8,17}

filesystemConfigurations -> (list)

The filesystem configurations for the runtime environment.

Constraints:

min: 0

max: 1

(tagged union structure)

Configuration for a filesystem that can be mounted into the AgentCore Runtime.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: sessionStorage.

sessionStorage -> (structure)

Configuration for session storage. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.

mountPath -> (string) [required]

The mount path for the session storage filesystem inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data ).

Constraints:

min: 6

max: 200

pattern: /mnt/[a-zA-Z0-9._-]+/?

environmentArtifact -> (tagged union structure)

The environment artifact (e.g., container) in which the Harness operates.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: containerConfiguration.

containerConfiguration -> (structure)

Representation of a container configuration.

containerUri -> (string) [required]

The ECR URI of the container.

Constraints:

min: 1

max: 1024

pattern: (([0-9]{12})\.dkr\.ecr\.([a-z0-9-]+)\.amazonaws\.com(\.cn)?|public\.ecr\.aws)/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?::([^:@]{1,300}))?(?:@(.+))?

environmentVariables -> (map)

Environment variables exposed in the environment in which the Harness operates.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 1

max: 100

value -> (string)

Constraints:

min: 0

max: 5000

authorizerConfiguration -> (tagged union structure)

Represents inbound authorization configuration options used to authenticate incoming requests.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.

customJWTAuthorizer -> (structure)

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.

Constraints:

pattern: .+/\.well-known/openid-configuration

allowedAudience -> (list)

Represents individual audience values that are validated in the incoming JWT token validation process.

Constraints:

min: 1

(string)

allowedClients -> (list)

Represents individual client IDs that are validated in the incoming JWT token validation process.

Constraints:

min: 1

(string)

allowedScopes -> (list)

An array of scopes that are allowed to access the token.

Constraints:

min: 1

(string)

Constraints:

min: 1

max: 255

pattern: [\x21\x23-\x5B\x5D-\x7E]+

customClaims -> (list)

An array of objects that define a custom claim validation name, value, and operation

Constraints:

min: 1

(structure)

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

inboundTokenClaimName -> (string) [required]

The name of the custom claim field to check.

Constraints:

min: 1

max: 255

pattern: [A-Za-z0-9_.-:]+

inboundTokenClaimValueType -> (string) [required]

The data type of the claim value to check for.

Use STRING if you want to find an exact match to a string you define.

Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

Possible values:

STRING

STRING_ARRAY

authorizingClaimMatchValue -> (structure) [required]

Defines the value or values to match for and the relationship of the match.

claimMatchValue -> (tagged union structure) [required]

The value or values to match for.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: matchValueString, matchValueStringList.

matchValueString -> (string)

The string value to match for.

Constraints:

min: 1

max: 255

pattern: [A-Za-z0-9_.-]+

matchValueStringList -> (list)

An array of strings to check for a match.

Constraints:

min: 1

(string)

Constraints:

min: 1

max: 255

pattern: [A-Za-z0-9_.-]+

claimMatchOperator -> (string) [required]

Defines the relationship between the claim field value and the value or values you’re matching for.

Possible values:

EQUALS

CONTAINS

CONTAINS_ANY

memory -> (tagged union structure)

AgentCore Memory instance configuration for short and long term memory.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: agentCoreMemoryConfiguration.

agentCoreMemoryConfiguration -> (structure)

The AgentCore Memory configuration.

arn -> (string) [required]

The ARN of the AgentCore Memory resource.

Constraints:

pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

actorId -> (string)

The actor ID for memory operations.

messagesCount -> (integer)

The number of messages to retrieve from memory.

retrievalConfig -> (map)

The retrieval configuration for long-term memory, mapping namespace path templates to retrieval settings.

key -> (string)

value -> (structure)

Configuration for memory retrieval within a namespace.

topK -> (integer)

The maximum number of memory entries to retrieve.

relevanceScore -> (float)

The minimum relevance score for retrieved memories.

strategyId -> (string)

The ID of the retrieval strategy to use.

maxIterations -> (integer)

The maximum number of iterations in the agent loop allowed before exiting per invocation.

maxTokens -> (integer)

The maximum number of tokens allowed before exiting per invocation.

timeoutSeconds -> (integer)

The maximum duration per invocation.

failureReason -> (string)

Reason why create or update operations fail.

Table of Contents

Feedback

User Guide

delete-harness¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note