Amazon Bedrock AgentCore Control

Operation to get a single Harness.

See also: AWS API Documentation

Request Syntax

client.get_harness(
    harnessId='string'
)

type harnessId:

string

param harnessId:

[REQUIRED]

The ID of the harness to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'harness': {
        'harnessId': 'string',
        'harnessName': 'string',
        'arn': 'string',
        'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
        'executionRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'model': {
            'bedrockModelConfig': {
                'modelId': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'openAiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'geminiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...,
                'topK': 123
            }
        },
        'systemPrompt': [
            {
                'text': 'string'
            },
        ],
        'tools': [
            {
                'type': 'remote_mcp'|'agentcore_browser'|'agentcore_gateway'|'inline_function'|'agentcore_code_interpreter',
                'name': 'string',
                'config': {
                    'remoteMcp': {
                        'url': 'string',
                        'headers': {
                            'string': 'string'
                        }
                    },
                    'agentCoreBrowser': {
                        'browserArn': 'string'
                    },
                    'agentCoreGateway': {
                        'gatewayArn': 'string',
                        'outboundAuth': {
                            'awsIam': {},
                            'none': {},
                            'oauth': {
                                'providerArn': 'string',
                                'scopes': [
                                    'string',
                                ],
                                'customParameters': {
                                    'string': 'string'
                                },
                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                'defaultReturnUrl': 'string'
                            }
                        }
                    },
                    'inlineFunction': {
                        'description': 'string',
                        'inputSchema': {...}|[...]|123|123.4|'string'|True|None
                    },
                    'agentCoreCodeInterpreter': {
                        'codeInterpreterArn': 'string'
                    }
                }
            },
        ],
        'skills': [
            {
                'path': 'string'
            },
        ],
        'allowedTools': [
            'string',
        ],
        'truncation': {
            'strategy': 'sliding_window'|'summarization'|'none',
            'config': {
                'slidingWindow': {
                    'messagesCount': 123
                },
                'summarization': {
                    'summaryRatio': ...,
                    'preserveRecentMessages': 123,
                    'summarizationSystemPrompt': 'string'
                }
            }
        },
        'environment': {
            'agentCoreRuntimeEnvironment': {
                'agentRuntimeArn': 'string',
                'agentRuntimeName': 'string',
                'agentRuntimeId': 'string',
                'lifecycleConfiguration': {
                    'idleRuntimeSessionTimeout': 123,
                    'maxLifetime': 123
                },
                'networkConfiguration': {
                    'networkMode': 'PUBLIC'|'VPC',
                    'networkModeConfig': {
                        'securityGroups': [
                            'string',
                        ],
                        'subnets': [
                            'string',
                        ]
                    }
                },
                'filesystemConfigurations': [
                    {
                        'sessionStorage': {
                            'mountPath': 'string'
                        }
                    },
                ]
            }
        },
        'environmentArtifact': {
            'containerConfiguration': {
                'containerUri': 'string'
            }
        },
        'environmentVariables': {
            'string': 'string'
        },
        'authorizerConfiguration': {
            'customJWTAuthorizer': {
                'discoveryUrl': 'string',
                'allowedAudience': [
                    'string',
                ],
                'allowedClients': [
                    'string',
                ],
                'allowedScopes': [
                    'string',
                ],
                'customClaims': [
                    {
                        'inboundTokenClaimName': 'string',
                        'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                        'authorizingClaimMatchValue': {
                            'claimMatchValue': {
                                'matchValueString': 'string',
                                'matchValueStringList': [
                                    'string',
                                ]
                            },
                            'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                        }
                    },
                ]
            }
        },
        'memory': {
            'agentCoreMemoryConfiguration': {
                'arn': 'string',
                'actorId': 'string',
                'messagesCount': 123,
                'retrievalConfig': {
                    'string': {
                        'topK': 123,
                        'relevanceScore': ...,
                        'strategyId': 'string'
                    }
                }
            }
        },
        'maxIterations': 123,
        'maxTokens': 123,
        'timeoutSeconds': 123,
        'failureReason': 'string'
    }
}

Response Structure

• (dict) --

  • harness (dict) --

    The harness resource.

    • harnessId (string) --

      The ID of the Harness.

    • harnessName (string) --

      The name of the Harness.

    • arn (string) --

      The ARN of the Harness.

    • status (string) --

      The status of the Harness.

    • executionRoleArn (string) --

      IAM role the Harness assumes when running.

    • createdAt (datetime) --

      The createdAt time of the Harness.

    • updatedAt (datetime) --

      The updatedAt time of the Harness.

    • model (dict) --

      The configuration of the default model used by the Harness.

      • bedrockModelConfig (dict) --

        Configuration for an Amazon Bedrock model.

        • modelId (string) --

          The Bedrock model ID.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • openAiModelConfig (dict) --

        Configuration for an OpenAI model.

        • modelId (string) --

          The OpenAI model ID.

        • apiKeyArn (string) --

          The ARN of your OpenAI API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • geminiModelConfig (dict) --

        Configuration for a Google Gemini model.

        • modelId (string) --

          The Gemini model ID.

        • apiKeyArn (string) --

          The ARN of your Gemini API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

        • topK (integer) --

          The topK set when calling the model.

    • systemPrompt (list) --

      The system prompt of the Harness.

      • (dict) --

        A content block in the system prompt.

        • text (string) --

          The text content of the system prompt block.

    • tools (list) --

      The tools of the Harness.

      • (dict) --

        A tool available to the agent loop.

        • type (string) --

          The type of tool.

        • name (string) --

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

        • config (dict) --

          Tool-specific configuration.

          • remoteMcp (dict) --

            Configuration for remote MCP server.

            • url (string) --

              URL of the MCP endpoint.

            • headers (dict) --

              Map of key/value pairs for HTTP headers.

              • (string) --

                The key of an HTTP header.

                • (string) --

                  The value of an HTTP header.

          • agentCoreBrowser (dict) --

            Configuration for AgentCore Browser.

            • browserArn (string) --

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

          • agentCoreGateway (dict) --

            Configuration for AgentCore Gateway.

            • gatewayArn (string) --

              The ARN of the desired AgentCore Gateway.

            • outboundAuth (dict) --

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

              • awsIam (dict) --

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

              • none (dict) --

                No authentication.

              • oauth (dict) --

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

                • providerArn (string) --

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

                • scopes (list) --

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

                  • (string) --

                • customParameters (dict) --

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

                  • (string) --

                    • (string) --

                • 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.

                • defaultReturnUrl (string) --

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

          • inlineFunction (dict) --

            Configuration for an inline function tool.

            • description (string) --

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

            • inputSchema (:ref:`document<document>`) --

              JSON Schema describing the tool's input parameters.

          • agentCoreCodeInterpreter (dict) --

            Configuration for AgentCore Code Interpreter.

            • codeInterpreterArn (string) --

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

    • skills (list) --

      The skills of the Harness.

      • (dict) --

        A skill available to the agent.

        • path (string) --

          The filesystem path to the skill definition.

    • allowedTools (list) --

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

      • (string) --

    • truncation (dict) --

      Configuration for truncating model context.

      • strategy (string) --

        The truncation strategy to use.

      • config (dict) --

        The strategy-specific configuration.

        • slidingWindow (dict) --

          Configuration for sliding window truncation.

          • messagesCount (integer) --

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

        • summarization (dict) --

          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 (dict) --

      The compute environment on which the Harness runs.

      • agentCoreRuntimeEnvironment (dict) --

        The AgentCore Runtime environment configuration.

        • agentRuntimeArn (string) --

          The ARN of the underlying AgentCore Runtime.

        • agentRuntimeName (string) --

          The name of the underlying AgentCore Runtime.

        • agentRuntimeId (string) --

          The ID of the underlying AgentCore Runtime.

        • lifecycleConfiguration (dict) --

          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).

          • maxLifetime (integer) --

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

        • networkConfiguration (dict) --

          SecurityConfig for the Agent.

          • networkMode (string) --

            The network mode for the AgentCore Runtime.

          • networkModeConfig (dict) --

            The network mode configuration for the AgentCore Runtime.

            • securityGroups (list) --

              The security groups associated with the VPC configuration.

              • (string) --

            • subnets (list) --

              The subnets associated with the VPC configuration.

              • (string) --

        • filesystemConfigurations (list) --

          The filesystem configurations for the runtime environment.

          • (dict) --

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

            • sessionStorage (dict) --

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

              • mountPath (string) --

                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).

    • environmentArtifact (dict) --

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

      • containerConfiguration (dict) --

        Representation of a container configuration.

        • containerUri (string) --

          The ECR URI of the container.

    • environmentVariables (dict) --

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

      • (string) --

        • (string) --

    • authorizerConfiguration (dict) --

      Represents inbound authorization configuration options used to authenticate incoming requests.

      • customJWTAuthorizer (dict) --

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) --

          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) --

        • allowedScopes (list) --

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

          • (string) --

        • customClaims (list) --

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

          • (dict) --

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

            • inboundTokenClaimName (string) --

              The name of the custom claim field to check.

            • inboundTokenClaimValueType (string) --

              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.

            • authorizingClaimMatchValue (dict) --

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

              • claimMatchValue (dict) --

                The value or values to match for.

                • matchValueString (string) --

                  The string value to match for.

                • matchValueStringList (list) --

                  An array of strings to check for a match.

                  • (string) --

              • claimMatchOperator (string) --

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

    • memory (dict) --

      AgentCore Memory instance configuration for short and long term memory.

      • agentCoreMemoryConfiguration (dict) --

        The AgentCore Memory configuration.

        • arn (string) --

          The ARN of the AgentCore Memory resource.

        • actorId (string) --

          The actor ID for memory operations.

        • messagesCount (integer) --

          The number of messages to retrieve from memory.

        • retrievalConfig (dict) --

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

          • (string) --

            • (dict) --

              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.

Operation to create a Harness.

See also: AWS API Documentation

Request Syntax

client.create_harness(
    harnessName='string',
    clientToken='string',
    executionRoleArn='string',
    environment={
        'agentCoreRuntimeEnvironment': {
            'lifecycleConfiguration': {
                'idleRuntimeSessionTimeout': 123,
                'maxLifetime': 123
            },
            'networkConfiguration': {
                'networkMode': 'PUBLIC'|'VPC',
                'networkModeConfig': {
                    'securityGroups': [
                        'string',
                    ],
                    'subnets': [
                        'string',
                    ]
                }
            },
            'filesystemConfigurations': [
                {
                    'sessionStorage': {
                        'mountPath': 'string'
                    }
                },
            ]
        }
    },
    environmentArtifact={
        'containerConfiguration': {
            'containerUri': 'string'
        }
    },
    environmentVariables={
        'string': 'string'
    },
    authorizerConfiguration={
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ],
            'allowedScopes': [
                'string',
            ],
            'customClaims': [
                {
                    'inboundTokenClaimName': 'string',
                    'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                    'authorizingClaimMatchValue': {
                        'claimMatchValue': {
                            'matchValueString': 'string',
                            'matchValueStringList': [
                                'string',
                            ]
                        },
                        'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                    }
                },
            ]
        }
    },
    model={
        'bedrockModelConfig': {
            'modelId': 'string',
            'maxTokens': 123,
            'temperature': ...,
            'topP': ...
        },
        'openAiModelConfig': {
            'modelId': 'string',
            'apiKeyArn': 'string',
            'maxTokens': 123,
            'temperature': ...,
            'topP': ...
        },
        'geminiModelConfig': {
            'modelId': 'string',
            'apiKeyArn': 'string',
            'maxTokens': 123,
            'temperature': ...,
            'topP': ...,
            'topK': 123
        }
    },
    systemPrompt=[
        {
            'text': 'string'
        },
    ],
    tools=[
        {
            'type': 'remote_mcp'|'agentcore_browser'|'agentcore_gateway'|'inline_function'|'agentcore_code_interpreter',
            'name': 'string',
            'config': {
                'remoteMcp': {
                    'url': 'string',
                    'headers': {
                        'string': 'string'
                    }
                },
                'agentCoreBrowser': {
                    'browserArn': 'string'
                },
                'agentCoreGateway': {
                    'gatewayArn': 'string',
                    'outboundAuth': {
                        'awsIam': {}
                        ,
                        'none': {}
                        ,
                        'oauth': {
                            'providerArn': 'string',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            },
                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                            'defaultReturnUrl': 'string'
                        }
                    }
                },
                'inlineFunction': {
                    'description': 'string',
                    'inputSchema': {...}|[...]|123|123.4|'string'|True|None
                },
                'agentCoreCodeInterpreter': {
                    'codeInterpreterArn': 'string'
                }
            }
        },
    ],
    skills=[
        {
            'path': 'string'
        },
    ],
    allowedTools=[
        'string',
    ],
    memory={
        'agentCoreMemoryConfiguration': {
            'arn': 'string',
            'actorId': 'string',
            'messagesCount': 123,
            'retrievalConfig': {
                'string': {
                    'topK': 123,
                    'relevanceScore': ...,
                    'strategyId': 'string'
                }
            }
        }
    },
    truncation={
        'strategy': 'sliding_window'|'summarization'|'none',
        'config': {
            'slidingWindow': {
                'messagesCount': 123
            },
            'summarization': {
                'summaryRatio': ...,
                'preserveRecentMessages': 123,
                'summarizationSystemPrompt': 'string'
            }
        }
    },
    maxIterations=123,
    maxTokens=123,
    timeoutSeconds=123,
    tags={
        'string': 'string'
    }
)

type harnessName:

string

param harnessName:

[REQUIRED]

The name of the harness. Must start with a letter and contain only alphanumeric characters and underscores.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type executionRoleArn:

string

param executionRoleArn:

[REQUIRED]

The ARN of the IAM role that the harness assumes when running. This role must have permissions for the services the agent needs to access, such as Amazon Bedrock for model invocation.

type environment:

dict

param environment:

The compute environment configuration for the harness, including network and lifecycle settings.

• agentCoreRuntimeEnvironment (dict) --

  The AgentCore Runtime environment configuration.

  • lifecycleConfiguration (dict) --

    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).

    • maxLifetime (integer) --

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

  • networkConfiguration (dict) --

    SecurityConfig for the Agent.

    • 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) --

  • filesystemConfigurations (list) --

    The filesystem configurations for the runtime environment.

    • (dict) --

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

      • sessionStorage (dict) --

        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).

