CreateAgentRuntime

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

Creates an Amazon Secure Agent.

Parameter Syntax

$result = $client->createAgentRuntime([
    'agentRuntimeArtifact' => [ // REQUIRED
        'containerConfiguration' => [
            'containerUri' => '<string>', // REQUIRED
        ],
    ],
    'agentRuntimeName' => '<string>', // REQUIRED
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>', // REQUIRED
        ],
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'environmentVariables' => ['<string>', ...],
    'networkConfiguration' => [ // REQUIRED
        'networkMode' => 'PUBLIC', // REQUIRED
    ],
    'protocolConfiguration' => [
        'serverProtocol' => 'MCP|HTTP', // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
]);

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 Amazon Secure AgentEndpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeEndpointArn' => '<string>',
    'createdAt' => <DateTime>,
    '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
]);

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([
    'clientToken' => '<string>',
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'networkConfiguration' => [ // REQUIRED
        'networkMode' => 'PUBLIC', // REQUIRED
    ],
    'recording' => [
        'enabled' => true || false,
        's3Location' => [
            'bucket' => '<string>', // REQUIRED
            'prefix' => '<string>', // REQUIRED
        ],
    ],
]);

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', // REQUIRED
    ],
]);

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

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.

To create a gateway, you must specify a name, protocol type, and IAM role. The role grants the gateway permission to access Amazon Web Services services and resources.

Parameter Syntax

