CreateAgentRuntime

$result = $client->createAgentRuntime([/* ... */]);
$promise = $client->createAgentRuntimeAsync([/* ... */]);

Creates an Amazon Bedrock AgentCore Runtime.

Parameter Syntax

$result = $client->createAgentRuntime([
    'agentRuntimeArtifact' => [ // REQUIRED
        'codeConfiguration' => [
            'code' => [ // REQUIRED
                's3' => [
                    'bucket' => '<string>', // REQUIRED
                    'prefix' => '<string>', // REQUIRED
                    'versionId' => '<string>',
                ],
            ],
            'entryPoint' => ['<string>', ...], // REQUIRED
            'runtime' => 'PYTHON_3_10|PYTHON_3_11|PYTHON_3_12|PYTHON_3_13', // REQUIRED
        ],
        'containerConfiguration' => [
            'containerUri' => '<string>', // REQUIRED
        ],
    ],
    'agentRuntimeName' => '<string>', // REQUIRED
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'allowedScopes' => ['<string>', ...],
            'customClaims' => [
                [
                    'authorizingClaimMatchValue' => [ // REQUIRED
                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                        'claimMatchValue' => [ // REQUIRED
                            'matchValueString' => '<string>',
                            'matchValueStringList' => ['<string>', ...],
                        ],
                    ],
                    'inboundTokenClaimName' => '<string>', // REQUIRED
                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                ],
                // ...
            ],
            'discoveryUrl' => '<string>', // REQUIRED
        ],
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'environmentVariables' => ['<string>', ...],
    'lifecycleConfiguration' => [
        'idleRuntimeSessionTimeout' => <integer>,
        'maxLifetime' => <integer>,
    ],
    'networkConfiguration' => [ // REQUIRED
        'networkMode' => 'PUBLIC|VPC', // REQUIRED
        'networkModeConfig' => [
            'securityGroups' => ['<string>', ...], // REQUIRED
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'protocolConfiguration' => [
        'serverProtocol' => 'MCP|HTTP|A2A', // REQUIRED
    ],
    'requestHeaderConfiguration' => [
        'requestHeaderAllowlist' => ['<string>', ...],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeId' => '<string>',
    'agentRuntimeVersion' => '<string>',
    'createdAt' => <DateTime>,
    'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
    'workloadIdentityDetails' => [
        'workloadIdentityArn' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateAgentRuntimeEndpoint

$result = $client->createAgentRuntimeEndpoint([/* ... */]);
$promise = $client->createAgentRuntimeEndpointAsync([/* ... */]);

Creates an AgentCore Runtime endpoint.

Parameter Syntax

$result = $client->createAgentRuntimeEndpoint([
    'agentRuntimeId' => '<string>', // REQUIRED
    'agentRuntimeVersion' => '<string>',
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeEndpointArn' => '<string>',
    'agentRuntimeId' => '<string>',
    'createdAt' => <DateTime>,
    'endpointName' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
    'targetVersion' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateApiKeyCredentialProvider

$result = $client->createApiKeyCredentialProvider([/* ... */]);
$promise = $client->createApiKeyCredentialProviderAsync([/* ... */]);

Creates a new API key credential provider.

Parameter Syntax

$result = $client->createApiKeyCredentialProvider([
    'apiKey' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'apiKeySecretArn' => [
        'secretArn' => '<string>',
    ],
    'credentialProviderArn' => '<string>',
    'name' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ResourceLimitExceededException:

Exception thrown when a resource limit is exceeded.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ConflictException:

This exception is thrown when there is a conflict performing an operation

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

DecryptionFailure:

Exception thrown when decryption of a secret fails.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

EncryptionFailure:

Exception thrown when encryption of a secret fails.

CreateBrowser

$result = $client->createBrowser([/* ... */]);
$promise = $client->createBrowserAsync([/* ... */]);

Creates a custom browser.

Parameter Syntax

$result = $client->createBrowser([
    'browserSigning' => [
        'enabled' => true || false, // REQUIRED
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'networkConfiguration' => [ // REQUIRED
        'networkMode' => 'PUBLIC|VPC', // REQUIRED
        'vpcConfig' => [
            'securityGroups' => ['<string>', ...], // REQUIRED
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'recording' => [
        'enabled' => true || false,
        's3Location' => [
            'bucket' => '<string>', // REQUIRED
            'prefix' => '<string>', // REQUIRED
            'versionId' => '<string>',
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'browserArn' => '<string>',
    'browserId' => '<string>',
    'createdAt' => <DateTime>,
    'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateCodeInterpreter

$result = $client->createCodeInterpreter([/* ... */]);
$promise = $client->createCodeInterpreterAsync([/* ... */]);

Creates a custom code interpreter.

Parameter Syntax

$result = $client->createCodeInterpreter([
    'clientToken' => '<string>',
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'networkConfiguration' => [ // REQUIRED
        'networkMode' => 'PUBLIC|SANDBOX|VPC', // REQUIRED
        'vpcConfig' => [
            'securityGroups' => ['<string>', ...], // REQUIRED
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'codeInterpreterArn' => '<string>',
    'codeInterpreterId' => '<string>',
    'createdAt' => <DateTime>,
    'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateEvaluator

$result = $client->createEvaluator([/* ... */]);
$promise = $client->createEvaluatorAsync([/* ... */]);

Creates a custom evaluator for agent quality assessment. Custom evaluators use LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings to evaluate agent performance at tool call, trace, or session levels.

Parameter Syntax

$result = $client->createEvaluator([
    'clientToken' => '<string>',
    'description' => '<string>',
    'evaluatorConfig' => [ // REQUIRED
        'llmAsAJudge' => [
            'instructions' => '<string>', // REQUIRED
            'modelConfig' => [ // REQUIRED
                'bedrockEvaluatorModelConfig' => [
                    'additionalModelRequestFields' => [
                    ],
                    'inferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                    'modelId' => '<string>', // REQUIRED
                ],
            ],
            'ratingScale' => [ // REQUIRED
                'categorical' => [
                    [
                        'definition' => '<string>', // REQUIRED
                        'label' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'numerical' => [
                    [
                        'definition' => '<string>', // REQUIRED
                        'label' => '<string>', // REQUIRED
                        'value' => <float>, // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'evaluatorName' => '<string>', // REQUIRED
    'level' => 'TOOL_CALL|TRACE|SESSION', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'evaluatorArn' => '<string>',
    'evaluatorId' => '<string>',
    'status' => 'ACTIVE|CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateGateway

$result = $client->createGateway([/* ... */]);
$promise = $client->createGatewayAsync([/* ... */]);

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

Parameter Syntax

$result = $client->createGateway([
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'allowedScopes' => ['<string>', ...],
            'customClaims' => [
                [
                    'authorizingClaimMatchValue' => [ // REQUIRED
                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY', // REQUIRED
                        'claimMatchValue' => [ // REQUIRED
                            'matchValueString' => '<string>',
                            'matchValueStringList' => ['<string>', ...],
                        ],
                    ],
                    'inboundTokenClaimName' => '<string>', // REQUIRED
                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY', // REQUIRED
                ],
                // ...
            ],
            'discoveryUrl' => '<string>', // REQUIRED
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT|AWS_IAM|NONE', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'interceptorConfigurations' => [
        [
            'inputConfiguration' => [
                'passRequestHeaders' => true || false, // REQUIRED
            ],
            'interceptionPoints' => ['<string>', ...], // REQUIRED
            'interceptor' => [ // REQUIRED
                'lambda' => [
                    'arn' => '<string>', // REQUIRED
                ],
            ],
        ],
        // ...
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'policyEngineConfiguration' => [
        'arn' => '<string>', // REQUIRED
        'mode' => 'LOG_ONLY|ENFORCE', // REQUIRED
    ],
    'protocolConfiguration' => [
        'mcp' => [
            'instructions' => '<string>',
            'searchType' => 'SEMANTIC',
            'supportedVersions' => ['<string>', ...],
        ],
    ],
    'protocolType' => 'MCP', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'allowedScopes' => ['<string>', ...],
            'customClaims' => [
                [
                    'authorizingClaimMatchValue' => [
                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                        'claimMatchValue' => [
                            'matchValueString' => '<string>',
                            'matchValueStringList' => ['<string>', ...],
                        ],
                    ],
                    'inboundTokenClaimName' => '<string>',
                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                ],
                // ...
            ],
            'discoveryUrl' => '<string>',
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT|AWS_IAM|NONE',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'gatewayArn' => '<string>',
    'gatewayId' => '<string>',
    'gatewayUrl' => '<string>',
    'interceptorConfigurations' => [
        [
            'inputConfiguration' => [
                'passRequestHeaders' => true || false,
            ],
            'interceptionPoints' => ['<string>', ...],
            'interceptor' => [
                'lambda' => [
                    'arn' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'policyEngineConfiguration' => [
        'arn' => '<string>',
        'mode' => 'LOG_ONLY|ENFORCE',
    ],
    'protocolConfiguration' => [
        'mcp' => [
            'instructions' => '<string>',
            'searchType' => 'SEMANTIC',
            'supportedVersions' => ['<string>', ...],
        ],
    ],
    'protocolType' => 'MCP',
    'roleArn' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
    'statusReasons' => ['<string>', ...],
    'updatedAt' => <DateTime>,
    'workloadIdentityDetails' => [
        'workloadIdentityArn' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateGatewayTarget

$result = $client->createGatewayTarget([/* ... */]);
$promise = $client->createGatewayTargetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createGatewayTarget([
    'clientToken' => '<string>',
    'credentialProviderConfigurations' => [
        [
            'credentialProvider' => [
                'apiKeyCredentialProvider' => [
                    'credentialLocation' => 'HEADER|QUERY_PARAMETER',
                    'credentialParameterName' => '<string>',
                    'credentialPrefix' => '<string>',
                    'providerArn' => '<string>', // REQUIRED
                ],
                'oauthCredentialProvider' => [
                    'customParameters' => ['<string>', ...],
                    'defaultReturnUrl' => '<string>',
                    'grantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE',
                    'providerArn' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...], // REQUIRED
                ],
            ],
            'credentialProviderType' => 'GATEWAY_IAM_ROLE|OAUTH|API_KEY', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'gatewayIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'targetConfiguration' => [ // REQUIRED
        'mcp' => [
            'apiGateway' => [
                'apiGatewayToolConfiguration' => [ // REQUIRED
                    'toolFilters' => [ // REQUIRED
                        [
                            'filterPath' => '<string>', // REQUIRED
                            'methods' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                    'toolOverrides' => [
                        [
                            'description' => '<string>',
                            'method' => 'GET|DELETE|HEAD|OPTIONS|PATCH|PUT|POST', // REQUIRED
                            'name' => '<string>', // REQUIRED
                            'path' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'restApiId' => '<string>', // REQUIRED
                'stage' => '<string>', // REQUIRED
            ],
            'lambda' => [
                'lambdaArn' => '<string>', // REQUIRED
                'toolSchema' => [ // REQUIRED
                    'inlinePayload' => [
                        [
                            'description' => '<string>', // REQUIRED
                            'inputSchema' => [ // REQUIRED
                                'description' => '<string>',
                                'items' => [...], // RECURSIVE
                                'properties' => [
                                    '<String>' => [...], // RECURSIVE
                                    // ...
                                ],
                                'required' => ['<string>', ...],
                                'type' => 'string|number|object|array|boolean|integer', // REQUIRED
                            ],
                            'name' => '<string>', // REQUIRED
                            'outputSchema' => [
                                'description' => '<string>',
                                'items' => [...], // RECURSIVE
                                'properties' => [
                                    '<String>' => [...], // RECURSIVE
                                    // ...
                                ],
                                'required' => ['<string>', ...],
                                'type' => 'string|number|object|array|boolean|integer', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    's3' => [
                        'bucketOwnerAccountId' => '<string>',
                        'uri' => '<string>',
                    ],
                ],
            ],
            'mcpServer' => [
                'endpoint' => '<string>', // REQUIRED
            ],
            'openApiSchema' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
            'smithyModel' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'credentialProviderConfigurations' => [
        [
            'credentialProvider' => [
                'apiKeyCredentialProvider' => [
                    'credentialLocation' => 'HEADER|QUERY_PARAMETER',
                    'credentialParameterName' => '<string>',
                    'credentialPrefix' => '<string>',
                    'providerArn' => '<string>',
                ],
                'oauthCredentialProvider' => [
                    'customParameters' => ['<string>', ...],
                    'defaultReturnUrl' => '<string>',
                    'grantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE',
                    'providerArn' => '<string>',
                    'scopes' => ['<string>', ...],
                ],
            ],
            'credentialProviderType' => 'GATEWAY_IAM_ROLE|OAUTH|API_KEY',
        ],
        // ...
    ],
    'description' => '<string>',
    'gatewayArn' => '<string>',
    'lastSynchronizedAt' => <DateTime>,
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED|SYNCHRONIZING|SYNCHRONIZE_UNSUCCESSFUL',
    'statusReasons' => ['<string>', ...],
    'targetConfiguration' => [
        'mcp' => [
            'apiGateway' => [
                'apiGatewayToolConfiguration' => [
                    'toolFilters' => [
                        [
                            'filterPath' => '<string>',
                            'methods' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'toolOverrides' => [
                        [
                            'description' => '<string>',
                            'method' => 'GET|DELETE|HEAD|OPTIONS|PATCH|PUT|POST',
                            'name' => '<string>',
                            'path' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'restApiId' => '<string>',
                'stage' => '<string>',
            ],
            'lambda' => [
                'lambdaArn' => '<string>',
                'toolSchema' => [
                    'inlinePayload' => [
                        [
                            'description' => '<string>',
                            'inputSchema' => [
                                'description' => '<string>',
                                'items' => [...], // RECURSIVE
                                'properties' => [
                                    '<String>' => [...], // RECURSIVE
                                    // ...
                                ],
                                'required' => ['<string>', ...],
                                'type' => 'string|number|object|array|boolean|integer',
                            ],
                            'name' => '<string>',
                            'outputSchema' => [
                                'description' => '<string>',
                                'items' => [...], // RECURSIVE
                                'properties' => [
                                    '<String>' => [...], // RECURSIVE
                                    // ...
                                ],
                                'required' => ['<string>', ...],
                                'type' => 'string|number|object|array|boolean|integer',
                            ],
                        ],
                        // ...
                    ],
                    's3' => [
                        'bucketOwnerAccountId' => '<string>',
                        'uri' => '<string>',
                    ],
                ],
            ],
            'mcpServer' => [
                'endpoint' => '<string>',
            ],
            'openApiSchema' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
            'smithyModel' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
        ],
    ],
    'targetId' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateMemory

$result = $client->createMemory([/* ... */]);
$promise = $client->createMemoryAsync([/* ... */]);

Creates a new Amazon Bedrock AgentCore Memory resource.

Parameter Syntax

$result = $client->createMemory([
    'clientToken' => '<string>',
    'description' => '<string>',
    'encryptionKeyArn' => '<string>',
    'eventExpiryDuration' => <integer>, // REQUIRED
    'memoryExecutionRoleArn' => '<string>',
    'memoryStrategies' => [
        [
            'customMemoryStrategy' => [
                'configuration' => [
                    'episodicOverride' => [
                        'consolidation' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                        'extraction' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                        'reflection' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                            'namespaces' => ['<string>', ...],
                        ],
                    ],
                    'selfManagedConfiguration' => [
                        'historicalContextWindowSize' => <integer>,
                        'invocationConfiguration' => [ // REQUIRED
                            'payloadDeliveryBucketName' => '<string>', // REQUIRED
                            'topicArn' => '<string>', // REQUIRED
                        ],
                        'triggerConditions' => [
                            [
                                'messageBasedTrigger' => [
                                    'messageCount' => <integer>,
                                ],
                                'timeBasedTrigger' => [
                                    'idleSessionTimeout' => <integer>,
                                ],
                                'tokenBasedTrigger' => [
                                    'tokenCount' => <integer>,
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'semanticOverride' => [
                        'consolidation' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                        'extraction' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                    ],
                    'summaryOverride' => [
                        'consolidation' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                    ],
                    'userPreferenceOverride' => [
                        'consolidation' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                        'extraction' => [
                            'appendToPrompt' => '<string>', // REQUIRED
                            'modelId' => '<string>', // REQUIRED
                        ],
                    ],
                ],
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'namespaces' => ['<string>', ...],
            ],
            'episodicMemoryStrategy' => [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'namespaces' => ['<string>', ...],
                'reflectionConfiguration' => [
                    'namespaces' => ['<string>', ...], // REQUIRED
                ],
            ],
            'semanticMemoryStrategy' => [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'namespaces' => ['<string>', ...],
            ],
            'summaryMemoryStrategy' => [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'namespaces' => ['<string>', ...],
            ],
            'userPreferenceMemoryStrategy' => [
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'namespaces' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'memory' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'encryptionKeyArn' => '<string>',
        'eventExpiryDuration' => <integer>,
        'failureReason' => '<string>',
        'id' => '<string>',
        'memoryExecutionRoleArn' => '<string>',
        'name' => '<string>',
        'status' => 'CREATING|ACTIVE|FAILED|DELETING',
        'strategies' => [
            [
                'configuration' => [
                    'consolidation' => [
                        'customConsolidationConfiguration' => [
                            'episodicConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'semanticConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'summaryConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'extraction' => [
                        'customExtractionConfiguration' => [
                            'episodicExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'semanticExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'reflection' => [
                        'customReflectionConfiguration' => [
                            'episodicReflectionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                                'namespaces' => ['<string>', ...],
                            ],
                        ],
                        'episodicReflectionConfiguration' => [
                            'namespaces' => ['<string>', ...],
                        ],
                    ],
                    'selfManagedConfiguration' => [
                        'historicalContextWindowSize' => <integer>,
                        'invocationConfiguration' => [
                            'payloadDeliveryBucketName' => '<string>',
                            'topicArn' => '<string>',
                        ],
                        'triggerConditions' => [
                            [
                                'messageBasedTrigger' => [
                                    'messageCount' => <integer>,
                                ],
                                'timeBasedTrigger' => [
                                    'idleSessionTimeout' => <integer>,
                                ],
                                'tokenBasedTrigger' => [
                                    'tokenCount' => <integer>,
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'type' => 'SEMANTIC_OVERRIDE|SUMMARY_OVERRIDE|USER_PREFERENCE_OVERRIDE|SELF_MANAGED|EPISODIC_OVERRIDE',
                ],
                'createdAt' => <DateTime>,
                'description' => '<string>',
                'name' => '<string>',
                'namespaces' => ['<string>', ...],
                'status' => 'CREATING|ACTIVE|DELETING|FAILED',
                'strategyId' => '<string>',
                'type' => 'SEMANTIC|SUMMARIZATION|USER_PREFERENCE|CUSTOM|EPISODIC',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ServiceException:

An internal error occurred.

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottledException:

API rate limit has been exceeded.

CreateOauth2CredentialProvider

$result = $client->createOauth2CredentialProvider([/* ... */]);
$promise = $client->createOauth2CredentialProviderAsync([/* ... */]);

Creates a new OAuth2 credential provider.

Parameter Syntax

$result = $client->createOauth2CredentialProvider([
    'credentialProviderVendor' => 'GoogleOauth2|GithubOauth2|SlackOauth2|SalesforceOauth2|MicrosoftOauth2|CustomOauth2|AtlassianOauth2|LinkedinOauth2|XOauth2|OktaOauth2|OneLoginOauth2|PingOneOauth2|FacebookOauth2|YandexOauth2|RedditOauth2|ZoomOauth2|TwitchOauth2|SpotifyOauth2|DropboxOauth2|NotionOauth2|HubspotOauth2|CyberArkOauth2|FusionAuthOauth2|Auth0Oauth2|CognitoOauth2', // REQUIRED
    'name' => '<string>', // REQUIRED
    'oauth2ProviderConfigInput' => [ // REQUIRED
        'atlassianOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'customOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
            'oauthDiscovery' => [ // REQUIRED
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>', // REQUIRED
                    'issuer' => '<string>', // REQUIRED
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>', // REQUIRED
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'githubOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'googleOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'includedOauth2ProviderConfig' => [
            'authorizationEndpoint' => '<string>',
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
            'issuer' => '<string>',
            'tokenEndpoint' => '<string>',
        ],
        'linkedinOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'microsoftOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
            'tenantId' => '<string>',
        ],
        'salesforceOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'slackOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'callbackUrl' => '<string>',
    'clientSecretArn' => [
        'secretArn' => '<string>',
    ],
    'credentialProviderArn' => '<string>',
    'name' => '<string>',
    'oauth2ProviderConfigOutput' => [
        'atlassianOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'customOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'githubOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'googleOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'includedOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'linkedinOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'microsoftOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'salesforceOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'slackOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ResourceLimitExceededException:

Exception thrown when a resource limit is exceeded.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ConflictException:

This exception is thrown when there is a conflict performing an operation

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

DecryptionFailure:

Exception thrown when decryption of a secret fails.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

EncryptionFailure:

Exception thrown when encryption of a secret fails.

CreateOnlineEvaluationConfig

$result = $client->createOnlineEvaluationConfig([/* ... */]);
$promise = $client->createOnlineEvaluationConfigAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createOnlineEvaluationConfig([
    'clientToken' => '<string>',
    'dataSourceConfig' => [ // REQUIRED
        'cloudWatchLogs' => [
            'logGroupNames' => ['<string>', ...], // REQUIRED
            'serviceNames' => ['<string>', ...], // REQUIRED
        ],
    ],
    'description' => '<string>',
    'enableOnCreate' => true || false, // REQUIRED
    'evaluationExecutionRoleArn' => '<string>', // REQUIRED
    'evaluators' => [ // REQUIRED
        [
            'evaluatorId' => '<string>',
        ],
        // ...
    ],
    'onlineEvaluationConfigName' => '<string>', // REQUIRED
    'rule' => [ // REQUIRED
        'filters' => [
            [
                'key' => '<string>', // REQUIRED
                'operator' => 'Equals|NotEquals|GreaterThan|LessThan|GreaterThanOrEqual|LessThanOrEqual|Contains|NotContains', // REQUIRED
                'value' => [ // REQUIRED
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
        'samplingConfig' => [ // REQUIRED
            'samplingPercentage' => <float>, // REQUIRED
        ],
        'sessionConfig' => [
            'sessionTimeoutMinutes' => <integer>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'executionStatus' => 'ENABLED|DISABLED',
    'failureReason' => '<string>',
    'onlineEvaluationConfigArn' => '<string>',
    'onlineEvaluationConfigId' => '<string>',
    'outputConfig' => [
        'cloudWatchConfig' => [
            'logGroupName' => '<string>',
        ],
    ],
    'status' => 'ACTIVE|CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreatePolicy

$result = $client->createPolicy([/* ... */]);
$promise = $client->createPolicyAsync([/* ... */]);

Creates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

Parameter Syntax

$result = $client->createPolicy([
    'clientToken' => '<string>',
    'definition' => [ // REQUIRED
        'cedar' => [
            'statement' => '<string>', // REQUIRED
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'policyEngineId' => '<string>', // REQUIRED
    'validationMode' => 'FAIL_ON_ANY_FINDINGS|IGNORE_ALL_FINDINGS',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'definition' => [
        'cedar' => [
            'statement' => '<string>',
        ],
    ],
    'description' => '<string>',
    'name' => '<string>',
    'policyArn' => '<string>',
    'policyEngineId' => '<string>',
    'policyId' => '<string>',
    'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
    'statusReasons' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreatePolicyEngine

$result = $client->createPolicyEngine([/* ... */]);
$promise = $client->createPolicyEngineAsync([/* ... */]);

Creates a new policy engine within the AgentCore Policy system. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with Gateways (each Gateway can be associated with at most one policy engine, but multiple Gateways can be associated with the same engine), the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

Parameter Syntax

$result = $client->createPolicyEngine([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'policyEngineArn' => '<string>',
    'policyEngineId' => '<string>',
    'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
    'statusReasons' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

CreateWorkloadIdentity

$result = $client->createWorkloadIdentity([/* ... */]);
$promise = $client->createWorkloadIdentityAsync([/* ... */]);

Creates a new workload identity.

Parameter Syntax

$result = $client->createWorkloadIdentity([
    'allowedResourceOauth2ReturnUrls' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'allowedResourceOauth2ReturnUrls' => ['<string>', ...],
    'name' => '<string>',
    'workloadIdentityArn' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteAgentRuntime

$result = $client->deleteAgentRuntime([/* ... */]);
$promise = $client->deleteAgentRuntimeAsync([/* ... */]);

Deletes an Amazon Bedrock AgentCore Runtime.

Parameter Syntax

$result = $client->deleteAgentRuntime([
    'agentRuntimeId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentRuntimeId' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteAgentRuntimeEndpoint

$result = $client->deleteAgentRuntimeEndpoint([/* ... */]);
$promise = $client->deleteAgentRuntimeEndpointAsync([/* ... */]);

Deletes an AAgentCore Runtime endpoint.

Parameter Syntax

$result = $client->deleteAgentRuntimeEndpoint([
    'agentRuntimeId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'endpointName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentRuntimeId' => '<string>',
    'endpointName' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteApiKeyCredentialProvider

$result = $client->deleteApiKeyCredentialProvider([/* ... */]);
$promise = $client->deleteApiKeyCredentialProviderAsync([/* ... */]);

Deletes an API key credential provider.

Parameter Syntax

$result = $client->deleteApiKeyCredentialProvider([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteBrowser

$result = $client->deleteBrowser([/* ... */]);
$promise = $client->deleteBrowserAsync([/* ... */]);

Deletes a custom browser.

Parameter Syntax

$result = $client->deleteBrowser([
    'browserId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'browserId' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteCodeInterpreter

$result = $client->deleteCodeInterpreter([/* ... */]);
$promise = $client->deleteCodeInterpreterAsync([/* ... */]);

Deletes a custom code interpreter.

Parameter Syntax

$result = $client->deleteCodeInterpreter([
    'clientToken' => '<string>',
    'codeInterpreterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeInterpreterId' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteEvaluator

$result = $client->deleteEvaluator([/* ... */]);
$promise = $client->deleteEvaluatorAsync([/* ... */]);

Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.

Parameter Syntax

$result = $client->deleteEvaluator([
    'evaluatorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'evaluatorArn' => '<string>',
    'evaluatorId' => '<string>',
    'status' => 'ACTIVE|CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteGateway

$result = $client->deleteGateway([/* ... */]);
$promise = $client->deleteGatewayAsync([/* ... */]);

Deletes a gateway.

Parameter Syntax

$result = $client->deleteGateway([
    'gatewayIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'gatewayId' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
    'statusReasons' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteGatewayTarget

$result = $client->deleteGatewayTarget([/* ... */]);
$promise = $client->deleteGatewayTargetAsync([/* ... */]);

Deletes a gateway target.

Parameter Syntax

$result = $client->deleteGatewayTarget([
    'gatewayIdentifier' => '<string>', // REQUIRED
    'targetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'gatewayArn' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED|SYNCHRONIZING|SYNCHRONIZE_UNSUCCESSFUL',
    'statusReasons' => ['<string>', ...],
    'targetId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteMemory

$result = $client->deleteMemory([/* ... */]);
$promise = $client->deleteMemoryAsync([/* ... */]);

Deletes an Amazon Bedrock AgentCore Memory resource.

Parameter Syntax

$result = $client->deleteMemory([
    'clientToken' => '<string>',
    'memoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'memoryId' => '<string>',
    'status' => 'CREATING|ACTIVE|FAILED|DELETING',
]

Result Details

Errors

ServiceException:

An internal error occurred.

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottledException:

API rate limit has been exceeded.

DeleteOauth2CredentialProvider

$result = $client->deleteOauth2CredentialProvider([/* ... */]);
$promise = $client->deleteOauth2CredentialProviderAsync([/* ... */]);

Deletes an OAuth2 credential provider.

Parameter Syntax

$result = $client->deleteOauth2CredentialProvider([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteOnlineEvaluationConfig

$result = $client->deleteOnlineEvaluationConfig([/* ... */]);
$promise = $client->deleteOnlineEvaluationConfigAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteOnlineEvaluationConfig([
    'onlineEvaluationConfigId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'onlineEvaluationConfigArn' => '<string>',
    'onlineEvaluationConfigId' => '<string>',
    'status' => 'ACTIVE|CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeletePolicy

$result = $client->deletePolicy([/* ... */]);
$promise = $client->deletePolicyAsync([/* ... */]);

Deletes an existing policy from the AgentCore Policy system. Once deleted, the policy can no longer be used for agent behavior control and all references to it become invalid. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

Parameter Syntax

$result = $client->deletePolicy([
    'policyEngineId' => '<string>', // REQUIRED
    'policyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'definition' => [
        'cedar' => [
            'statement' => '<string>',
        ],
    ],
    'description' => '<string>',
    'name' => '<string>',
    'policyArn' => '<string>',
    'policyEngineId' => '<string>',
    'policyId' => '<string>',
    'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
    'statusReasons' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeletePolicyEngine

$result = $client->deletePolicyEngine([/* ... */]);
$promise = $client->deletePolicyEngineAsync([/* ... */]);

Deletes an existing policy engine from the AgentCore Policy system. The policy engine must not have any associated policies before deletion. Once deleted, the policy engine and all its configurations become unavailable for policy management and evaluation. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

Parameter Syntax

$result = $client->deletePolicyEngine([
    'policyEngineId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'policyEngineArn' => '<string>',
    'policyEngineId' => '<string>',
    'status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED',
    'statusReasons' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ConflictException:

This exception is thrown when there is a conflict performing an operation

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource-based policy for a specified resource.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

DeleteWorkloadIdentity

$result = $client->deleteWorkloadIdentity([/* ... */]);
$promise = $client->deleteWorkloadIdentityAsync([/* ... */]);

Deletes a workload identity.

Parameter Syntax

$result = $client->deleteWorkloadIdentity([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetAgentRuntime

$result = $client->getAgentRuntime([/* ... */]);
$promise = $client->getAgentRuntimeAsync([/* ... */]);

Gets an Amazon Bedrock AgentCore Runtime.

Parameter Syntax

$result = $client->getAgentRuntime([
    'agentRuntimeId' => '<string>', // REQUIRED
    'agentRuntimeVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeArtifact' => [
        'codeConfiguration' => [
            'code' => [
                's3' => [
                    'bucket' => '<string>',
                    'prefix' => '<string>',
                    'versionId' => '<string>',
                ],
            ],
            'entryPoint' => ['<string>', ...],
            'runtime' => 'PYTHON_3_10|PYTHON_3_11|PYTHON_3_12|PYTHON_3_13',
        ],
        'containerConfiguration' => [
            'containerUri' => '<string>',
        ],
    ],
    'agentRuntimeId' => '<string>',
    'agentRuntimeName' => '<string>',
    'agentRuntimeVersion' => '<string>',
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'allowedScopes' => ['<string>', ...],
            'customClaims' => [
                [
                    'authorizingClaimMatchValue' => [
                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                        'claimMatchValue' => [
                            'matchValueString' => '<string>',
                            'matchValueStringList' => ['<string>', ...],
                        ],
                    ],
                    'inboundTokenClaimName' => '<string>',
                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                ],
                // ...
            ],
            'discoveryUrl' => '<string>',
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'environmentVariables' => ['<string>', ...],
    'failureReason' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'lifecycleConfiguration' => [
        'idleRuntimeSessionTimeout' => <integer>,
        'maxLifetime' => <integer>,
    ],
    'networkConfiguration' => [
        'networkMode' => 'PUBLIC|VPC',
        'networkModeConfig' => [
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...],
        ],
    ],
    'protocolConfiguration' => [
        'serverProtocol' => 'MCP|HTTP|A2A',
    ],
    'requestHeaderConfiguration' => [
        'requestHeaderAllowlist' => ['<string>', ...],
    ],
    'roleArn' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
    'workloadIdentityDetails' => [
        'workloadIdentityArn' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetAgentRuntimeEndpoint

$result = $client->getAgentRuntimeEndpoint([/* ... */]);
$promise = $client->getAgentRuntimeEndpointAsync([/* ... */]);

Gets information about an Amazon Secure AgentEndpoint.

Parameter Syntax

$result = $client->getAgentRuntimeEndpoint([
    'agentRuntimeId' => '<string>', // REQUIRED
    'endpointName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeEndpointArn' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'failureReason' => '<string>',
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'liveVersion' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
    'targetVersion' => '<string>',
]

Result Details

Errors

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetApiKeyCredentialProvider

$result = $client->getApiKeyCredentialProvider([/* ... */]);
$promise = $client->getApiKeyCredentialProviderAsync([/* ... */]);

Retrieves information about an API key credential provider.

Parameter Syntax

$result = $client->getApiKeyCredentialProvider([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'apiKeySecretArn' => [
        'secretArn' => '<string>',
    ],
    'createdTime' => <DateTime>,
    'credentialProviderArn' => '<string>',
    'lastUpdatedTime' => <DateTime>,
    'name' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

DecryptionFailure:

Exception thrown when decryption of a secret fails.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetBrowser

$result = $client->getBrowser([/* ... */]);
$promise = $client->getBrowserAsync([/* ... */]);

Gets information about a custom browser.

Parameter Syntax

$result = $client->getBrowser([
    'browserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'browserArn' => '<string>',
    'browserId' => '<string>',
    'browserSigning' => [
        'enabled' => true || false,
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'failureReason' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'networkConfiguration' => [
        'networkMode' => 'PUBLIC|VPC',
        'vpcConfig' => [
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...],
        ],
    ],
    'recording' => [
        'enabled' => true || false,
        's3Location' => [
            'bucket' => '<string>',
            'prefix' => '<string>',
            'versionId' => '<string>',
        ],
    ],
    'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetCodeInterpreter

$result = $client->getCodeInterpreter([/* ... */]);
$promise = $client->getCodeInterpreterAsync([/* ... */]);

Gets information about a custom code interpreter.

Parameter Syntax

$result = $client->getCodeInterpreter([
    'codeInterpreterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeInterpreterArn' => '<string>',
    'codeInterpreterId' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'failureReason' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'networkConfiguration' => [
        'networkMode' => 'PUBLIC|SANDBOX|VPC',
        'vpcConfig' => [
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...],
        ],
    ],
    'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Errors

ServiceQuotaExceededException:

This exception is thrown when a request is made beyond the service quota

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetEvaluator

$result = $client->getEvaluator([/* ... */]);
$promise = $client->getEvaluatorAsync([/* ... */]);

Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.

Parameter Syntax

$result = $client->getEvaluator([
    'evaluatorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'evaluatorArn' => '<string>',
    'evaluatorConfig' => [
        'llmAsAJudge' => [
            'instructions' => '<string>',
            'modelConfig' => [
                'bedrockEvaluatorModelConfig' => [
                    'additionalModelRequestFields' => [
                    ],
                    'inferenceConfig' => [
                        'maxTokens' => <integer>,
                        'stopSequences' => ['<string>', ...],
                        'temperature' => <float>,
                        'topP' => <float>,
                    ],
                    'modelId' => '<string>',
                ],
            ],
            'ratingScale' => [
                'categorical' => [
                    [
                        'definition' => '<string>',
                        'label' => '<string>',
                    ],
                    // ...
                ],
                'numerical' => [
                    [
                        'definition' => '<string>',
                        'label' => '<string>',
                        'value' => <float>,
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'evaluatorId' => '<string>',
    'evaluatorName' => '<string>',
    'level' => 'TOOL_CALL|TRACE|SESSION',
    'lockedForModification' => true || false,
    'status' => 'ACTIVE|CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetGateway

$result = $client->getGateway([/* ... */]);
$promise = $client->getGatewayAsync([/* ... */]);

Retrieves information about a specific Gateway.

Parameter Syntax

$result = $client->getGateway([
    'gatewayIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'allowedScopes' => ['<string>', ...],
            'customClaims' => [
                [
                    'authorizingClaimMatchValue' => [
                        'claimMatchOperator' => 'EQUALS|CONTAINS|CONTAINS_ANY',
                        'claimMatchValue' => [
                            'matchValueString' => '<string>',
                            'matchValueStringList' => ['<string>', ...],
                        ],
                    ],
                    'inboundTokenClaimName' => '<string>',
                    'inboundTokenClaimValueType' => 'STRING|STRING_ARRAY',
                ],
                // ...
            ],
            'discoveryUrl' => '<string>',
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT|AWS_IAM|NONE',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'gatewayArn' => '<string>',
    'gatewayId' => '<string>',
    'gatewayUrl' => '<string>',
    'interceptorConfigurations' => [
        [
            'inputConfiguration' => [
                'passRequestHeaders' => true || false,
            ],
            'interceptionPoints' => ['<string>', ...],
            'interceptor' => [
                'lambda' => [
                    'arn' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'policyEngineConfiguration' => [
        'arn' => '<string>',
        'mode' => 'LOG_ONLY|ENFORCE',
    ],
    'protocolConfiguration' => [
        'mcp' => [
            'instructions' => '<string>',
            'searchType' => 'SEMANTIC',
            'supportedVersions' => ['<string>', ...],
        ],
    ],
    'protocolType' => 'MCP',
    'roleArn' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
    'statusReasons' => ['<string>', ...],
    'updatedAt' => <DateTime>,
    'workloadIdentityDetails' => [
        'workloadIdentityArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetGatewayTarget

$result = $client->getGatewayTarget([/* ... */]);
$promise = $client->getGatewayTargetAsync([/* ... */]);

Retrieves information about a specific gateway target.

Parameter Syntax

$result = $client->getGatewayTarget([
    'gatewayIdentifier' => '<string>', // REQUIRED
    'targetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'credentialProviderConfigurations' => [
        [
            'credentialProvider' => [
                'apiKeyCredentialProvider' => [
                    'credentialLocation' => 'HEADER|QUERY_PARAMETER',
                    'credentialParameterName' => '<string>',
                    'credentialPrefix' => '<string>',
                    'providerArn' => '<string>',
                ],
                'oauthCredentialProvider' => [
                    'customParameters' => ['<string>', ...],
                    'defaultReturnUrl' => '<string>',
                    'grantType' => 'CLIENT_CREDENTIALS|AUTHORIZATION_CODE',
                    'providerArn' => '<string>',
                    'scopes' => ['<string>', ...],
                ],
            ],
            'credentialProviderType' => 'GATEWAY_IAM_ROLE|OAUTH|API_KEY',
        ],
        // ...
    ],
    'description' => '<string>',
    'gatewayArn' => '<string>',
    'lastSynchronizedAt' => <DateTime>,
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED|SYNCHRONIZING|SYNCHRONIZE_UNSUCCESSFUL',
    'statusReasons' => ['<string>', ...],
    'targetConfiguration' => [
        'mcp' => [
            'apiGateway' => [
                'apiGatewayToolConfiguration' => [
                    'toolFilters' => [
                        [
                            'filterPath' => '<string>',
                            'methods' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'toolOverrides' => [
                        [
                            'description' => '<string>',
                            'method' => 'GET|DELETE|HEAD|OPTIONS|PATCH|PUT|POST',
                            'name' => '<string>',
                            'path' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'restApiId' => '<string>',
                'stage' => '<string>',
            ],
            'lambda' => [
                'lambdaArn' => '<string>',
                'toolSchema' => [
                    'inlinePayload' => [
                        [
                            'description' => '<string>',
                            'inputSchema' => [
                                'description' => '<string>',
                                'items' => [...], // RECURSIVE
                                'properties' => [
                                    '<String>' => [...], // RECURSIVE
                                    // ...
                                ],
                                'required' => ['<string>', ...],
                                'type' => 'string|number|object|array|boolean|integer',
                            ],
                            'name' => '<string>',
                            'outputSchema' => [
                                'description' => '<string>',
                                'items' => [...], // RECURSIVE
                                'properties' => [
                                    '<String>' => [...], // RECURSIVE
                                    // ...
                                ],
                                'required' => ['<string>', ...],
                                'type' => 'string|number|object|array|boolean|integer',
                            ],
                        ],
                        // ...
                    ],
                    's3' => [
                        'bucketOwnerAccountId' => '<string>',
                        'uri' => '<string>',
                    ],
                ],
            ],
            'mcpServer' => [
                'endpoint' => '<string>',
            ],
            'openApiSchema' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
            'smithyModel' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
        ],
    ],
    'targetId' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetMemory

$result = $client->getMemory([/* ... */]);
$promise = $client->getMemoryAsync([/* ... */]);

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Parameter Syntax

$result = $client->getMemory([
    'memoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'memory' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'encryptionKeyArn' => '<string>',
        'eventExpiryDuration' => <integer>,
        'failureReason' => '<string>',
        'id' => '<string>',
        'memoryExecutionRoleArn' => '<string>',
        'name' => '<string>',
        'status' => 'CREATING|ACTIVE|FAILED|DELETING',
        'strategies' => [
            [
                'configuration' => [
                    'consolidation' => [
                        'customConsolidationConfiguration' => [
                            'episodicConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'semanticConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'summaryConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'extraction' => [
                        'customExtractionConfiguration' => [
                            'episodicExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'semanticExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'reflection' => [
                        'customReflectionConfiguration' => [
                            'episodicReflectionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                                'namespaces' => ['<string>', ...],
                            ],
                        ],
                        'episodicReflectionConfiguration' => [
                            'namespaces' => ['<string>', ...],
                        ],
                    ],
                    'selfManagedConfiguration' => [
                        'historicalContextWindowSize' => <integer>,
                        'invocationConfiguration' => [
                            'payloadDeliveryBucketName' => '<string>',
                            'topicArn' => '<string>',
                        ],
                        'triggerConditions' => [
                            [
                                'messageBasedTrigger' => [
                                    'messageCount' => <integer>,
                                ],
                                'timeBasedTrigger' => [
                                    'idleSessionTimeout' => <integer>,
                                ],
                                'tokenBasedTrigger' => [
                                    'tokenCount' => <integer>,
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'type' => 'SEMANTIC_OVERRIDE|SUMMARY_OVERRIDE|USER_PREFERENCE_OVERRIDE|SELF_MANAGED|EPISODIC_OVERRIDE',
                ],
                'createdAt' => <DateTime>,
                'description' => '<string>',
                'name' => '<string>',
                'namespaces' => ['<string>', ...],
                'status' => 'CREATING|ACTIVE|DELETING|FAILED',
                'strategyId' => '<string>',
                'type' => 'SEMANTIC|SUMMARIZATION|USER_PREFERENCE|CUSTOM|EPISODIC',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

An internal error occurred.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottledException:

API rate limit has been exceeded.

GetOauth2CredentialProvider

$result = $client->getOauth2CredentialProvider([/* ... */]);
$promise = $client->getOauth2CredentialProviderAsync([/* ... */]);

Retrieves information about an OAuth2 credential provider.

Parameter Syntax

$result = $client->getOauth2CredentialProvider([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'callbackUrl' => '<string>',
    'clientSecretArn' => [
        'secretArn' => '<string>',
    ],
    'createdTime' => <DateTime>,
    'credentialProviderArn' => '<string>',
    'credentialProviderVendor' => 'GoogleOauth2|GithubOauth2|SlackOauth2|SalesforceOauth2|MicrosoftOauth2|CustomOauth2|AtlassianOauth2|LinkedinOauth2|XOauth2|OktaOauth2|OneLoginOauth2|PingOneOauth2|FacebookOauth2|YandexOauth2|RedditOauth2|ZoomOauth2|TwitchOauth2|SpotifyOauth2|DropboxOauth2|NotionOauth2|HubspotOauth2|CyberArkOauth2|FusionAuthOauth2|Auth0Oauth2|CognitoOauth2',
    'lastUpdatedTime' => <DateTime>,
    'name' => '<string>',
    'oauth2ProviderConfigOutput' => [
        'atlassianOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'customOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'githubOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'googleOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'includedOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'linkedinOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'microsoftOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'salesforceOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'slackOauth2ProviderConfig' => [
            'clientId' => '<string>',
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                    'tokenEndpointAuthMethods' => ['<string>', ...],
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

DecryptionFailure:

Exception thrown when decryption of a secret fails.

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request

GetOnlineEvaluationConfig

$result = $client->getOnlineEvaluationConfig([/* ... */]);
$promise = $client->getOnlineEvaluationConfigAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getOnlineEvaluationConfig([
    'onlineEvaluationConfigId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'dataSourceConfig' => [
        'cloudWatchLogs' => [
            'logGroupNames' => ['<string>', ...],
            'serviceNames' => ['<string>', ...],
        ],
    ],
    'description' => '<string>',
    'evaluationExecutionRoleArn' => '<string>',
    'evaluators' => [
        [
            'evaluatorId' => '<string>',
        ],
        // ...
    ],
    'executionStatus' => 'ENABLED|DISABLED',
    'failureReason' => '<string>',
    'onlineEvaluationConfigArn' => '<string>',
    'onlineEvaluationConfigId' => '<string>',
    'onlineEvaluationConfigName' => '<string>',
    'outputConfig' => [
        'cloudWatchConfig' => [
            'logGroupName' => '<string>',
        ],
    ],
    'rule' => [
        'filters' => [
            [
                'key' => '<string>',
                'operator' => 'Equals|NotEquals|GreaterThan|LessThan|GreaterThanOrEqual|LessThanOrEqual|Contains|NotContains',
                'value' => [
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
        'samplingConfig' => [
            'samplingPercentage' => <float>,
        ],
        'sessionConfig' => [
            'sessionTimeoutMinutes' => <integer>,
        ],
    ],
    'status' => 'ACTIVE|CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

This exception is thrown when a request is denied per access permissions

ResourceNotFoundException:

This exception is thrown when a resource referenced by the operation does not exist

ThrottlingException:

This exception is thrown when the number of requests exceeds the limit

InternalServerException:

This exception is thrown if there was an unexpected error during processing of request