type environmentArtifact:

dict

param environmentArtifact:

The environment artifact for the harness, such as a custom container image containing additional dependencies.

• containerConfiguration (dict) --

  Representation of a container configuration.

  • containerUri (string) -- [REQUIRED]

    The ECR URI of the container.

type environmentVariables:

dict

param environmentVariables:

Environment variables to set in the harness runtime environment.

• (string) --

  • (string) --

type authorizerConfiguration:

dict

param authorizerConfiguration:

Represents inbound authorization configuration options used to authenticate incoming requests.

• 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) --

  • allowedScopes (list) --

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

    • (string) --

  • customClaims (list) --

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

    • (dict) --

      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.

      • 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.

      • authorizingClaimMatchValue (dict) -- [REQUIRED]

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

        • claimMatchValue (dict) -- [REQUIRED]

          The value or values to match for.

          • matchValueString (string) --

            The string value to match for.

          • matchValueStringList (list) --

            An array of strings to check for a match.

            • (string) --

        • claimMatchOperator (string) -- [REQUIRED]

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

type model:

dict

param model:

The model configuration for the harness. Supports Amazon Bedrock, OpenAI, and Google Gemini model providers.

• bedrockModelConfig (dict) --

  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.

  • temperature (float) --

    The temperature to set when calling the model.

  • topP (float) --

    The topP set when calling the model.

• openAiModelConfig (dict) --

  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.

  • maxTokens (integer) --

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

  • temperature (float) --

    The temperature to set when calling the model.

  • topP (float) --

    The topP set when calling the model.

• geminiModelConfig (dict) --

  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.

  • maxTokens (integer) --

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

  • temperature (float) --

    The temperature to set when calling the model.

  • topP (float) --

    The topP set when calling the model.

  • topK (integer) --

    The topK set when calling the model.

type systemPrompt:

list

param systemPrompt:

The system prompt that defines the agent's behavior and instructions.

• (dict) --

  A content block in the system prompt.

  • text (string) --

    The text content of the system prompt block.

type tools:

list

param tools:

The tools available to the agent, such as remote MCP servers, AgentCore Gateway, AgentCore Browser, Code Interpreter, or inline functions.

• (dict) --

  A tool available to the agent loop.

  • type (string) -- [REQUIRED]

    The type of tool.

  • name (string) --

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

  • config (dict) --

    Tool-specific configuration.

    • remoteMcp (dict) --

      Configuration for remote MCP server.

      • url (string) -- [REQUIRED]

        URL of the MCP endpoint.

      • headers (dict) --

        Map of key/value pairs for HTTP headers.

        • (string) --

          The key of an HTTP header.

          • (string) --

            The value of an HTTP header.

    • agentCoreBrowser (dict) --

      Configuration for AgentCore Browser.

      • browserArn (string) --

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

    • agentCoreGateway (dict) --

      Configuration for AgentCore Gateway.

      • gatewayArn (string) -- [REQUIRED]

        The ARN of the desired AgentCore Gateway.

      • outboundAuth (dict) --

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

        • awsIam (dict) --

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

        • none (dict) --

          No authentication.

        • oauth (dict) --

          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.

          • scopes (list) -- [REQUIRED]

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

            • (string) --

          • customParameters (dict) --

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

            • (string) --

              • (string) --

          • 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.

          • defaultReturnUrl (string) --

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

    • inlineFunction (dict) --

      Configuration for an inline function tool.

      • description (string) -- [REQUIRED]

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

      • inputSchema (:ref:`document<document>`) -- [REQUIRED]

        JSON Schema describing the tool's input parameters.

    • agentCoreCodeInterpreter (dict) --

      Configuration for AgentCore Code Interpreter.

      • codeInterpreterArn (string) --

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

type skills:

list

param skills:

The skills available to the agent. Skills are bundles of files that the agent can pull into its context on demand.

• (dict) --

  A skill available to the agent.

  • path (string) --

    The filesystem path to the skill definition.

type allowedTools:

list

param allowedTools:

The tools that the agent is allowed to use. Supports glob patterns such as * for all tools, @builtin for all built-in tools, or @serverName/toolName for specific MCP server tools.

• (string) --

type memory:

dict

param memory:

The AgentCore Memory configuration for persisting conversation context across sessions.

• agentCoreMemoryConfiguration (dict) --

  The AgentCore Memory configuration.

  • arn (string) -- [REQUIRED]

    The ARN of the AgentCore Memory resource.

  • actorId (string) --

    The actor ID for memory operations.

  • messagesCount (integer) --

    The number of messages to retrieve from memory.

  • retrievalConfig (dict) --

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

    • (string) --

      • (dict) --

        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.

type truncation:

dict

param truncation:

The truncation configuration for managing conversation context when it exceeds model limits.

• strategy (string) -- [REQUIRED]

  The truncation strategy to use.

• config (dict) --

  The strategy-specific configuration.

  • slidingWindow (dict) --

    Configuration for sliding window truncation.

    • messagesCount (integer) --

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

  • summarization (dict) --

    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.

type maxIterations:

integer

param maxIterations:

The maximum number of iterations the agent loop can execute per invocation.

type maxTokens:

integer

param maxTokens:

The maximum number of tokens the agent can generate per iteration.

type timeoutSeconds:

integer

param timeoutSeconds:

The maximum duration in seconds for the agent loop execution per invocation.

type tags:

dict

param tags:

Tags to apply to the harness resource.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'harness': {
        'harnessId': 'string',
        'harnessName': 'string',
        'arn': 'string',
        'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
        'executionRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'model': {
            'bedrockModelConfig': {
                'modelId': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'openAiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'geminiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...,
                'topK': 123
            }
        },
        'systemPrompt': [
            {
                'text': 'string'
            },
        ],
        'tools': [
            {
                'type': 'remote_mcp'|'agentcore_browser'|'agentcore_gateway'|'inline_function'|'agentcore_code_interpreter',
                'name': 'string',
                'config': {
                    'remoteMcp': {
                        'url': 'string',
                        'headers': {
                            'string': 'string'
                        }
                    },
                    'agentCoreBrowser': {
                        'browserArn': 'string'
                    },
                    'agentCoreGateway': {
                        'gatewayArn': 'string',
                        'outboundAuth': {
                            'awsIam': {},
                            'none': {},
                            'oauth': {
                                'providerArn': 'string',
                                'scopes': [
                                    'string',
                                ],
                                'customParameters': {
                                    'string': 'string'
                                },
                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                'defaultReturnUrl': 'string'
                            }
                        }
                    },
                    'inlineFunction': {
                        'description': 'string',
                        'inputSchema': {...}|[...]|123|123.4|'string'|True|None
                    },
                    'agentCoreCodeInterpreter': {
                        'codeInterpreterArn': 'string'
                    }
                }
            },
        ],
        'skills': [
            {
                'path': 'string'
            },
        ],
        'allowedTools': [
            'string',
        ],
        'truncation': {
            'strategy': 'sliding_window'|'summarization'|'none',
            'config': {
                'slidingWindow': {
                    'messagesCount': 123
                },
                'summarization': {
                    'summaryRatio': ...,
                    'preserveRecentMessages': 123,
                    'summarizationSystemPrompt': 'string'
                }
            }
        },
        'environment': {
            'agentCoreRuntimeEnvironment': {
                'agentRuntimeArn': 'string',
                'agentRuntimeName': 'string',
                'agentRuntimeId': 'string',
                'lifecycleConfiguration': {
                    'idleRuntimeSessionTimeout': 123,
                    'maxLifetime': 123
                },
                'networkConfiguration': {
                    'networkMode': 'PUBLIC'|'VPC',
                    'networkModeConfig': {
                        'securityGroups': [
                            'string',
                        ],
                        'subnets': [
                            'string',
                        ]
                    }
                },
                'filesystemConfigurations': [
                    {
                        'sessionStorage': {
                            'mountPath': 'string'
                        }
                    },
                ]
            }
        },
        'environmentArtifact': {
            'containerConfiguration': {
                'containerUri': 'string'
            }
        },
        'environmentVariables': {
            'string': 'string'
        },
        'authorizerConfiguration': {
            'customJWTAuthorizer': {
                'discoveryUrl': 'string',
                'allowedAudience': [
                    'string',
                ],
                'allowedClients': [
                    'string',
                ],
                'allowedScopes': [
                    'string',
                ],
                'customClaims': [
                    {
                        'inboundTokenClaimName': 'string',
                        'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                        'authorizingClaimMatchValue': {
                            'claimMatchValue': {
                                'matchValueString': 'string',
                                'matchValueStringList': [
                                    'string',
                                ]
                            },
                            'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                        }
                    },
                ]
            }
        },
        'memory': {
            'agentCoreMemoryConfiguration': {
                'arn': 'string',
                'actorId': 'string',
                'messagesCount': 123,
                'retrievalConfig': {
                    'string': {
                        'topK': 123,
                        'relevanceScore': ...,
                        'strategyId': 'string'
                    }
                }
            }
        },
        'maxIterations': 123,
        'maxTokens': 123,
        'timeoutSeconds': 123,
        'failureReason': 'string'
    }
}

Response Structure

• (dict) --

  • harness (dict) --

    The harness that was created.

    • harnessId (string) --

      The ID of the Harness.

    • harnessName (string) --

      The name of the Harness.

    • arn (string) --

      The ARN of the Harness.

    • status (string) --

      The status of the Harness.

    • executionRoleArn (string) --

      IAM role the Harness assumes when running.

    • createdAt (datetime) --

      The createdAt time of the Harness.

    • updatedAt (datetime) --

      The updatedAt time of the Harness.

    • model (dict) --

      The configuration of the default model used by the Harness.

      • bedrockModelConfig (dict) --

        Configuration for an Amazon Bedrock model.

        • modelId (string) --

          The Bedrock model ID.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • openAiModelConfig (dict) --

        Configuration for an OpenAI model.

        • modelId (string) --

          The OpenAI model ID.

        • apiKeyArn (string) --

          The ARN of your OpenAI API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • geminiModelConfig (dict) --

        Configuration for a Google Gemini model.

        • modelId (string) --

          The Gemini model ID.

        • apiKeyArn (string) --

          The ARN of your Gemini API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

        • topK (integer) --

          The topK set when calling the model.

    • systemPrompt (list) --

      The system prompt of the Harness.

      • (dict) --

        A content block in the system prompt.

        • text (string) --

          The text content of the system prompt block.

    • tools (list) --

      The tools of the Harness.

      • (dict) --

        A tool available to the agent loop.

        • type (string) --

          The type of tool.

        • name (string) --

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

        • config (dict) --

          Tool-specific configuration.

          • remoteMcp (dict) --

            Configuration for remote MCP server.

            • url (string) --

              URL of the MCP endpoint.

            • headers (dict) --

              Map of key/value pairs for HTTP headers.

              • (string) --

                The key of an HTTP header.

                • (string) --

                  The value of an HTTP header.

          • agentCoreBrowser (dict) --

            Configuration for AgentCore Browser.

            • browserArn (string) --

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

          • agentCoreGateway (dict) --

            Configuration for AgentCore Gateway.

            • gatewayArn (string) --

              The ARN of the desired AgentCore Gateway.

            • outboundAuth (dict) --

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

              • awsIam (dict) --

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

              • none (dict) --

                No authentication.

              • oauth (dict) --

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

                • providerArn (string) --

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

                • scopes (list) --

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

                  • (string) --

                • customParameters (dict) --

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

                  • (string) --

                    • (string) --

                • 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.

                • defaultReturnUrl (string) --

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

          • inlineFunction (dict) --

            Configuration for an inline function tool.

            • description (string) --

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

            • inputSchema (:ref:`document<document>`) --

              JSON Schema describing the tool's input parameters.

          • agentCoreCodeInterpreter (dict) --

            Configuration for AgentCore Code Interpreter.

            • codeInterpreterArn (string) --

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

    • skills (list) --

      The skills of the Harness.

      • (dict) --

        A skill available to the agent.

        • path (string) --

          The filesystem path to the skill definition.

    • allowedTools (list) --

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

      • (string) --

    • truncation (dict) --

      Configuration for truncating model context.

      • strategy (string) --

        The truncation strategy to use.

      • config (dict) --

        The strategy-specific configuration.

        • slidingWindow (dict) --

          Configuration for sliding window truncation.

          • messagesCount (integer) --

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

        • summarization (dict) --

          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 (dict) --

      The compute environment on which the Harness runs.

      • agentCoreRuntimeEnvironment (dict) --

        The AgentCore Runtime environment configuration.

        • agentRuntimeArn (string) --

          The ARN of the underlying AgentCore Runtime.

        • agentRuntimeName (string) --

          The name of the underlying AgentCore Runtime.

        • agentRuntimeId (string) --

          The ID of the underlying AgentCore Runtime.

        • lifecycleConfiguration (dict) --

          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).

          • maxLifetime (integer) --

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

        • networkConfiguration (dict) --

          SecurityConfig for the Agent.

          • networkMode (string) --

            The network mode for the AgentCore Runtime.

          • networkModeConfig (dict) --

            The network mode configuration for the AgentCore Runtime.

            • securityGroups (list) --

              The security groups associated with the VPC configuration.

              • (string) --

            • subnets (list) --

              The subnets associated with the VPC configuration.

              • (string) --

        • filesystemConfigurations (list) --

          The filesystem configurations for the runtime environment.

          • (dict) --

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

            • sessionStorage (dict) --

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

              • mountPath (string) --

                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).

    • environmentArtifact (dict) --

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

      • containerConfiguration (dict) --

        Representation of a container configuration.

        • containerUri (string) --

          The ECR URI of the container.

    • environmentVariables (dict) --

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

      • (string) --

        • (string) --

    • authorizerConfiguration (dict) --

      Represents inbound authorization configuration options used to authenticate incoming requests.

      • customJWTAuthorizer (dict) --

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) --

          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) --

        • allowedScopes (list) --

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

          • (string) --

        • customClaims (list) --

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

          • (dict) --

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

            • inboundTokenClaimName (string) --

              The name of the custom claim field to check.

            • inboundTokenClaimValueType (string) --

              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.

            • authorizingClaimMatchValue (dict) --

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

              • claimMatchValue (dict) --

                The value or values to match for.

                • matchValueString (string) --

                  The string value to match for.

                • matchValueStringList (list) --

                  An array of strings to check for a match.

                  • (string) --

              • claimMatchOperator (string) --

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

    • memory (dict) --

      AgentCore Memory instance configuration for short and long term memory.

      • agentCoreMemoryConfiguration (dict) --

        The AgentCore Memory configuration.

        • arn (string) --

          The ARN of the AgentCore Memory resource.

        • actorId (string) --

          The actor ID for memory operations.

        • messagesCount (integer) --

          The number of messages to retrieve from memory.

        • retrievalConfig (dict) --

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

          • (string) --

            • (dict) --

              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.