$result = $client->createGateway([
    'authorizerConfiguration' => [ // REQUIRED
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>', // REQUIRED
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'protocolConfiguration' => [
        'mcp' => [
            'instructions' => '<string>',
            'searchType' => 'SEMANTIC',
            'supportedVersions' => ['<string>', ...],
        ],
    ],
    'protocolType' => 'MCP', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>',
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'gatewayArn' => '<string>',
    'gatewayId' => '<string>',
    'gatewayUrl' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    '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.

To create a target, you must specify the gateway identifier and target configuration.

Parameter Syntax

$result = $client->createGatewayTarget([
    'clientToken' => '<string>',
    'credentialProviderConfigurations' => [ // REQUIRED
        [
            'credentialProvider' => [
                'apiKeyCredentialProvider' => [
                    'credentialLocation' => 'HEADER|QUERY_PARAMETER',
                    'credentialParameterName' => '<string>',
                    'credentialPrefix' => '<string>',
                    'providerArn' => '<string>', // REQUIRED
                ],
                'oauthCredentialProvider' => [
                    'customParameters' => ['<string>', ...],
                    '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' => [
            '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>',
                    ],
                ],
            ],
            '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>', ...],
                    'providerArn' => '<string>',
                    'scopes' => ['<string>', ...],
                ],
            ],
            'credentialProviderType' => 'GATEWAY_IAM_ROLE|OAUTH|API_KEY',
        ],
        // ...
    ],
    'description' => '<string>',
    'gatewayArn' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
    'statusReasons' => ['<string>', ...],
    'targetConfiguration' => [
        'mcp' => [
            '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>',
                    ],
                ],
            ],
            '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 memory.

Parameter Syntax

$result = $client->createMemory([
    'clientToken' => '<string>',
    'description' => '<string>',
    'encryptionKeyArn' => '<string>',
    'eventExpiryDuration' => <integer>, // REQUIRED
    'memoryExecutionRoleArn' => '<string>',
    'memoryStrategies' => [
        [
            'customMemoryStrategy' => [
                'configuration' => [
                    '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>', ...],
            ],
            '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
]);

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' => [
                            'semanticConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'summaryConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'extraction' => [
                        'customExtractionConfiguration' => [
                            'semanticExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'type' => 'SEMANTIC_OVERRIDE|SUMMARY_OVERRIDE|USER_PREFERENCE_OVERRIDE',
                ],
                'createdAt' => <DateTime>,
                'description' => '<string>',
                'name' => '<string>',
                'namespaces' => ['<string>', ...],
                'status' => 'CREATING|ACTIVE|DELETING|FAILED',
                'strategyId' => '<string>',
                'type' => 'SEMANTIC|SUMMARIZATION|USER_PREFERENCE|CUSTOM',
                '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', // REQUIRED
    'name' => '<string>', // REQUIRED
    'oauth2ProviderConfigInput' => [ // REQUIRED
        'customOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
            'oauthDiscovery' => [ // REQUIRED
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>', // REQUIRED
                    'issuer' => '<string>', // REQUIRED
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>', // REQUIRED
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'githubOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'googleOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'microsoftOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'salesforceOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
        'slackOauth2ProviderConfig' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'clientSecretArn' => [
        '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.

CreateWorkloadIdentity

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

Creates a new workload identity.

Parameter Syntax

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

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 Secure Agent.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    '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 Amazon Secure AgentEndpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    '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

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',
    '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 a memory.

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

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

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 Secure Agent.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeArtifact' => [
        'containerConfiguration' => [
            'containerUri' => '<string>',
        ],
    ],
    'agentRuntimeId' => '<string>',
    'agentRuntimeName' => '<string>',
    'agentRuntimeVersion' => '<string>',
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>',
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'environmentVariables' => ['<string>', ...],
    'lastUpdatedAt' => <DateTime>,
    'networkConfiguration' => [
        'networkMode' => 'PUBLIC',
    ],
    'protocolConfiguration' => [
        'serverProtocol' => 'MCP|HTTP',
    ],
    '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>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'executionRoleArn' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'networkConfiguration' => [
        'networkMode' => 'PUBLIC',
    ],
    'recording' => [
        'enabled' => true || false,
        's3Location' => [
            'bucket' => '<string>',
            'prefix' => '<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>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'networkConfiguration' => [
        'networkMode' => 'PUBLIC|SANDBOX',
    ],
    '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

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>', ...],
            'discoveryUrl' => '<string>',
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'gatewayArn' => '<string>',
    'gatewayId' => '<string>',
    'gatewayUrl' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    '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>', ...],
                    'providerArn' => '<string>',
                    'scopes' => ['<string>', ...],
                ],
            ],
            'credentialProviderType' => 'GATEWAY_IAM_ROLE|OAUTH|API_KEY',
        ],
        // ...
    ],
    'description' => '<string>',
    'gatewayArn' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
    'statusReasons' => ['<string>', ...],
    'targetConfiguration' => [
        'mcp' => [
            '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>',
                    ],
                ],
            ],
            '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 memory.

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' => [
                            'semanticConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'summaryConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceConsolidationOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'extraction' => [
                        'customExtractionConfiguration' => [
                            'semanticExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                            'userPreferenceExtractionOverride' => [
                                'appendToPrompt' => '<string>',
                                'modelId' => '<string>',
                            ],
                        ],
                    ],
                    'type' => 'SEMANTIC_OVERRIDE|SUMMARY_OVERRIDE|USER_PREFERENCE_OVERRIDE',
                ],
                'createdAt' => <DateTime>,
                'description' => '<string>',
                'name' => '<string>',
                'namespaces' => ['<string>', ...],
                'status' => 'CREATING|ACTIVE|DELETING|FAILED',
                'strategyId' => '<string>',
                'type' => 'SEMANTIC|SUMMARIZATION|USER_PREFERENCE|CUSTOM',
                '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