Operation to update a Harness.

See also: AWS API Documentation

Request Syntax

client.update_harness(
    harnessId='string',
    clientToken='string',
    executionRoleArn='string',
    environment={
        'agentCoreRuntimeEnvironment': {
            'lifecycleConfiguration': {
                'idleRuntimeSessionTimeout': 123,
                'maxLifetime': 123
            },
            'networkConfiguration': {
                'networkMode': 'PUBLIC'|'VPC',
                'networkModeConfig': {
                    'securityGroups': [
                        'string',
                    ],
                    'subnets': [
                        'string',
                    ]
                }
            },
            'filesystemConfigurations': [
                {
                    'sessionStorage': {
                        'mountPath': 'string'
                    }
                },
            ]
        }
    },
    environmentArtifact={
        'optionalValue': {
            'containerConfiguration': {
                'containerUri': 'string'
            }
        }
    },
    environmentVariables={
        'string': 'string'
    },
    authorizerConfiguration={
        'optionalValue': {
            'customJWTAuthorizer': {
                'discoveryUrl': 'string',
                'allowedAudience': [
                    'string',
                ],
                'allowedClients': [
                    'string',
                ],
                'allowedScopes': [
                    'string',
                ],
                'customClaims': [
                    {
                        'inboundTokenClaimName': 'string',
                        'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                        'authorizingClaimMatchValue': {
                            'claimMatchValue': {
                                'matchValueString': 'string',
                                'matchValueStringList': [
                                    'string',
                                ]
                            },
                            'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                        }
                    },
                ]
            }
        }
    },
    model={
        'bedrockModelConfig': {
            'modelId': 'string',
            'maxTokens': 123,
            'temperature': ...,
            'topP': ...
        },
        'openAiModelConfig': {
            'modelId': 'string',
            'apiKeyArn': 'string',
            'maxTokens': 123,
            'temperature': ...,
            'topP': ...
        },
        'geminiModelConfig': {
            'modelId': 'string',
            'apiKeyArn': 'string',
            'maxTokens': 123,
            'temperature': ...,
            'topP': ...,
            'topK': 123
        }
    },
    systemPrompt=[
        {
            'text': 'string'
        },
    ],
    tools=[
        {
            'type': 'remote_mcp'|'agentcore_browser'|'agentcore_gateway'|'inline_function'|'agentcore_code_interpreter',
            'name': 'string',
            'config': {
                'remoteMcp': {
                    'url': 'string',
                    'headers': {
                        'string': 'string'
                    }
                },
                'agentCoreBrowser': {
                    'browserArn': 'string'
                },
                'agentCoreGateway': {
                    'gatewayArn': 'string',
                    'outboundAuth': {
                        'awsIam': {}
                        ,
                        'none': {}
                        ,
                        'oauth': {
                            'providerArn': 'string',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            },
                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                            'defaultReturnUrl': 'string'
                        }
                    }
                },
                'inlineFunction': {
                    'description': 'string',
                    'inputSchema': {...}|[...]|123|123.4|'string'|True|None
                },
                'agentCoreCodeInterpreter': {
                    'codeInterpreterArn': 'string'
                }
            }
        },
    ],
    skills=[
        {
            'path': 'string'
        },
    ],
    allowedTools=[
        'string',
    ],
    memory={
        'optionalValue': {
            'agentCoreMemoryConfiguration': {
                'arn': 'string',
                'actorId': 'string',
                'messagesCount': 123,
                'retrievalConfig': {
                    'string': {
                        'topK': 123,
                        'relevanceScore': ...,
                        'strategyId': 'string'
                    }
                }
            }
        }
    },
    truncation={
        'strategy': 'sliding_window'|'summarization'|'none',
        'config': {
            'slidingWindow': {
                'messagesCount': 123
            },
            'summarization': {
                'summaryRatio': ...,
                'preserveRecentMessages': 123,
                'summarizationSystemPrompt': 'string'
            }
        }
    },
    maxIterations=123,
    maxTokens=123,
    timeoutSeconds=123
)

type harnessId:

string

param harnessId:

[REQUIRED]

The ID of the harness to update.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type executionRoleArn:

string

param executionRoleArn:

The ARN of the IAM role that the harness assumes when running. If not specified, the existing value is retained.

type environment:

dict

param environment:

The compute environment configuration for the harness. If not specified, the existing value is retained.

• agentCoreRuntimeEnvironment (dict) --

  The AgentCore Runtime environment configuration.

  • lifecycleConfiguration (dict) --

    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).

    • maxLifetime (integer) --

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

  • networkConfiguration (dict) --

    SecurityConfig for the Agent.

    • 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) --

  • filesystemConfigurations (list) --

    The filesystem configurations for the runtime environment.

    • (dict) --

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

      • sessionStorage (dict) --

        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).

type environmentArtifact:

dict

param environmentArtifact:

The environment artifact for the harness. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.

• optionalValue (dict) --

  The updated environment artifact value, or null to clear the existing configuration.

  • containerConfiguration (dict) --

    Representation of a container configuration.

    • containerUri (string) -- [REQUIRED]

      The ECR URI of the container.

type environmentVariables:

dict

param environmentVariables:

Environment variables to set in the harness runtime environment. If specified, this replaces all existing environment variables. If not specified, the existing value is retained.

• (string) --

  • (string) --

type authorizerConfiguration:

dict

param authorizerConfiguration:

Wrapper for updating an optional AuthorizerConfiguration field with PATCH semantics. When present in an update request, the authorizer configuration is replaced with optionalValue. When absent, the authorizer configuration is left unchanged. To unset, include the wrapper with optionalValue not specified.

• optionalValue (dict) --

  The updated authorizer configuration value. If not specified, it will clear the current authorizer configuration of the resource.

  • 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) --

    • allowedScopes (list) --

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

      • (string) --

    • customClaims (list) --

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

      • (dict) --

        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.

        • 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.

        • authorizingClaimMatchValue (dict) -- [REQUIRED]

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

          • claimMatchValue (dict) -- [REQUIRED]

            The value or values to match for.

            • matchValueString (string) --

              The string value to match for.

            • matchValueStringList (list) --

              An array of strings to check for a match.

              • (string) --

          • claimMatchOperator (string) -- [REQUIRED]

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

type model:

dict

param model:

The model configuration for the harness. If not specified, the existing value is retained.

• bedrockModelConfig (dict) --

  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.

  • temperature (float) --

    The temperature to set when calling the model.

  • topP (float) --

    The topP set when calling the model.

• openAiModelConfig (dict) --

  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.

  • maxTokens (integer) --

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

  • temperature (float) --

    The temperature to set when calling the model.

  • topP (float) --

    The topP set when calling the model.

• geminiModelConfig (dict) --

  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.

  • maxTokens (integer) --

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

  • temperature (float) --

    The temperature to set when calling the model.

  • topP (float) --

    The topP set when calling the model.

  • topK (integer) --

    The topK set when calling the model.

type systemPrompt:

list

param systemPrompt:

The system prompt that defines the agent's behavior. If not specified, the existing value is retained.

• (dict) --

  A content block in the system prompt.

  • text (string) --

    The text content of the system prompt block.

type tools:

list

param tools:

The tools available to the agent. If specified, this replaces all existing tools. If not specified, the existing value is retained.

• (dict) --

  A tool available to the agent loop.

  • type (string) -- [REQUIRED]

    The type of tool.

  • name (string) --

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

  • config (dict) --

    Tool-specific configuration.

    • remoteMcp (dict) --

      Configuration for remote MCP server.

      • url (string) -- [REQUIRED]

        URL of the MCP endpoint.

      • headers (dict) --

        Map of key/value pairs for HTTP headers.

        • (string) --

          The key of an HTTP header.

          • (string) --

            The value of an HTTP header.

    • agentCoreBrowser (dict) --

      Configuration for AgentCore Browser.

      • browserArn (string) --

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

    • agentCoreGateway (dict) --

      Configuration for AgentCore Gateway.

      • gatewayArn (string) -- [REQUIRED]

        The ARN of the desired AgentCore Gateway.

      • outboundAuth (dict) --

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

        • awsIam (dict) --

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

        • none (dict) --

          No authentication.

        • oauth (dict) --

          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.

          • scopes (list) -- [REQUIRED]

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

            • (string) --

          • customParameters (dict) --

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

            • (string) --

              • (string) --

          • 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.

          • defaultReturnUrl (string) --

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

    • inlineFunction (dict) --

      Configuration for an inline function tool.

      • description (string) -- [REQUIRED]

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

      • inputSchema (:ref:`document<document>`) -- [REQUIRED]

        JSON Schema describing the tool's input parameters.

    • agentCoreCodeInterpreter (dict) --

      Configuration for AgentCore Code Interpreter.

      • codeInterpreterArn (string) --

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

type skills:

list

param skills:

The skills available to the agent. If specified, this replaces all existing skills. If not specified, the existing value is retained.

• (dict) --

  A skill available to the agent.

  • path (string) --

    The filesystem path to the skill definition.

type allowedTools:

list

param allowedTools:

The tools that the agent is allowed to use. If specified, this replaces all existing allowed tools. If not specified, the existing value is retained.

• (string) --

type memory:

dict

param memory:

The AgentCore Memory configuration. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.

• optionalValue (dict) --

  The updated memory configuration value, or null to clear the existing configuration.

  • agentCoreMemoryConfiguration (dict) --

    The AgentCore Memory configuration.

    • arn (string) -- [REQUIRED]

      The ARN of the AgentCore Memory resource.

    • actorId (string) --

      The actor ID for memory operations.

    • messagesCount (integer) --

      The number of messages to retrieve from memory.

    • retrievalConfig (dict) --

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

      • (string) --

        • (dict) --

          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.

type truncation:

dict

param truncation:

The truncation configuration for managing conversation context. If not specified, the existing value is retained.

• strategy (string) -- [REQUIRED]

  The truncation strategy to use.

• config (dict) --

  The strategy-specific configuration.

  • slidingWindow (dict) --

    Configuration for sliding window truncation.

    • messagesCount (integer) --

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

  • summarization (dict) --

    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.

type maxIterations:

integer

param maxIterations:

The maximum number of iterations the agent loop can execute per invocation. If not specified, the existing value is retained.

type maxTokens:

integer

param maxTokens:

The maximum number of tokens the agent can generate per iteration. If not specified, the existing value is retained.

type timeoutSeconds:

integer

param timeoutSeconds:

The maximum duration in seconds for the agent loop execution per invocation. If not specified, the existing value is retained.

rtype:

dict

returns:

Response Syntax

{
    'harness': {
        'harnessId': 'string',
        'harnessName': 'string',
        'arn': 'string',
        'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
        'executionRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'model': {
            'bedrockModelConfig': {
                'modelId': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'openAiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'geminiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...,
                'topK': 123
            }
        },
        'systemPrompt': [
            {
                'text': 'string'
            },
        ],
        'tools': [
            {
                'type': 'remote_mcp'|'agentcore_browser'|'agentcore_gateway'|'inline_function'|'agentcore_code_interpreter',
                'name': 'string',
                'config': {
                    'remoteMcp': {
                        'url': 'string',
                        'headers': {
                            'string': 'string'
                        }
                    },
                    'agentCoreBrowser': {
                        'browserArn': 'string'
                    },
                    'agentCoreGateway': {
                        'gatewayArn': 'string',
                        'outboundAuth': {
                            'awsIam': {},
                            'none': {},
                            'oauth': {
                                'providerArn': 'string',
                                'scopes': [
                                    'string',
                                ],
                                'customParameters': {
                                    'string': 'string'
                                },
                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                'defaultReturnUrl': 'string'
                            }
                        }
                    },
                    'inlineFunction': {
                        'description': 'string',
                        'inputSchema': {...}|[...]|123|123.4|'string'|True|None
                    },
                    'agentCoreCodeInterpreter': {
                        'codeInterpreterArn': 'string'
                    }
                }
            },
        ],
        'skills': [
            {
                'path': 'string'
            },
        ],
        'allowedTools': [
            'string',
        ],
        'truncation': {
            'strategy': 'sliding_window'|'summarization'|'none',
            'config': {
                'slidingWindow': {
                    'messagesCount': 123
                },
                'summarization': {
                    'summaryRatio': ...,
                    'preserveRecentMessages': 123,
                    'summarizationSystemPrompt': 'string'
                }
            }
        },
        'environment': {
            'agentCoreRuntimeEnvironment': {
                'agentRuntimeArn': 'string',
                'agentRuntimeName': 'string',
                'agentRuntimeId': 'string',
                'lifecycleConfiguration': {
                    'idleRuntimeSessionTimeout': 123,
                    'maxLifetime': 123
                },
                'networkConfiguration': {
                    'networkMode': 'PUBLIC'|'VPC',
                    'networkModeConfig': {
                        'securityGroups': [
                            'string',
                        ],
                        'subnets': [
                            'string',
                        ]
                    }
                },
                'filesystemConfigurations': [
                    {
                        'sessionStorage': {
                            'mountPath': 'string'
                        }
                    },
                ]
            }
        },
        'environmentArtifact': {
            'containerConfiguration': {
                'containerUri': 'string'
            }
        },
        'environmentVariables': {
            'string': 'string'
        },
        'authorizerConfiguration': {
            'customJWTAuthorizer': {
                'discoveryUrl': 'string',
                'allowedAudience': [
                    'string',
                ],
                'allowedClients': [
                    'string',
                ],
                'allowedScopes': [
                    'string',
                ],
                'customClaims': [
                    {
                        'inboundTokenClaimName': 'string',
                        'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                        'authorizingClaimMatchValue': {
                            'claimMatchValue': {
                                'matchValueString': 'string',
                                'matchValueStringList': [
                                    'string',
                                ]
                            },
                            'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                        }
                    },
                ]
            }
        },
        'memory': {
            'agentCoreMemoryConfiguration': {
                'arn': 'string',
                'actorId': 'string',
                'messagesCount': 123,
                'retrievalConfig': {
                    'string': {
                        'topK': 123,
                        'relevanceScore': ...,
                        'strategyId': 'string'
                    }
                }
            }
        },
        'maxIterations': 123,
        'maxTokens': 123,
        'timeoutSeconds': 123,
        'failureReason': 'string'
    }
}

Response Structure

• (dict) --

  • harness (dict) --

    The updated harness.

    • harnessId (string) --

      The ID of the Harness.

    • harnessName (string) --

      The name of the Harness.

    • arn (string) --

      The ARN of the Harness.

    • status (string) --

      The status of the Harness.

    • executionRoleArn (string) --

      IAM role the Harness assumes when running.

    • createdAt (datetime) --

      The createdAt time of the Harness.

    • updatedAt (datetime) --

      The updatedAt time of the Harness.

    • model (dict) --

      The configuration of the default model used by the Harness.

      • bedrockModelConfig (dict) --

        Configuration for an Amazon Bedrock model.

        • modelId (string) --

          The Bedrock model ID.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • openAiModelConfig (dict) --

        Configuration for an OpenAI model.

        • modelId (string) --

          The OpenAI model ID.

        • apiKeyArn (string) --

          The ARN of your OpenAI API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • geminiModelConfig (dict) --

        Configuration for a Google Gemini model.

        • modelId (string) --

          The Gemini model ID.

        • apiKeyArn (string) --

          The ARN of your Gemini API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

        • topK (integer) --

          The topK set when calling the model.

    • systemPrompt (list) --

      The system prompt of the Harness.

      • (dict) --

        A content block in the system prompt.

        • text (string) --

          The text content of the system prompt block.

    • tools (list) --

      The tools of the Harness.

      • (dict) --

        A tool available to the agent loop.

        • type (string) --

          The type of tool.

        • name (string) --

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

        • config (dict) --

          Tool-specific configuration.

          • remoteMcp (dict) --

            Configuration for remote MCP server.

            • url (string) --

              URL of the MCP endpoint.

            • headers (dict) --

              Map of key/value pairs for HTTP headers.

              • (string) --

                The key of an HTTP header.

                • (string) --

                  The value of an HTTP header.

          • agentCoreBrowser (dict) --

            Configuration for AgentCore Browser.

            • browserArn (string) --

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

          • agentCoreGateway (dict) --

            Configuration for AgentCore Gateway.

            • gatewayArn (string) --

              The ARN of the desired AgentCore Gateway.

            • outboundAuth (dict) --

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

              • awsIam (dict) --

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

              • none (dict) --

                No authentication.

              • oauth (dict) --

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

                • providerArn (string) --

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

                • scopes (list) --

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

                  • (string) --

                • customParameters (dict) --

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

                  • (string) --

                    • (string) --

                • 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.

                • defaultReturnUrl (string) --

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

          • inlineFunction (dict) --

            Configuration for an inline function tool.

            • description (string) --

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

            • inputSchema (:ref:`document<document>`) --

              JSON Schema describing the tool's input parameters.

          • agentCoreCodeInterpreter (dict) --

            Configuration for AgentCore Code Interpreter.

            • codeInterpreterArn (string) --

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

    • skills (list) --

      The skills of the Harness.

      • (dict) --

        A skill available to the agent.

        • path (string) --

          The filesystem path to the skill definition.

    • allowedTools (list) --

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

      • (string) --

    • truncation (dict) --

      Configuration for truncating model context.

      • strategy (string) --

        The truncation strategy to use.

      • config (dict) --

        The strategy-specific configuration.

        • slidingWindow (dict) --

          Configuration for sliding window truncation.

          • messagesCount (integer) --

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

        • summarization (dict) --

          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 (dict) --

      The compute environment on which the Harness runs.

      • agentCoreRuntimeEnvironment (dict) --

        The AgentCore Runtime environment configuration.

        • agentRuntimeArn (string) --

          The ARN of the underlying AgentCore Runtime.

        • agentRuntimeName (string) --

          The name of the underlying AgentCore Runtime.

        • agentRuntimeId (string) --

          The ID of the underlying AgentCore Runtime.

        • lifecycleConfiguration (dict) --

          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).

          • maxLifetime (integer) --

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

        • networkConfiguration (dict) --

          SecurityConfig for the Agent.

          • networkMode (string) --

            The network mode for the AgentCore Runtime.

          • networkModeConfig (dict) --

            The network mode configuration for the AgentCore Runtime.

            • securityGroups (list) --

              The security groups associated with the VPC configuration.

              • (string) --

            • subnets (list) --

              The subnets associated with the VPC configuration.

              • (string) --

        • filesystemConfigurations (list) --

          The filesystem configurations for the runtime environment.

          • (dict) --

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

            • sessionStorage (dict) --

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

              • mountPath (string) --

                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).

    • environmentArtifact (dict) --

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

      • containerConfiguration (dict) --

        Representation of a container configuration.

        • containerUri (string) --

          The ECR URI of the container.

    • environmentVariables (dict) --

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

      • (string) --

        • (string) --

    • authorizerConfiguration (dict) --

      Represents inbound authorization configuration options used to authenticate incoming requests.

      • customJWTAuthorizer (dict) --

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) --

          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) --

        • allowedScopes (list) --

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

          • (string) --

        • customClaims (list) --

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

          • (dict) --

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

            • inboundTokenClaimName (string) --

              The name of the custom claim field to check.

            • inboundTokenClaimValueType (string) --

              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.

            • authorizingClaimMatchValue (dict) --

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

              • claimMatchValue (dict) --

                The value or values to match for.

                • matchValueString (string) --

                  The string value to match for.

                • matchValueStringList (list) --

                  An array of strings to check for a match.

                  • (string) --

              • claimMatchOperator (string) --

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

    • memory (dict) --

      AgentCore Memory instance configuration for short and long term memory.

      • agentCoreMemoryConfiguration (dict) --

        The AgentCore Memory configuration.

        • arn (string) --

          The ARN of the AgentCore Memory resource.

        • actorId (string) --

          The actor ID for memory operations.

        • messagesCount (integer) --

          The number of messages to retrieve from memory.

        • retrievalConfig (dict) --

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

          • (string) --

            • (dict) --

              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.

Operation to list Harnesses.

See also: AWS API Documentation

Request Syntax

client.list_harnesses(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

The token for the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'harnesses': [
        {
            'harnessId': 'string',
            'harnessName': 'string',
            'arn': 'string',
            'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • harnesses (list) --

    The list of harness summaries.

    • (dict) --

      Summary information about a harness.

      • harnessId (string) --

        The ID of the harness.

      • harnessName (string) --

        The name of the harness.

      • arn (string) --

        The ARN of the harness.

      • status (string) --

        The current status of the harness.

      • createdAt (datetime) --

        The timestamp when the harness was created.

      • updatedAt (datetime) --

        The timestamp when the harness was last updated.

  • nextToken (string) --

    The token for the next set of results.

Operation to delete a Harness.

See also: AWS API Documentation

Request Syntax

client.delete_harness(
    harnessId='string',
    clientToken='string'
)

type harnessId:

string

param harnessId:

[REQUIRED]

The ID of the harness to delete.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'harness': {
        'harnessId': 'string',
        'harnessName': 'string',
        'arn': 'string',
        'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
        'executionRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'model': {
            'bedrockModelConfig': {
                'modelId': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'openAiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...
            },
            'geminiModelConfig': {
                'modelId': 'string',
                'apiKeyArn': 'string',
                'maxTokens': 123,
                'temperature': ...,
                'topP': ...,
                'topK': 123
            }
        },
        'systemPrompt': [
            {
                'text': 'string'
            },
        ],
        'tools': [
            {
                'type': 'remote_mcp'|'agentcore_browser'|'agentcore_gateway'|'inline_function'|'agentcore_code_interpreter',
                'name': 'string',
                'config': {
                    'remoteMcp': {
                        'url': 'string',
                        'headers': {
                            'string': 'string'
                        }
                    },
                    'agentCoreBrowser': {
                        'browserArn': 'string'
                    },
                    'agentCoreGateway': {
                        'gatewayArn': 'string',
                        'outboundAuth': {
                            'awsIam': {},
                            'none': {},
                            'oauth': {
                                'providerArn': 'string',
                                'scopes': [
                                    'string',
                                ],
                                'customParameters': {
                                    'string': 'string'
                                },
                                'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                                'defaultReturnUrl': 'string'
                            }
                        }
                    },
                    'inlineFunction': {
                        'description': 'string',
                        'inputSchema': {...}|[...]|123|123.4|'string'|True|None
                    },
                    'agentCoreCodeInterpreter': {
                        'codeInterpreterArn': 'string'
                    }
                }
            },
        ],
        'skills': [
            {
                'path': 'string'
            },
        ],
        'allowedTools': [
            'string',
        ],
        'truncation': {
            'strategy': 'sliding_window'|'summarization'|'none',
            'config': {
                'slidingWindow': {
                    'messagesCount': 123
                },
                'summarization': {
                    'summaryRatio': ...,
                    'preserveRecentMessages': 123,
                    'summarizationSystemPrompt': 'string'
                }
            }
        },
        'environment': {
            'agentCoreRuntimeEnvironment': {
                'agentRuntimeArn': 'string',
                'agentRuntimeName': 'string',
                'agentRuntimeId': 'string',
                'lifecycleConfiguration': {
                    'idleRuntimeSessionTimeout': 123,
                    'maxLifetime': 123
                },
                'networkConfiguration': {
                    'networkMode': 'PUBLIC'|'VPC',
                    'networkModeConfig': {
                        'securityGroups': [
                            'string',
                        ],
                        'subnets': [
                            'string',
                        ]
                    }
                },
                'filesystemConfigurations': [
                    {
                        'sessionStorage': {
                            'mountPath': 'string'
                        }
                    },
                ]
            }
        },
        'environmentArtifact': {
            'containerConfiguration': {
                'containerUri': 'string'
            }
        },
        'environmentVariables': {
            'string': 'string'
        },
        'authorizerConfiguration': {
            'customJWTAuthorizer': {
                'discoveryUrl': 'string',
                'allowedAudience': [
                    'string',
                ],
                'allowedClients': [
                    'string',
                ],
                'allowedScopes': [
                    'string',
                ],
                'customClaims': [
                    {
                        'inboundTokenClaimName': 'string',
                        'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
                        'authorizingClaimMatchValue': {
                            'claimMatchValue': {
                                'matchValueString': 'string',
                                'matchValueStringList': [
                                    'string',
                                ]
                            },
                            'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
                        }
                    },
                ]
            }
        },
        'memory': {
            'agentCoreMemoryConfiguration': {
                'arn': 'string',
                'actorId': 'string',
                'messagesCount': 123,
                'retrievalConfig': {
                    'string': {
                        'topK': 123,
                        'relevanceScore': ...,
                        'strategyId': 'string'
                    }
                }
            }
        },
        'maxIterations': 123,
        'maxTokens': 123,
        'timeoutSeconds': 123,
        'failureReason': 'string'
    }
}

Response Structure

• (dict) --

  • harness (dict) --

    The harness that was deleted.

    • harnessId (string) --

      The ID of the Harness.

    • harnessName (string) --

      The name of the Harness.

    • arn (string) --

      The ARN of the Harness.

    • status (string) --

      The status of the Harness.

    • executionRoleArn (string) --

      IAM role the Harness assumes when running.

    • createdAt (datetime) --

      The createdAt time of the Harness.

    • updatedAt (datetime) --

      The updatedAt time of the Harness.

    • model (dict) --

      The configuration of the default model used by the Harness.

      • bedrockModelConfig (dict) --

        Configuration for an Amazon Bedrock model.

        • modelId (string) --

          The Bedrock model ID.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • openAiModelConfig (dict) --

        Configuration for an OpenAI model.

        • modelId (string) --

          The OpenAI model ID.

        • apiKeyArn (string) --

          The ARN of your OpenAI API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

      • geminiModelConfig (dict) --

        Configuration for a Google Gemini model.

        • modelId (string) --

          The Gemini model ID.

        • apiKeyArn (string) --

          The ARN of your Gemini API key on AgentCore Identity.

        • maxTokens (integer) --

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

        • temperature (float) --

          The temperature to set when calling the model.

        • topP (float) --

          The topP set when calling the model.

        • topK (integer) --

          The topK set when calling the model.

    • systemPrompt (list) --

      The system prompt of the Harness.

      • (dict) --

        A content block in the system prompt.

        • text (string) --

          The text content of the system prompt block.

    • tools (list) --

      The tools of the Harness.

      • (dict) --

        A tool available to the agent loop.

        • type (string) --

          The type of tool.

        • name (string) --

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

        • config (dict) --

          Tool-specific configuration.

          • remoteMcp (dict) --

            Configuration for remote MCP server.

            • url (string) --

              URL of the MCP endpoint.

            • headers (dict) --

              Map of key/value pairs for HTTP headers.

              • (string) --

                The key of an HTTP header.

                • (string) --

                  The value of an HTTP header.

          • agentCoreBrowser (dict) --

            Configuration for AgentCore Browser.

            • browserArn (string) --

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

          • agentCoreGateway (dict) --

            Configuration for AgentCore Gateway.

            • gatewayArn (string) --

              The ARN of the desired AgentCore Gateway.

            • outboundAuth (dict) --

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

              • awsIam (dict) --

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

              • none (dict) --

                No authentication.

              • oauth (dict) --

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

                • providerArn (string) --

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

                • scopes (list) --

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

                  • (string) --

                • customParameters (dict) --

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

                  • (string) --

                    • (string) --

                • 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.

                • defaultReturnUrl (string) --

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

          • inlineFunction (dict) --

            Configuration for an inline function tool.

            • description (string) --

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

            • inputSchema (:ref:`document<document>`) --

              JSON Schema describing the tool's input parameters.

          • agentCoreCodeInterpreter (dict) --

            Configuration for AgentCore Code Interpreter.

            • codeInterpreterArn (string) --

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

    • skills (list) --

      The skills of the Harness.

      • (dict) --

        A skill available to the agent.

        • path (string) --

          The filesystem path to the skill definition.

    • allowedTools (list) --

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

      • (string) --

    • truncation (dict) --

      Configuration for truncating model context.

      • strategy (string) --

        The truncation strategy to use.

      • config (dict) --

        The strategy-specific configuration.

        • slidingWindow (dict) --

          Configuration for sliding window truncation.

          • messagesCount (integer) --

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

        • summarization (dict) --

          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 (dict) --

      The compute environment on which the Harness runs.

      • agentCoreRuntimeEnvironment (dict) --

        The AgentCore Runtime environment configuration.

        • agentRuntimeArn (string) --

          The ARN of the underlying AgentCore Runtime.

        • agentRuntimeName (string) --

          The name of the underlying AgentCore Runtime.

        • agentRuntimeId (string) --

          The ID of the underlying AgentCore Runtime.

        • lifecycleConfiguration (dict) --

          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).

          • maxLifetime (integer) --

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

        • networkConfiguration (dict) --

          SecurityConfig for the Agent.

          • networkMode (string) --

            The network mode for the AgentCore Runtime.

          • networkModeConfig (dict) --

            The network mode configuration for the AgentCore Runtime.

            • securityGroups (list) --

              The security groups associated with the VPC configuration.

              • (string) --

            • subnets (list) --

              The subnets associated with the VPC configuration.

              • (string) --

        • filesystemConfigurations (list) --

          The filesystem configurations for the runtime environment.

          • (dict) --

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

            • sessionStorage (dict) --

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

              • mountPath (string) --

                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).

    • environmentArtifact (dict) --

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

      • containerConfiguration (dict) --

        Representation of a container configuration.

        • containerUri (string) --

          The ECR URI of the container.

    • environmentVariables (dict) --

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

      • (string) --

        • (string) --

    • authorizerConfiguration (dict) --

      Represents inbound authorization configuration options used to authenticate incoming requests.

      • customJWTAuthorizer (dict) --

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) --

          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) --

        • allowedScopes (list) --

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

          • (string) --

        • customClaims (list) --

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

          • (dict) --

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

            • inboundTokenClaimName (string) --

              The name of the custom claim field to check.

            • inboundTokenClaimValueType (string) --

              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.

            • authorizingClaimMatchValue (dict) --

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

              • claimMatchValue (dict) --

                The value or values to match for.

                • matchValueString (string) --

                  The string value to match for.

                • matchValueStringList (list) --

                  An array of strings to check for a match.

                  • (string) --

              • claimMatchOperator (string) --

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

    • memory (dict) --

      AgentCore Memory instance configuration for short and long term memory.

      • agentCoreMemoryConfiguration (dict) --

        The AgentCore Memory configuration.

        • arn (string) --

          The ARN of the AgentCore Memory resource.

        • actorId (string) --

          The actor ID for memory operations.

        • messagesCount (integer) --

          The number of messages to retrieve from memory.

        • retrievalConfig (dict) --

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

          • (string) --

            • (dict) --

              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.