[
    'clientSecretArn' => [
        'secretArn' => '<string>',
    ],
    'createdTime' => <DateTime>,
    'credentialProviderArn' => '<string>',
    'credentialProviderVendor' => 'GoogleOauth2|GithubOauth2|SlackOauth2|SalesforceOauth2|MicrosoftOauth2|CustomOauth2',
    'lastUpdatedTime' => <DateTime>,
    'name' => '<string>',
    'oauth2ProviderConfigOutput' => [
        'customOauth2ProviderConfig' => [
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'githubOauth2ProviderConfig' => [
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'googleOauth2ProviderConfig' => [
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'microsoftOauth2ProviderConfig' => [
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'salesforceOauth2ProviderConfig' => [
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<string>',
                ],
                'discoveryUrl' => '<string>',
            ],
        ],
        'slackOauth2ProviderConfig' => [
            'oauthDiscovery' => [
                'authorizationServerMetadata' => [
                    'authorizationEndpoint' => '<string>',
                    'issuer' => '<string>',
                    'responseTypes' => ['<string>', ...],
                    'tokenEndpoint' => '<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

GetTokenVault

$result = $client->getTokenVault([/* ... */]);
$promise = $client->getTokenVaultAsync([/* ... */]);

Retrieves information about a token vault.

Parameter Syntax

$result = $client->getTokenVault([
    'tokenVaultId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'kmsConfiguration' => [
        'keyType' => 'CustomerManagedKey|ServiceManagedKey',
        'kmsKeyArn' => '<string>',
    ],
    'lastModifiedDate' => <DateTime>,
    'tokenVaultId' => '<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

GetWorkloadIdentity

$result = $client->getWorkloadIdentity([/* ... */]);
$promise = $client->getWorkloadIdentityAsync([/* ... */]);

Retrieves information about a workload identity.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'allowedResourceOauth2ReturnUrls' => ['<string>', ...],
    'createdTime' => <DateTime>,
    'lastUpdatedTime' => <DateTime>,
    '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

ListAgentRuntimeEndpoints

$result = $client->listAgentRuntimeEndpoints([/* ... */]);
$promise = $client->listAgentRuntimeEndpointsAsync([/* ... */]);

Lists all endpoints for a specific Amazon Secure Agent.

Parameter Syntax

$result = $client->listAgentRuntimeEndpoints([
    'agentRuntimeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'runtimeEndpoints' => [
        [
            'agentRuntimeArn' => '<string>',
            'agentRuntimeEndpointArn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<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.

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

ListAgentRuntimeVersions

$result = $client->listAgentRuntimeVersions([/* ... */]);
$promise = $client->listAgentRuntimeVersionsAsync([/* ... */]);

Lists all versions of a specific Amazon Secure Agent.

Parameter Syntax

$result = $client->listAgentRuntimeVersions([
    'agentRuntimeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentRuntimes' => [
        [
            'agentRuntimeArn' => '<string>',
            'agentRuntimeId' => '<string>',
            'agentRuntimeName' => '<string>',
            'agentRuntimeVersion' => '<string>',
            'description' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<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

ListAgentRuntimes

$result = $client->listAgentRuntimes([/* ... */]);
$promise = $client->listAgentRuntimesAsync([/* ... */]);

Lists all Amazon Secure Agents in your account.

Parameter Syntax

$result = $client->listAgentRuntimes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentRuntimes' => [
        [
            'agentRuntimeArn' => '<string>',
            'agentRuntimeId' => '<string>',
            'agentRuntimeName' => '<string>',
            'agentRuntimeVersion' => '<string>',
            'description' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'status' => 'CREATING|CREATE_FAILED|UPDATING|UPDATE_FAILED|READY|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<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.

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

ListApiKeyCredentialProviders

$result = $client->listApiKeyCredentialProviders([/* ... */]);
$promise = $client->listApiKeyCredentialProvidersAsync([/* ... */]);

Lists all API key credential providers in your account.

Parameter Syntax

$result = $client->listApiKeyCredentialProviders([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'credentialProviders' => [
        [
            'createdTime' => <DateTime>,
            'credentialProviderArn' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<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

ListBrowsers

$result = $client->listBrowsers([/* ... */]);
$promise = $client->listBrowsersAsync([/* ... */]);

Lists all custom browsers in your account.

Parameter Syntax

$result = $client->listBrowsers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'type' => 'SYSTEM|CUSTOM',
]);

Parameter Details

Result Syntax

[
    'browserSummaries' => [
        [
            'browserArn' => '<string>',
            'browserId' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
        ],
        // ...
    ],
    'nextToken' => '<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.

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

ListCodeInterpreters

$result = $client->listCodeInterpreters([/* ... */]);
$promise = $client->listCodeInterpretersAsync([/* ... */]);

Lists all custom code interpreters in your account.

Parameter Syntax

$result = $client->listCodeInterpreters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'type' => 'SYSTEM|CUSTOM',
]);

Parameter Details

Result Syntax

[
    'codeInterpreterSummaries' => [
        [
            'codeInterpreterArn' => '<string>',
            'codeInterpreterId' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATING|CREATE_FAILED|READY|DELETING|DELETE_FAILED|DELETED',
        ],
        // ...
    ],
    'nextToken' => '<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.

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

ListGatewayTargets

$result = $client->listGatewayTargets([/* ... */]);
$promise = $client->listGatewayTargetsAsync([/* ... */]);

Lists all targets for a specific Gateway.

Parameter Syntax

$result = $client->listGatewayTargets([
    'gatewayIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
            'targetId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<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

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

ListGateways

$result = $client->listGateways([/* ... */]);
$promise = $client->listGatewaysAsync([/* ... */]);

Lists all Gateways in the account.

Parameter Syntax

$result = $client->listGateways([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'authorizerType' => 'CUSTOM_JWT',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'gatewayId' => '<string>',
            'name' => '<string>',
            'protocolType' => 'MCP',
            'status' => 'CREATING|UPDATING|UPDATE_UNSUCCESSFUL|DELETING|READY|FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<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

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

ListMemories

$result = $client->listMemories([/* ... */]);
$promise = $client->listMemoriesAsync([/* ... */]);

Lists the memory present.

Parameter Syntax

$result = $client->listMemories([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'memories' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'status' => 'CREATING|ACTIVE|FAILED|DELETING',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

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.

ListOauth2CredentialProviders

$result = $client->listOauth2CredentialProviders([/* ... */]);
$promise = $client->listOauth2CredentialProvidersAsync([/* ... */]);

Lists all OAuth2 credential providers in your account.

Parameter Syntax

$result = $client->listOauth2CredentialProviders([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'credentialProviders' => [
        [
            'createdTime' => <DateTime>,
            'credentialProviderArn' => '<string>',
            'credentialProviderVendor' => 'GoogleOauth2|GithubOauth2|SlackOauth2|SalesforceOauth2|MicrosoftOauth2|CustomOauth2',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<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

ListWorkloadIdentities

$result = $client->listWorkloadIdentities([/* ... */]);
$promise = $client->listWorkloadIdentitiesAsync([/* ... */]);

Lists all workload identities in your account.

Parameter Syntax

$result = $client->listWorkloadIdentities([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'workloadIdentities' => [
        [
            '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

SetTokenVaultCMK

$result = $client->setTokenVaultCMK([/* ... */]);
$promise = $client->setTokenVaultCMKAsync([/* ... */]);

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

Parameter Syntax

$result = $client->setTokenVaultCMK([
    'kmsConfiguration' => [ // REQUIRED
        'keyType' => 'CustomerManagedKey|ServiceManagedKey', // REQUIRED
        'kmsKeyArn' => '<string>',
    ],
    'tokenVaultId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'kmsConfiguration' => [
        'keyType' => 'CustomerManagedKey|ServiceManagedKey',
        'kmsKeyArn' => '<string>',
    ],
    'lastModifiedDate' => <DateTime>,
    'tokenVaultId' => '<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

ConcurrentModificationException:

Exception thrown when a resource is modified concurrently by multiple requests.

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

UpdateAgentRuntime

$result = $client->updateAgentRuntime([/* ... */]);
$promise = $client->updateAgentRuntimeAsync([/* ... */]);

Updates an existing Amazon Secure Agent.

Parameter Syntax

$result = $client->updateAgentRuntime([
    'agentRuntimeArtifact' => [ // REQUIRED
        'containerConfiguration' => [
            'containerUri' => '<string>', // REQUIRED
        ],
    ],
    'agentRuntimeId' => '<string>', // REQUIRED
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>', // REQUIRED
        ],
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'environmentVariables' => ['<string>', ...],
    'networkConfiguration' => [ // REQUIRED
        'networkMode' => 'PUBLIC', // REQUIRED
    ],
    'protocolConfiguration' => [
        'serverProtocol' => 'MCP|HTTP', // REQUIRED
    ],
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeId' => '<string>',
    'agentRuntimeVersion' => '<string>',
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <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.

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

UpdateAgentRuntimeEndpoint

$result = $client->updateAgentRuntimeEndpoint([/* ... */]);
$promise = $client->updateAgentRuntimeEndpointAsync([/* ... */]);

Updates an existing Amazon Secure AgentEndpoint.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentRuntimeArn' => '<string>',
    'agentRuntimeEndpointArn' => '<string>',
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'liveVersion' => '<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

UpdateApiKeyCredentialProvider

$result = $client->updateApiKeyCredentialProvider([/* ... */]);
$promise = $client->updateApiKeyCredentialProviderAsync([/* ... */]);

Updates an existing API key credential provider.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'apiKeySecretArn' => [
        'secretArn' => '<string>',
    ],
    'createdTime' => <DateTime>,
    'credentialProviderArn' => '<string>',
    'lastUpdatedTime' => <DateTime>,
    '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

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

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.

UpdateGateway

$result = $client->updateGateway([/* ... */]);
$promise = $client->updateGatewayAsync([/* ... */]);

Updates an existing Gateway.

Parameter Syntax

$result = $client->updateGateway([
    'authorizerConfiguration' => [ // REQUIRED
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>', // REQUIRED
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT', // REQUIRED
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'gatewayIdentifier' => '<string>', // REQUIRED
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'protocolConfiguration' => [
        'mcp' => [
            'instructions' => '<string>',
            'searchType' => 'SEMANTIC',
            'supportedVersions' => ['<string>', ...],
        ],
    ],
    'protocolType' => 'MCP', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'authorizerConfiguration' => [
        'customJWTAuthorizer' => [
            'allowedAudience' => ['<string>', ...],
            'allowedClients' => ['<string>', ...],
            'discoveryUrl' => '<string>',
        ],
    ],
    'authorizerType' => 'CUSTOM_JWT',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'exceptionLevel' => 'DEBUG',
    'gatewayArn' => '<string>',
    'gatewayId' => '<string>',
    'gatewayUrl' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    '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

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

UpdateGatewayTarget

$result = $client->updateGatewayTarget([/* ... */]);
$promise = $client->updateGatewayTargetAsync([/* ... */]);

Updates an existing Gateway Target.

Parameter Syntax

$result = $client->updateGatewayTarget([
    'credentialProviderConfigurations' => [ // REQUIRED
        [
            'credentialProvider' => [
                'apiKeyCredentialProvider' => [
                    'credentialLocation' => 'HEADER|QUERY_PARAMETER',
                    'credentialParameterName' => '<string>',
                    'credentialPrefix' => '<string>',
                    'providerArn' => '<string>', // REQUIRED
                ],
                'oauthCredentialProvider' => [
                    'customParameters' => ['<string>', ...],
                    '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' => [
            '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>',
                    ],
                ],
            ],
            'openApiSchema' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
            'smithyModel' => [
                'inlinePayload' => '<string>',
                's3' => [
                    'bucketOwnerAccountId' => '<string>',
                    'uri' => '<string>',
                ],
            ],
        ],
    ],
    'targetId' => '<string>', // REQUIRED
]);

Parameter Details