{'targetConfiguration': {'mcp': {'mcpServer': {'resourcePriority': 'integer'}}}}

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

See also: AWS API Documentation

Request Syntax

client.create_gateway_target(
    gatewayIdentifier='string',
    name='string',
    description='string',
    clientToken='string',
    targetConfiguration={
        'mcp': {
            'openApiSchema': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'smithyModel': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'lambda': {
                'lambdaArn': 'string',
                'toolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'inputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            },
                            'outputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            }
                        },
                    ]
                }
            },
            'mcpServer': {
                'endpoint': 'string',
                'mcpToolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': 'string'
                },
                'resourcePriority': 123,
                'listingMode': 'DEFAULT'|'DYNAMIC'
            },
            'apiGateway': {
                'restApiId': 'string',
                'stage': 'string',
                'apiGatewayToolConfiguration': {
                    'toolOverrides': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'path': 'string',
                            'method': 'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST'
                        },
                    ],
                    'toolFilters': [
                        {
                            'filterPath': 'string',
                            'methods': [
                                'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST',
                            ]
                        },
                    ]
                }
            }
        }
    },
    credentialProviderConfigurations=[
        {
            'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
            'credentialProvider': {
                'oauthCredentialProvider': {
                    'providerArn': 'string',
                    'scopes': [
                        'string',
                    ],
                    'customParameters': {
                        'string': 'string'
                    },
                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                    'defaultReturnUrl': 'string'
                },
                'apiKeyCredentialProvider': {
                    'providerArn': 'string',
                    'credentialParameterName': 'string',
                    'credentialPrefix': 'string',
                    'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
                },
                'iamCredentialProvider': {
                    'service': 'string',
                    'region': 'string'
                }
            }
        },
    ],
    metadataConfiguration={
        'allowedRequestHeaders': [
            'string',
        ],
        'allowedQueryParameters': [
            'string',
        ],
        'allowedResponseHeaders': [
            'string',
        ]
    },
    privateEndpoint={
        'selfManagedLatticeResource': {
            'resourceConfigurationIdentifier': 'string'
        },
        'managedLatticeResource': {
            'vpcIdentifier': 'string',
            'subnetIds': [
                'string',
            ],
            'endpointIpAddressType': 'IPV4'|'IPV6',
            'securityGroupIds': [
                'string',
            ],
            'tags': {
                'string': 'string'
            },
            'routingDomain': 'string'
        }
    }
)

type gatewayIdentifier:

string

param gatewayIdentifier:

[REQUIRED]

The identifier of the gateway to create a target for.

type name:

string

param name:

[REQUIRED]

The name of the gateway target. The name must be unique within the gateway.

type description:

string

param description:

The description of the gateway target.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

type targetConfiguration:

dict

param targetConfiguration:

[REQUIRED]

The configuration settings for the target, including endpoint information and schema definitions.

• mcp (dict) --

  The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.

  • openApiSchema (dict) --

    The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.

    • s3 (dict) --

      The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

      • uri (string) --

        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

      • bucketOwnerAccountId (string) --

        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

    • inlinePayload (string) --

      The inline payload containing the API schema definition.

  • smithyModel (dict) --

    The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.

    • s3 (dict) --

      The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

      • uri (string) --

        The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

      • bucketOwnerAccountId (string) --

        The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

    • inlinePayload (string) --

      The inline payload containing the API schema definition.

  • lambda (dict) --

    The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.

    • lambdaArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.

    • toolSchema (dict) -- [REQUIRED]

      The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.

      • s3 (dict) --

        The Amazon S3 location of the tool schema. This location contains the schema definition file.

        • uri (string) --

          The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

        • bucketOwnerAccountId (string) --

          The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

      • inlinePayload (list) --

        The inline payload of the tool schema. This payload contains the schema definition directly in the request.

        • (dict) --

          A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

          • name (string) -- [REQUIRED]

            The name of the tool. This name identifies the tool in the Model Context Protocol.

          • description (string) -- [REQUIRED]

            The description of the tool. This description provides information about the purpose and usage of the tool.

          • inputSchema (dict) -- [REQUIRED]

            The input schema for the tool. This schema defines the structure of the input that the tool accepts.

            • type (string) -- [REQUIRED]

              The type of the schema definition. This field specifies the data type of the schema.

            • properties (dict) --

              The properties of the schema definition. These properties define the fields in the schema.

              • (string) --

                • (dict) --

                  A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

            • required (list) --

              The required fields in the schema definition. These fields must be provided when using the schema.

              • (string) --

            • items (dict) --

              The items in the schema definition. This field is used for array types to define the structure of the array elements.

            • description (string) --

              The description of the schema definition. This description provides information about the purpose and usage of the schema.

          • outputSchema (dict) --

            The output schema for the tool. This schema defines the structure of the output that the tool produces.

            • type (string) -- [REQUIRED]

              The type of the schema definition. This field specifies the data type of the schema.

            • properties (dict) --

              The properties of the schema definition. These properties define the fields in the schema.

              • (string) --

                • (dict) --

                  A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

            • required (list) --

              The required fields in the schema definition. These fields must be provided when using the schema.

              • (string) --

            • items (dict) --

              The items in the schema definition. This field is used for array types to define the structure of the array elements.

            • description (string) --

              The description of the schema definition. This description provides information about the purpose and usage of the schema.

  • mcpServer (dict) --

    The MCP server specified as the gateway target.

    • endpoint (string) -- [REQUIRED]

      The endpoint for the MCP server target configuration.

    • mcpToolSchema (dict) --

      The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.

      • s3 (dict) --

        The Amazon S3 location of the tool schema. This location contains the schema definition file.

        • uri (string) --

          The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

        • bucketOwnerAccountId (string) --

          The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

      • inlinePayload (string) --

        The inline payload containing the MCP tool schema definition.

    • resourcePriority (integer) --

      Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.

    • listingMode (string) --

      The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.

  • apiGateway (dict) --

    The configuration for an Amazon API Gateway target.

    • restApiId (string) -- [REQUIRED]

      The ID of the API Gateway REST API.

    • stage (string) -- [REQUIRED]

      The ID of the stage of the REST API to add as a target.

    • apiGatewayToolConfiguration (dict) -- [REQUIRED]

      The configuration for defining REST API tool filters and overrides for the gateway target.

      • toolOverrides (list) --

        A list of explicit tool definitions with optional custom names and descriptions.

        • (dict) --

          Settings to override configurations for a tool.

          • name (string) -- [REQUIRED]

            The name of tool. Identifies the tool in the Model Context Protocol.

          • description (string) --

            The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

          • path (string) -- [REQUIRED]

            Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

          • method (string) -- [REQUIRED]

            The HTTP method to expose for the specified path.

      • toolFilters (list) -- [REQUIRED]

        A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.

        • (dict) --

          Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

          • filterPath (string) -- [REQUIRED]

            Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

          • methods (list) -- [REQUIRED]

            The methods to filter for.

            • (string) --

type credentialProviderConfigurations:

list

param credentialProviderConfigurations:

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

• (dict) --

  The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

  • credentialProviderType (string) -- [REQUIRED]

    The type of credential provider. This field specifies which authentication method the gateway uses.

  • credentialProvider (dict) --

    The credential provider. This field contains the specific configuration for the credential provider type.

    • oauthCredentialProvider (dict) --

      The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

      • providerArn (string) -- [REQUIRED]

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

      • scopes (list) -- [REQUIRED]

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

        • (string) --

      • customParameters (dict) --

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

        • (string) --

          • (string) --

      • 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.

      • defaultReturnUrl (string) --

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

    • apiKeyCredentialProvider (dict) --

      The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

      • providerArn (string) -- [REQUIRED]

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

      • credentialParameterName (string) --

        The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

      • credentialPrefix (string) --

        The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

      • credentialLocation (string) --

        The location of the API key credential. This field specifies where in the request the API key should be placed.

    • iamCredentialProvider (dict) --

      The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

      • service (string) -- [REQUIRED]

        The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.

      • region (string) --

        The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.

type metadataConfiguration:

dict

param metadataConfiguration:

Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

• allowedRequestHeaders (list) --

  A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.

  • (string) --

• allowedQueryParameters (list) --

  A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.

  • (string) --

• allowedResponseHeaders (list) --

  A list of HTTP headers that are allowed to be propagated from the target response back to the client.

  • (string) --

type privateEndpoint:

dict

param privateEndpoint:

The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.

• selfManagedLatticeResource (dict) --

  Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

  • resourceConfigurationIdentifier (string) --

    The ARN or ID of the VPC Lattice resource configuration.

• managedLatticeResource (dict) --

  Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

  • vpcIdentifier (string) -- [REQUIRED]

    The ID of the VPC that contains your private resource.

  • subnetIds (list) -- [REQUIRED]

    The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

    • (string) --

  • endpointIpAddressType (string) -- [REQUIRED]

    The IP address type for the resource configuration endpoint.

  • securityGroupIds (list) --

    The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

    • (string) --

  • tags (dict) --

    Tags to apply to the managed VPC Lattice resource gateway.

    • (string) --

      • (string) --

  • routingDomain (string) --

    An intermediate publicly resolvable domain used as the VPC Lattice resource configuration endpoint. Required when your private endpoint uses a domain that is not publicly resolvable.

rtype:

dict

returns:

Response Syntax

{
    'gatewayArn': 'string',
    'targetId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH'|'SYNCHRONIZE_PENDING_AUTH',
    'statusReasons': [
        'string',
    ],
    'name': 'string',
    'description': 'string',
    'targetConfiguration': {
        'mcp': {
            'openApiSchema': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'smithyModel': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'lambda': {
                'lambdaArn': 'string',
                'toolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'inputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            },
                            'outputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            }
                        },
                    ]
                }
            },
            'mcpServer': {
                'endpoint': 'string',
                'mcpToolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': 'string'
                },
                'resourcePriority': 123,
                'listingMode': 'DEFAULT'|'DYNAMIC'
            },
            'apiGateway': {
                'restApiId': 'string',
                'stage': 'string',
                'apiGatewayToolConfiguration': {
                    'toolOverrides': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'path': 'string',
                            'method': 'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST'
                        },
                    ],
                    'toolFilters': [
                        {
                            'filterPath': 'string',
                            'methods': [
                                'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST',
                            ]
                        },
                    ]
                }
            }
        }
    },
    'credentialProviderConfigurations': [
        {
            'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
            'credentialProvider': {
                'oauthCredentialProvider': {
                    'providerArn': 'string',
                    'scopes': [
                        'string',
                    ],
                    'customParameters': {
                        'string': 'string'
                    },
                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                    'defaultReturnUrl': 'string'
                },
                'apiKeyCredentialProvider': {
                    'providerArn': 'string',
                    'credentialParameterName': 'string',
                    'credentialPrefix': 'string',
                    'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
                },
                'iamCredentialProvider': {
                    'service': 'string',
                    'region': 'string'
                }
            }
        },
    ],
    'lastSynchronizedAt': datetime(2015, 1, 1),
    'metadataConfiguration': {
        'allowedRequestHeaders': [
            'string',
        ],
        'allowedQueryParameters': [
            'string',
        ],
        'allowedResponseHeaders': [
            'string',
        ]
    },
    'privateEndpoint': {
        'selfManagedLatticeResource': {
            'resourceConfigurationIdentifier': 'string'
        },
        'managedLatticeResource': {
            'vpcIdentifier': 'string',
            'subnetIds': [
                'string',
            ],
            'endpointIpAddressType': 'IPV4'|'IPV6',
            'securityGroupIds': [
                'string',
            ],
            'tags': {
                'string': 'string'
            },
            'routingDomain': 'string'
        }
    },
    'privateEndpointManagedResources': [
        {
            'domain': 'string',
            'resourceGatewayArn': 'string',
            'resourceAssociationArn': 'string'
        },
    ],
    'authorizationData': {
        'oauth2': {
            'authorizationUrl': 'string',
            'userId': 'string'
        }
    }
}

Response Structure

• (dict) --

  • gatewayArn (string) --

    The Amazon Resource Name (ARN) of the gateway.

  • targetId (string) --

    The unique identifier of the created target.

  • createdAt (datetime) --

    The timestamp when the target was created.

  • updatedAt (datetime) --

    The timestamp when the target was last updated.

  • status (string) --

    The current status of the target.

  • statusReasons (list) --

    The reasons for the current status of the target.

    • (string) --

  • name (string) --

    The name of the target.

  • description (string) --

    The description of the target.

  • targetConfiguration (dict) --

    The configuration settings for the target.

    • mcp (dict) --

      The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.

      • openApiSchema (dict) --

        The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.

        • s3 (dict) --

          The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

          • uri (string) --

            The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

          • bucketOwnerAccountId (string) --

            The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

        • inlinePayload (string) --

          The inline payload containing the API schema definition.

      • smithyModel (dict) --

        The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.

        • s3 (dict) --

          The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

          • uri (string) --

            The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

          • bucketOwnerAccountId (string) --

            The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

        • inlinePayload (string) --

          The inline payload containing the API schema definition.

      • lambda (dict) --

        The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.

        • lambdaArn (string) --

          The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.

        • toolSchema (dict) --

          The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.

          • s3 (dict) --

            The Amazon S3 location of the tool schema. This location contains the schema definition file.

            • uri (string) --

              The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

            • bucketOwnerAccountId (string) --

              The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

          • inlinePayload (list) --

            The inline payload of the tool schema. This payload contains the schema definition directly in the request.

            • (dict) --

              A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

              • name (string) --

                The name of the tool. This name identifies the tool in the Model Context Protocol.

              • description (string) --

                The description of the tool. This description provides information about the purpose and usage of the tool.

              • inputSchema (dict) --

                The input schema for the tool. This schema defines the structure of the input that the tool accepts.

                • type (string) --

                  The type of the schema definition. This field specifies the data type of the schema.

                • properties (dict) --

                  The properties of the schema definition. These properties define the fields in the schema.

                  • (string) --

                    • (dict) --

                      A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

                • required (list) --

                  The required fields in the schema definition. These fields must be provided when using the schema.

                  • (string) --

                • items (dict) --

                  The items in the schema definition. This field is used for array types to define the structure of the array elements.

                • description (string) --

                  The description of the schema definition. This description provides information about the purpose and usage of the schema.

              • outputSchema (dict) --

                The output schema for the tool. This schema defines the structure of the output that the tool produces.

                • type (string) --

                  The type of the schema definition. This field specifies the data type of the schema.

                • properties (dict) --

                  The properties of the schema definition. These properties define the fields in the schema.

                  • (string) --

                    • (dict) --

                      A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

                • required (list) --

                  The required fields in the schema definition. These fields must be provided when using the schema.

                  • (string) --

                • items (dict) --

                  The items in the schema definition. This field is used for array types to define the structure of the array elements.

                • description (string) --

                  The description of the schema definition. This description provides information about the purpose and usage of the schema.

      • mcpServer (dict) --

        The MCP server specified as the gateway target.

        • endpoint (string) --

          The endpoint for the MCP server target configuration.

        • mcpToolSchema (dict) --

          The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.

          • s3 (dict) --

            The Amazon S3 location of the tool schema. This location contains the schema definition file.

            • uri (string) --

              The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

            • bucketOwnerAccountId (string) --

              The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

          • inlinePayload (string) --

            The inline payload containing the MCP tool schema definition.

        • resourcePriority (integer) --

          Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.

        • listingMode (string) --

          The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.

      • apiGateway (dict) --

        The configuration for an Amazon API Gateway target.

        • restApiId (string) --

          The ID of the API Gateway REST API.

        • stage (string) --

          The ID of the stage of the REST API to add as a target.

        • apiGatewayToolConfiguration (dict) --

          The configuration for defining REST API tool filters and overrides for the gateway target.

          • toolOverrides (list) --

            A list of explicit tool definitions with optional custom names and descriptions.

            • (dict) --

              Settings to override configurations for a tool.

              • name (string) --

                The name of tool. Identifies the tool in the Model Context Protocol.

              • description (string) --

                The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

              • path (string) --

                Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

              • method (string) --

                The HTTP method to expose for the specified path.

          • toolFilters (list) --

            A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.

            • (dict) --

              Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

              • filterPath (string) --

                Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

              • methods (list) --

                The methods to filter for.

                • (string) --

  • credentialProviderConfigurations (list) --

    The credential provider configurations for the target.

    • (dict) --

      The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

      • credentialProviderType (string) --

        The type of credential provider. This field specifies which authentication method the gateway uses.

      • credentialProvider (dict) --

        The credential provider. This field contains the specific configuration for the credential provider type.

        • oauthCredentialProvider (dict) --

          The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

          • providerArn (string) --

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

          • scopes (list) --

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

            • (string) --

          • customParameters (dict) --

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

            • (string) --

              • (string) --

          • 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.

          • defaultReturnUrl (string) --

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

        • apiKeyCredentialProvider (dict) --

          The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

          • providerArn (string) --

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

          • credentialParameterName (string) --

            The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

          • credentialPrefix (string) --

            The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

          • credentialLocation (string) --

            The location of the API key credential. This field specifies where in the request the API key should be placed.

        • iamCredentialProvider (dict) --

          The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

          • service (string) --

            The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.

          • region (string) --

            The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.

  • lastSynchronizedAt (datetime) --

    The last synchronization of the target.

  • metadataConfiguration (dict) --

    The metadata configuration that was applied to the created gateway target.

    • allowedRequestHeaders (list) --

      A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.

      • (string) --

    • allowedQueryParameters (list) --

      A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.

      • (string) --

    • allowedResponseHeaders (list) --

      A list of HTTP headers that are allowed to be propagated from the target response back to the client.

      • (string) --

  • privateEndpoint (dict) --

    The private endpoint configuration for the gateway target.

    • selfManagedLatticeResource (dict) --

      Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

      • resourceConfigurationIdentifier (string) --

        The ARN or ID of the VPC Lattice resource configuration.

    • managedLatticeResource (dict) --

      Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

      • vpcIdentifier (string) --

        The ID of the VPC that contains your private resource.

      • subnetIds (list) --

        The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

        • (string) --

      • endpointIpAddressType (string) --

        The IP address type for the resource configuration endpoint.

      • securityGroupIds (list) --

        The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

        • (string) --

      • tags (dict) --

        Tags to apply to the managed VPC Lattice resource gateway.

        • (string) --

          • (string) --

      • routingDomain (string) --

        An intermediate publicly resolvable domain used as the VPC Lattice resource configuration endpoint. Required when your private endpoint uses a domain that is not publicly resolvable.

  • privateEndpointManagedResources (list) --

    The managed resources created by the gateway for private endpoint connectivity.

    • (dict) --

      Details of a resource created and managed by the gateway for private endpoint connectivity.

      • domain (string) --

        The domain associated with this managed resource.

      • resourceGatewayArn (string) --

        The ARN of the VPC Lattice resource gateway created in your account.

      • resourceAssociationArn (string) --

        The ARN of the service network resource association.

  • authorizationData (dict) --

    OAuth2 authorization data for the created gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

    • oauth2 (dict) --

      OAuth2 authorization data for the gateway target.

      • authorizationUrl (string) --

        The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.

      • userId (string) --

        The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.

{'status': {'ERROR'}}

Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.

See also: AWS API Documentation

Request Syntax

client.create_online_evaluation_config(
    clientToken='string',
    onlineEvaluationConfigName='string',
    description='string',
    rule={
        'samplingConfig': {
            'samplingPercentage': 123.0
        },
        'filters': [
            {
                'key': 'string',
                'operator': 'Equals'|'NotEquals'|'GreaterThan'|'LessThan'|'GreaterThanOrEqual'|'LessThanOrEqual'|'Contains'|'NotContains',
                'value': {
                    'stringValue': 'string',
                    'doubleValue': 123.0,
                    'booleanValue': True|False
                }
            },
        ],
        'sessionConfig': {
            'sessionTimeoutMinutes': 123
        }
    },
    dataSourceConfig={
        'cloudWatchLogs': {
            'logGroupNames': [
                'string',
            ],
            'serviceNames': [
                'string',
            ]
        }
    },
    evaluators=[
        {
            'evaluatorId': 'string'
        },
    ],
    evaluationExecutionRoleArn='string',
    enableOnCreate=True|False,
    tags={
        'string': 'string'
    }
)

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

type onlineEvaluationConfigName:

string

param onlineEvaluationConfigName:

[REQUIRED]

The name of the online evaluation configuration. Must be unique within your account.

type description:

string

param description:

The description of the online evaluation configuration that explains its monitoring purpose and scope.

type rule:

dict

param rule:

[REQUIRED]

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

• samplingConfig (dict) -- [REQUIRED]

  The sampling configuration that determines what percentage of agent traces to evaluate.

  • samplingPercentage (float) -- [REQUIRED]

    The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.

• filters (list) --

  The list of filters that determine which agent traces should be included in the evaluation based on trace properties.

  • (dict) --

    The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.

    • key (string) -- [REQUIRED]

      The key or field name to filter on within the agent trace data.

    • operator (string) -- [REQUIRED]

      The comparison operator to use for filtering.

    • value (dict) -- [REQUIRED]

      The value to compare against using the specified operator.

      • stringValue (string) --

        The string value for text-based filtering.

      • doubleValue (float) --

        The numeric value for numerical filtering and comparisons.

      • booleanValue (boolean) --

        The boolean value for true/false filtering conditions.

• sessionConfig (dict) --

  The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.

  • sessionTimeoutMinutes (integer) -- [REQUIRED]

    The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.

type dataSourceConfig:

dict

param dataSourceConfig:

[REQUIRED]

The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

• cloudWatchLogs (dict) --

  The CloudWatch logs configuration for reading agent traces from log groups.

  • logGroupNames (list) -- [REQUIRED]

    The list of CloudWatch log group names to monitor for agent traces.

    • (string) --

  • serviceNames (list) -- [REQUIRED]

    The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.

    • (string) --

type evaluators:

list

param evaluators:

[REQUIRED]

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

• (dict) --

  The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.

  • evaluatorId (string) --

    The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.

type evaluationExecutionRoleArn:

string

param evaluationExecutionRoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation.

type enableOnCreate:

boolean

param enableOnCreate:

[REQUIRED]

Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

type tags:

dict

param tags:

A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'onlineEvaluationConfigArn': 'string',
    'onlineEvaluationConfigId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'outputConfig': {
        'cloudWatchConfig': {
            'logGroupName': 'string'
        }
    },
    'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR',
    'executionStatus': 'ENABLED'|'DISABLED',
    'failureReason': 'string'
}

Response Structure

• (dict) --

  • onlineEvaluationConfigArn (string) --

    The Amazon Resource Name (ARN) of the created online evaluation configuration.

  • onlineEvaluationConfigId (string) --

    The unique identifier of the created online evaluation configuration.

  • createdAt (datetime) --

    The timestamp when the online evaluation configuration was created.

  • outputConfig (dict) --

    The configuration that specifies where evaluation results should be written for monitoring and analysis.

    • cloudWatchConfig (dict) --

      The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.

      • logGroupName (string) --

        The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn't exist.

  • status (string) --

    The status of the online evaluation configuration.

  • executionStatus (string) --

    The execution status indicating whether the online evaluation is currently running.

  • failureReason (string) --

    The reason for failure if the online evaluation configuration creation or execution failed.

{'status': {'ERROR'}}

Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.

See also: AWS API Documentation

Request Syntax

client.delete_online_evaluation_config(
    onlineEvaluationConfigId='string'
)

type onlineEvaluationConfigId:

string

param onlineEvaluationConfigId:

[REQUIRED]

The unique identifier of the online evaluation configuration to delete.

rtype:

dict

returns:

Response Syntax

{
    'onlineEvaluationConfigArn': 'string',
    'onlineEvaluationConfigId': 'string',
    'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR'
}

Response Structure

• (dict) --

  • onlineEvaluationConfigArn (string) --

    The Amazon Resource Name (ARN) of the deleted online evaluation configuration.

  • onlineEvaluationConfigId (string) --

    The unique identifier of the deleted online evaluation configuration.

  • status (string) --

    The status of the online evaluation configuration deletion operation.

{'targetConfiguration': {'mcp': {'mcpServer': {'resourcePriority': 'integer'}}}}

Retrieves information about a specific gateway target.

See also: AWS API Documentation

Request Syntax

client.get_gateway_target(
    gatewayIdentifier='string',
    targetId='string'
)

type gatewayIdentifier:

string

param gatewayIdentifier:

[REQUIRED]

The identifier of the gateway that contains the target.

type targetId:

string

param targetId:

[REQUIRED]

The unique identifier of the target to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'gatewayArn': 'string',
    'targetId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH'|'SYNCHRONIZE_PENDING_AUTH',
    'statusReasons': [
        'string',
    ],
    'name': 'string',
    'description': 'string',
    'targetConfiguration': {
        'mcp': {
            'openApiSchema': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'smithyModel': {
                's3': {
                    'uri': 'string',
                    'bucketOwnerAccountId': 'string'
                },
                'inlinePayload': 'string'
            },
            'lambda': {
                'lambdaArn': 'string',
                'toolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'inputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            },
                            'outputSchema': {
                                'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                'properties': {
                                    'string': {'... recursive ...'}
                                },
                                'required': [
                                    'string',
                                ],
                                'items': {'... recursive ...'},
                                'description': 'string'
                            }
                        },
                    ]
                }
            },
            'mcpServer': {
                'endpoint': 'string',
                'mcpToolSchema': {
                    's3': {
                        'uri': 'string',
                        'bucketOwnerAccountId': 'string'
                    },
                    'inlinePayload': 'string'
                },
                'resourcePriority': 123,
                'listingMode': 'DEFAULT'|'DYNAMIC'
            },
            'apiGateway': {
                'restApiId': 'string',
                'stage': 'string',
                'apiGatewayToolConfiguration': {
                    'toolOverrides': [
                        {
                            'name': 'string',
                            'description': 'string',
                            'path': 'string',
                            'method': 'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST'
                        },
                    ],
                    'toolFilters': [
                        {
                            'filterPath': 'string',
                            'methods': [
                                'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST',
                            ]
                        },
                    ]
                }
            }
        }
    },
    'credentialProviderConfigurations': [
        {
            'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
            'credentialProvider': {
                'oauthCredentialProvider': {
                    'providerArn': 'string',
                    'scopes': [
                        'string',
                    ],
                    'customParameters': {
                        'string': 'string'
                    },
                    'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                    'defaultReturnUrl': 'string'
                },
                'apiKeyCredentialProvider': {
                    'providerArn': 'string',
                    'credentialParameterName': 'string',
                    'credentialPrefix': 'string',
                    'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
                },
                'iamCredentialProvider': {
                    'service': 'string',
                    'region': 'string'
                }
            }
        },
    ],
    'lastSynchronizedAt': datetime(2015, 1, 1),
    'metadataConfiguration': {
        'allowedRequestHeaders': [
            'string',
        ],
        'allowedQueryParameters': [
            'string',
        ],
        'allowedResponseHeaders': [
            'string',
        ]
    },
    'privateEndpoint': {
        'selfManagedLatticeResource': {
            'resourceConfigurationIdentifier': 'string'
        },
        'managedLatticeResource': {
            'vpcIdentifier': 'string',
            'subnetIds': [
                'string',
            ],
            'endpointIpAddressType': 'IPV4'|'IPV6',
            'securityGroupIds': [
                'string',
            ],
            'tags': {
                'string': 'string'
            },
            'routingDomain': 'string'
        }
    },
    'privateEndpointManagedResources': [
        {
            'domain': 'string',
            'resourceGatewayArn': 'string',
            'resourceAssociationArn': 'string'
        },
    ],
    'authorizationData': {
        'oauth2': {
            'authorizationUrl': 'string',
            'userId': 'string'
        }
    }
}

Response Structure

• (dict) --

  • gatewayArn (string) --

    The Amazon Resource Name (ARN) of the gateway.

  • targetId (string) --

    The unique identifier of the gateway target.

  • createdAt (datetime) --

    The timestamp when the gateway target was created.

  • updatedAt (datetime) --

    The timestamp when the gateway target was last updated.

  • status (string) --

    The current status of the gateway target.

  • statusReasons (list) --

    The reasons for the current status of the gateway target.

    • (string) --

  • name (string) --

    The name of the gateway target.

  • description (string) --

    The description of the gateway target.

  • targetConfiguration (dict) --

    The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

    • mcp (dict) --

      The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.

      • openApiSchema (dict) --

        The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.

        • s3 (dict) --

          The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

          • uri (string) --

            The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

          • bucketOwnerAccountId (string) --

            The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

        • inlinePayload (string) --

          The inline payload containing the API schema definition.

      • smithyModel (dict) --

        The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.

        • s3 (dict) --

          The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

          • uri (string) --

            The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

          • bucketOwnerAccountId (string) --

            The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

        • inlinePayload (string) --

          The inline payload containing the API schema definition.

      • lambda (dict) --

        The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.

        • lambdaArn (string) --

          The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.

        • toolSchema (dict) --

          The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.

          • s3 (dict) --

            The Amazon S3 location of the tool schema. This location contains the schema definition file.

            • uri (string) --

              The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

            • bucketOwnerAccountId (string) --

              The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

          • inlinePayload (list) --

            The inline payload of the tool schema. This payload contains the schema definition directly in the request.

            • (dict) --

              A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

              • name (string) --

                The name of the tool. This name identifies the tool in the Model Context Protocol.

              • description (string) --

                The description of the tool. This description provides information about the purpose and usage of the tool.

              • inputSchema (dict) --

                The input schema for the tool. This schema defines the structure of the input that the tool accepts.

                • type (string) --

                  The type of the schema definition. This field specifies the data type of the schema.

                • properties (dict) --

                  The properties of the schema definition. These properties define the fields in the schema.

                  • (string) --

                    • (dict) --

                      A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

                • required (list) --

                  The required fields in the schema definition. These fields must be provided when using the schema.

                  • (string) --

                • items (dict) --

                  The items in the schema definition. This field is used for array types to define the structure of the array elements.

                • description (string) --

                  The description of the schema definition. This description provides information about the purpose and usage of the schema.

              • outputSchema (dict) --

                The output schema for the tool. This schema defines the structure of the output that the tool produces.

                • type (string) --

                  The type of the schema definition. This field specifies the data type of the schema.

                • properties (dict) --

                  The properties of the schema definition. These properties define the fields in the schema.

                  • (string) --

                    • (dict) --

                      A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

                • required (list) --

                  The required fields in the schema definition. These fields must be provided when using the schema.

                  • (string) --

                • items (dict) --

                  The items in the schema definition. This field is used for array types to define the structure of the array elements.

                • description (string) --

                  The description of the schema definition. This description provides information about the purpose and usage of the schema.

      • mcpServer (dict) --

        The MCP server specified as the gateway target.

        • endpoint (string) --

          The endpoint for the MCP server target configuration.

        • mcpToolSchema (dict) --

          The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.

          • s3 (dict) --

            The Amazon S3 location of the tool schema. This location contains the schema definition file.

            • uri (string) --

              The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

            • bucketOwnerAccountId (string) --

              The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

          • inlinePayload (string) --

            The inline payload containing the MCP tool schema definition.

        • resourcePriority (integer) --

          Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.

        • listingMode (string) --

          The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.

      • apiGateway (dict) --

        The configuration for an Amazon API Gateway target.

        • restApiId (string) --

          The ID of the API Gateway REST API.

        • stage (string) --

          The ID of the stage of the REST API to add as a target.

        • apiGatewayToolConfiguration (dict) --

          The configuration for defining REST API tool filters and overrides for the gateway target.

          • toolOverrides (list) --

            A list of explicit tool definitions with optional custom names and descriptions.

            • (dict) --

              Settings to override configurations for a tool.

              • name (string) --

                The name of tool. Identifies the tool in the Model Context Protocol.

              • description (string) --

                The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

              • path (string) --

                Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

              • method (string) --

                The HTTP method to expose for the specified path.

          • toolFilters (list) --

            A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.

            • (dict) --

              Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

              • filterPath (string) --

                Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

              • methods (list) --

                The methods to filter for.

                • (string) --

  • credentialProviderConfigurations (list) --

    The credential provider configurations for the gateway target.

    • (dict) --

      The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

      • credentialProviderType (string) --

        The type of credential provider. This field specifies which authentication method the gateway uses.

      • credentialProvider (dict) --

        The credential provider. This field contains the specific configuration for the credential provider type.

        • oauthCredentialProvider (dict) --

          The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

          • providerArn (string) --

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

          • scopes (list) --

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

            • (string) --

          • customParameters (dict) --

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

            • (string) --

              • (string) --

          • 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.

          • defaultReturnUrl (string) --

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

        • apiKeyCredentialProvider (dict) --

          The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

          • providerArn (string) --

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

          • credentialParameterName (string) --

            The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

          • credentialPrefix (string) --

            The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

          • credentialLocation (string) --

            The location of the API key credential. This field specifies where in the request the API key should be placed.

        • iamCredentialProvider (dict) --

          The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

          • service (string) --

            The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.

          • region (string) --

            The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.

  • lastSynchronizedAt (datetime) --

    The last synchronization of the target.

  • metadataConfiguration (dict) --

    The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.

    • allowedRequestHeaders (list) --

      A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.

      • (string) --

    • allowedQueryParameters (list) --

      A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.

      • (string) --

    • allowedResponseHeaders (list) --

      A list of HTTP headers that are allowed to be propagated from the target response back to the client.

      • (string) --

  • privateEndpoint (dict) --

    The private endpoint configuration for the gateway target.

    • selfManagedLatticeResource (dict) --

      Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

      • resourceConfigurationIdentifier (string) --

        The ARN or ID of the VPC Lattice resource configuration.

    • managedLatticeResource (dict) --

      Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

      • vpcIdentifier (string) --

        The ID of the VPC that contains your private resource.

      • subnetIds (list) --

        The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

        • (string) --

      • endpointIpAddressType (string) --

        The IP address type for the resource configuration endpoint.

      • securityGroupIds (list) --

        The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

        • (string) --

      • tags (dict) --

        Tags to apply to the managed VPC Lattice resource gateway.

        • (string) --

          • (string) --

      • routingDomain (string) --

        An intermediate publicly resolvable domain used as the VPC Lattice resource configuration endpoint. Required when your private endpoint uses a domain that is not publicly resolvable.

  • privateEndpointManagedResources (list) --

    The managed resources created by the gateway for private endpoint connectivity.

    • (dict) --

      Details of a resource created and managed by the gateway for private endpoint connectivity.

      • domain (string) --

        The domain associated with this managed resource.

      • resourceGatewayArn (string) --

        The ARN of the VPC Lattice resource gateway created in your account.

      • resourceAssociationArn (string) --

        The ARN of the service network resource association.

  • authorizationData (dict) --

    OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

    • oauth2 (dict) --

      OAuth2 authorization data for the gateway target.

      • authorizationUrl (string) --

        The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.

      • userId (string) --

        The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.

{'status': {'ERROR'}}

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

See also: AWS API Documentation

Request Syntax

client.get_online_evaluation_config(
    onlineEvaluationConfigId='string'
)

type onlineEvaluationConfigId:

string

param onlineEvaluationConfigId:

[REQUIRED]

The unique identifier of the online evaluation configuration to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'onlineEvaluationConfigArn': 'string',
    'onlineEvaluationConfigId': 'string',
    'onlineEvaluationConfigName': 'string',
    'description': 'string',
    'rule': {
        'samplingConfig': {
            'samplingPercentage': 123.0
        },
        'filters': [
            {
                'key': 'string',
                'operator': 'Equals'|'NotEquals'|'GreaterThan'|'LessThan'|'GreaterThanOrEqual'|'LessThanOrEqual'|'Contains'|'NotContains',
                'value': {
                    'stringValue': 'string',
                    'doubleValue': 123.0,
                    'booleanValue': True|False
                }
            },
        ],
        'sessionConfig': {
            'sessionTimeoutMinutes': 123
        }
    },
    'dataSourceConfig': {
        'cloudWatchLogs': {
            'logGroupNames': [
                'string',
            ],
            'serviceNames': [
                'string',
            ]
        }
    },
    'evaluators': [
        {
            'evaluatorId': 'string'
        },
    ],
    'outputConfig': {
        'cloudWatchConfig': {
            'logGroupName': 'string'
        }
    },
    'evaluationExecutionRoleArn': 'string',
    'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR',
    'executionStatus': 'ENABLED'|'DISABLED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'failureReason': 'string'
}

Response Structure

• (dict) --

  • onlineEvaluationConfigArn (string) --

    The Amazon Resource Name (ARN) of the online evaluation configuration.

  • onlineEvaluationConfigId (string) --

    The unique identifier of the online evaluation configuration.

  • onlineEvaluationConfigName (string) --

    The name of the online evaluation configuration.

  • description (string) --

    The description of the online evaluation configuration.

  • rule (dict) --

    The evaluation rule containing sampling configuration, filters, and session settings.

    • samplingConfig (dict) --

      The sampling configuration that determines what percentage of agent traces to evaluate.

      • samplingPercentage (float) --

        The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.

    • filters (list) --

      The list of filters that determine which agent traces should be included in the evaluation based on trace properties.

      • (dict) --

        The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.

        • key (string) --

          The key or field name to filter on within the agent trace data.

        • operator (string) --

          The comparison operator to use for filtering.

        • value (dict) --

          The value to compare against using the specified operator.

          • stringValue (string) --

            The string value for text-based filtering.

          • doubleValue (float) --

            The numeric value for numerical filtering and comparisons.

          • booleanValue (boolean) --

            The boolean value for true/false filtering conditions.

    • sessionConfig (dict) --

      The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.

      • sessionTimeoutMinutes (integer) --

        The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.

  • dataSourceConfig (dict) --

    The data source configuration specifying CloudWatch log groups and service names to monitor.

    • cloudWatchLogs (dict) --

      The CloudWatch logs configuration for reading agent traces from log groups.

      • logGroupNames (list) --

        The list of CloudWatch log group names to monitor for agent traces.

        • (string) --

      • serviceNames (list) --

        The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.

        • (string) --

  • evaluators (list) --

    The list of evaluators applied during online evaluation.

    • (dict) --

      The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.

      • evaluatorId (string) --

        The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.

  • outputConfig (dict) --

    The output configuration specifying where evaluation results are written.

    • cloudWatchConfig (dict) --

      The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.

      • logGroupName (string) --

        The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn't exist.

  • evaluationExecutionRoleArn (string) --

    The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

  • status (string) --

    The status of the online evaluation configuration.

  • executionStatus (string) --

    The execution status indicating whether the online evaluation is currently running.

  • createdAt (datetime) --

    The timestamp when the online evaluation configuration was created.

  • updatedAt (datetime) --

    The timestamp when the online evaluation configuration was last updated.

  • failureReason (string) --

    The reason for failure if the online evaluation configuration execution failed.

{'items': {'resourcePriority': 'integer'}}

Lists all targets for a specific gateway.

See also: AWS API Documentation

Request Syntax

client.list_gateway_targets(
    gatewayIdentifier='string',
    maxResults=123,
    nextToken='string'
)

type gatewayIdentifier:

string

param gatewayIdentifier:

[REQUIRED]

The identifier of the gateway to list targets for.

type maxResults:

integer

param maxResults:

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

type nextToken:

string

param nextToken:

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'targetId': 'string',
            'name': 'string',
            'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH'|'SYNCHRONIZE_PENDING_AUTH',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'resourcePriority': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    The list of gateway target summaries.

    • (dict) --

      Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.

      • targetId (string) --

        The unique identifier of the target.

      • name (string) --

        The name of the target.

      • status (string) --

        The current status of the target.

      • description (string) --

        The description of the target.

      • createdAt (datetime) --

        The timestamp when the target was created.

      • updatedAt (datetime) --

        The timestamp when the target was last updated.

      • resourcePriority (integer) --

        Priority for resolving resource URI conflicts across targets. Lower values take precedence. Defaults to 1000 when not set.

  • nextToken (string) --

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

{'onlineEvaluationConfigs': {'status': {'ERROR'}}}

Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.

See also: AWS API Documentation

Request Syntax

client.list_online_evaluation_configs(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

The pagination token from a previous request to retrieve the next page of results.

type maxResults:

integer

param maxResults:

The maximum number of online evaluation configurations to return in a single response.

rtype:

dict

returns:

Response Syntax

{
    'onlineEvaluationConfigs': [
        {
            'onlineEvaluationConfigArn': 'string',
            'onlineEvaluationConfigId': 'string',
            'onlineEvaluationConfigName': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR',
            'executionStatus': 'ENABLED'|'DISABLED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'failureReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • onlineEvaluationConfigs (list) --

    The list of online evaluation configuration summaries containing basic information about each configuration.

    • (dict) --

      The summary information about an online evaluation configuration, including basic metadata and execution status.

      • onlineEvaluationConfigArn (string) --

        The Amazon Resource Name (ARN) of the online evaluation configuration.

      • onlineEvaluationConfigId (string) --

        The unique identifier of the online evaluation configuration.

      • onlineEvaluationConfigName (string) --

        The name of the online evaluation configuration.

      • description (string) --

        The description of the online evaluation configuration.

      • status (string) --

        The status of the online evaluation configuration.

      • executionStatus (string) --

        The execution status indicating whether the online evaluation is currently running.

      • createdAt (datetime) --

        The timestamp when the online evaluation configuration was created.

      • updatedAt (datetime) --

        The timestamp when the online evaluation configuration was last updated.

      • failureReason (string) --

        The reason for failure if the online evaluation configuration execution failed.

  • nextToken (string) --

    The pagination token to use in a subsequent request to retrieve the next page of results.

{'targets': {'targetConfiguration': {'mcp': {'mcpServer': {'resourcePriority': 'integer'}}}}}

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

You cannot synchronize a target that is in a pending authorization state ( CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.

You cannot synchronize a target that has a static tool schema ( mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.

See also: AWS API Documentation

Request Syntax

client.synchronize_gateway_targets(
    gatewayIdentifier='string',
    targetIdList=[
        'string',
    ]
)

type gatewayIdentifier:

string

param gatewayIdentifier:

[REQUIRED]

The gateway Identifier.

type targetIdList:

list

param targetIdList:

[REQUIRED]

The target ID list.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'targets': [
        {
            'gatewayArn': 'string',
            'targetId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL'|'CREATE_PENDING_AUTH'|'UPDATE_PENDING_AUTH'|'SYNCHRONIZE_PENDING_AUTH',
            'statusReasons': [
                'string',
            ],
            'name': 'string',
            'description': 'string',
            'targetConfiguration': {
                'mcp': {
                    'openApiSchema': {
                        's3': {
                            'uri': 'string',
                            'bucketOwnerAccountId': 'string'
                        },
                        'inlinePayload': 'string'
                    },
                    'smithyModel': {
                        's3': {
                            'uri': 'string',
                            'bucketOwnerAccountId': 'string'
                        },
                        'inlinePayload': 'string'
                    },
                    'lambda': {
                        'lambdaArn': 'string',
                        'toolSchema': {
                            's3': {
                                'uri': 'string',
                                'bucketOwnerAccountId': 'string'
                            },
                            'inlinePayload': [
                                {
                                    'name': 'string',
                                    'description': 'string',
                                    'inputSchema': {
                                        'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                        'properties': {
                                            'string': {'... recursive ...'}
                                        },
                                        'required': [
                                            'string',
                                        ],
                                        'items': {'... recursive ...'},
                                        'description': 'string'
                                    },
                                    'outputSchema': {
                                        'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
                                        'properties': {
                                            'string': {'... recursive ...'}
                                        },
                                        'required': [
                                            'string',
                                        ],
                                        'items': {'... recursive ...'},
                                        'description': 'string'
                                    }
                                },
                            ]
                        }
                    },
                    'mcpServer': {
                        'endpoint': 'string',
                        'mcpToolSchema': {
                            's3': {
                                'uri': 'string',
                                'bucketOwnerAccountId': 'string'
                            },
                            'inlinePayload': 'string'
                        },
                        'resourcePriority': 123,
                        'listingMode': 'DEFAULT'|'DYNAMIC'
                    },
                    'apiGateway': {
                        'restApiId': 'string',
                        'stage': 'string',
                        'apiGatewayToolConfiguration': {
                            'toolOverrides': [
                                {
                                    'name': 'string',
                                    'description': 'string',
                                    'path': 'string',
                                    'method': 'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST'
                                },
                            ],
                            'toolFilters': [
                                {
                                    'filterPath': 'string',
                                    'methods': [
                                        'GET'|'DELETE'|'HEAD'|'OPTIONS'|'PATCH'|'PUT'|'POST',
                                    ]
                                },
                            ]
                        }
                    }
                }
            },
            'credentialProviderConfigurations': [
                {
                    'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
                    'credentialProvider': {
                        'oauthCredentialProvider': {
                            'providerArn': 'string',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            },
                            'grantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE',
                            'defaultReturnUrl': 'string'
                        },
                        'apiKeyCredentialProvider': {
                            'providerArn': 'string',
                            'credentialParameterName': 'string',
                            'credentialPrefix': 'string',
                            'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
                        },
                        'iamCredentialProvider': {
                            'service': 'string',
                            'region': 'string'
                        }
                    }
                },
            ],
            'lastSynchronizedAt': datetime(2015, 1, 1),
            'metadataConfiguration': {
                'allowedRequestHeaders': [
                    'string',
                ],
                'allowedQueryParameters': [
                    'string',
                ],
                'allowedResponseHeaders': [
                    'string',
                ]
            },
            'privateEndpoint': {
                'selfManagedLatticeResource': {
                    'resourceConfigurationIdentifier': 'string'
                },
                'managedLatticeResource': {
                    'vpcIdentifier': 'string',
                    'subnetIds': [
                        'string',
                    ],
                    'endpointIpAddressType': 'IPV4'|'IPV6',
                    'securityGroupIds': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    },
                    'routingDomain': 'string'
                }
            },
            'privateEndpointManagedResources': [
                {
                    'domain': 'string',
                    'resourceGatewayArn': 'string',
                    'resourceAssociationArn': 'string'
                },
            ],
            'authorizationData': {
                'oauth2': {
                    'authorizationUrl': 'string',
                    'userId': 'string'
                }
            }
        },
    ]
}

Response Structure

• (dict) --

  • targets (list) --

    The gateway targets for synchronization.

    • (dict) --

      The gateway target.

      • gatewayArn (string) --

        The Amazon Resource Name (ARN) of the gateway target.

      • targetId (string) --

        The target ID.

      • createdAt (datetime) --

        The date and time at which the target was created.

      • updatedAt (datetime) --

        The date and time at which the target was updated.

      • status (string) --

        The status of the gateway target.

      • statusReasons (list) --

        The status reasons for the target status.

        • (string) --

      • name (string) --

        The name of the gateway target.

      • description (string) --

        The description for the gateway target.

      • targetConfiguration (dict) --

        The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

        • mcp (dict) --

          The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.

          • openApiSchema (dict) --

            The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.

            • s3 (dict) --

              The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

              • uri (string) --

                The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

              • bucketOwnerAccountId (string) --

                The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

            • inlinePayload (string) --

              The inline payload containing the API schema definition.

          • smithyModel (dict) --

            The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.

            • s3 (dict) --

              The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

              • uri (string) --

                The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

              • bucketOwnerAccountId (string) --

                The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

            • inlinePayload (string) --

              The inline payload containing the API schema definition.

          • lambda (dict) --

            The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.

            • lambdaArn (string) --

              The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.

            • toolSchema (dict) --

              The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.

              • s3 (dict) --

                The Amazon S3 location of the tool schema. This location contains the schema definition file.

                • uri (string) --

                  The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

                • bucketOwnerAccountId (string) --

                  The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

              • inlinePayload (list) --

                The inline payload of the tool schema. This payload contains the schema definition directly in the request.

                • (dict) --

                  A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

                  • name (string) --

                    The name of the tool. This name identifies the tool in the Model Context Protocol.

                  • description (string) --

                    The description of the tool. This description provides information about the purpose and usage of the tool.

                  • inputSchema (dict) --

                    The input schema for the tool. This schema defines the structure of the input that the tool accepts.

                    • type (string) --

                      The type of the schema definition. This field specifies the data type of the schema.

                    • properties (dict) --

                      The properties of the schema definition. These properties define the fields in the schema.

                      • (string) --

                        • (dict) --

                          A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

                    • required (list) --

                      The required fields in the schema definition. These fields must be provided when using the schema.

                      • (string) --

                    • items (dict) --

                      The items in the schema definition. This field is used for array types to define the structure of the array elements.

                    • description (string) --

                      The description of the schema definition. This description provides information about the purpose and usage of the schema.

                  • outputSchema (dict) --

                    The output schema for the tool. This schema defines the structure of the output that the tool produces.

                    • type (string) --

                      The type of the schema definition. This field specifies the data type of the schema.

                    • properties (dict) --

                      The properties of the schema definition. These properties define the fields in the schema.

                      • (string) --

                        • (dict) --

                          A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

                    • required (list) --

                      The required fields in the schema definition. These fields must be provided when using the schema.

                      • (string) --

                    • items (dict) --

                      The items in the schema definition. This field is used for array types to define the structure of the array elements.

                    • description (string) --

                      The description of the schema definition. This description provides information about the purpose and usage of the schema.

          • mcpServer (dict) --

            The MCP server specified as the gateway target.

            • endpoint (string) --

              The endpoint for the MCP server target configuration.

            • mcpToolSchema (dict) --

              The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.

              • s3 (dict) --

                The Amazon S3 location of the tool schema. This location contains the schema definition file.

                • uri (string) --

                  The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

                • bucketOwnerAccountId (string) --

                  The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

              • inlinePayload (string) --

                The inline payload containing the MCP tool schema definition.

            • resourcePriority (integer) --

              Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.

            • listingMode (string) --

              The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.

          • apiGateway (dict) --

            The configuration for an Amazon API Gateway target.

            • restApiId (string) --

              The ID of the API Gateway REST API.

            • stage (string) --

              The ID of the stage of the REST API to add as a target.

            • apiGatewayToolConfiguration (dict) --

              The configuration for defining REST API tool filters and overrides for the gateway target.

              • toolOverrides (list) --

                A list of explicit tool definitions with optional custom names and descriptions.

                • (dict) --

                  Settings to override configurations for a tool.

                  • name (string) --

                    The name of tool. Identifies the tool in the Model Context Protocol.

                  • description (string) --

                    The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

                  • path (string) --

                    Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

                  • method (string) --

                    The HTTP method to expose for the specified path.

              • toolFilters (list) --

                A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.

                • (dict) --

                  Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

                  • filterPath (string) --

                    Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

                  • methods (list) --

                    The methods to filter for.

                    • (string) --

      • credentialProviderConfigurations (list) --

        The provider configurations.

        • (dict) --

          The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

          • credentialProviderType (string) --

            The type of credential provider. This field specifies which authentication method the gateway uses.

          • credentialProvider (dict) --

            The credential provider. This field contains the specific configuration for the credential provider type.

            • oauthCredentialProvider (dict) --

              The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

              • providerArn (string) --

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

              • scopes (list) --

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

                • (string) --

              • customParameters (dict) --

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

                • (string) --

                  • (string) --

              • 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.

              • defaultReturnUrl (string) --

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

            • apiKeyCredentialProvider (dict) --

              The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

              • providerArn (string) --

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

              • credentialParameterName (string) --

                The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

              • credentialPrefix (string) --

                The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

              • credentialLocation (string) --

                The location of the API key credential. This field specifies where in the request the API key should be placed.

            • iamCredentialProvider (dict) --

              The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

              • service (string) --

                The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.

              • region (string) --

                The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.

      • lastSynchronizedAt (datetime) --

        The last synchronization time.

      • metadataConfiguration (dict) --

        The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

        • allowedRequestHeaders (list) --

          A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.

          • (string) --

        • allowedQueryParameters (list) --

          A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.

          • (string) --

        • allowedResponseHeaders (list) --

          A list of HTTP headers that are allowed to be propagated from the target response back to the client.

          • (string) --

      • privateEndpoint (dict) --

        The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

        • selfManagedLatticeResource (dict) --

          Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

          • resourceConfigurationIdentifier (string) --

            The ARN or ID of the VPC Lattice resource configuration.

        • managedLatticeResource (dict) --

          Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

          • vpcIdentifier (string) --

            The ID of the VPC that contains your private resource.

          • subnetIds (list) --

            The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

            • (string) --

          • endpointIpAddressType (string) --

            The IP address type for the resource configuration endpoint.

          • securityGroupIds (list) --

            The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

            • (string) --

          • tags (dict) --

            Tags to apply to the managed VPC Lattice resource gateway.

            • (string) --

              • (string) --

          • routingDomain (string) --

            An intermediate publicly resolvable domain used as the VPC Lattice resource configuration endpoint. Required when your private endpoint uses a domain that is not publicly resolvable.

      • privateEndpointManagedResources (list) --

        A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

        • (dict) --

          Details of a resource created and managed by the gateway for private endpoint connectivity.

          • domain (string) --

            The domain associated with this managed resource.

          • resourceGatewayArn (string) --

            The ARN of the VPC Lattice resource gateway created in your account.

          • resourceAssociationArn (string) --

            The ARN of the service network resource association.

      • authorizationData (dict) --

        OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

        • oauth2 (dict) --

          OAuth2 authorization data for the gateway target.

          • authorizationUrl (string) --

            The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.

          • userId (string) --

            The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.