2025/10/10 - Amazon Bedrock Agent Core Control Plane Fronting Layer - 1 new8 updated api methods
Changes Bedrock AgentCore release for Runtime, and Memory.
The gateway targets.
See also: AWS API Documentation
Request Syntax
client.synchronize_gateway_targets(
gatewayIdentifier='string',
targetIdList=[
'string',
]
)
string
[REQUIRED]
The gateway Identifier.
list
[REQUIRED]
The target ID list.
(string) --
dict
Response Syntax
{
'targets': [
{
'gatewayArn': 'string',
'targetId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
'statusReasons': [
'string',
],
'name': 'string',
'description': 'string',
'targetConfiguration': {
'mcp': {
'openApiSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'smithyModel': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'lambda': {
'lambdaArn': 'string',
'toolSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': [
{
'name': 'string',
'description': 'string',
'inputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
},
'outputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
}
},
]
}
},
'mcpServer': {
'endpoint': 'string'
}
}
},
'credentialProviderConfigurations': [
{
'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'apiKeyCredentialProvider': {
'providerArn': 'string',
'credentialParameterName': 'string',
'credentialPrefix': 'string',
'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
}
}
},
],
'lastSynchronizedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
targets (list) --
The gateway targets for synchronization.
(dict) --
The gateway target.
gatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway target.
targetId (string) --
The target ID.
createdAt (datetime) --
The date and time at which the target was created.
updatedAt (datetime) --
The date and time at which the target was updated.
status (string) --
The status of the gateway target.
statusReasons (list) --
The status reasons for the target status.
(string) --
name (string) --
The name of the gateway target.
description (string) --
The description for the gateway target.
targetConfiguration (dict) --
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
mcp (dict) --
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
openApiSchema (dict) --
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
smithyModel (dict) --
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
lambda (dict) --
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
toolSchema (dict) --
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
s3 (dict) --
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (list) --
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(dict) --
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name (string) --
The name of the tool. This name identifies the tool in the Model Context Protocol.
description (string) --
The description of the tool. This description provides information about the purpose and usage of the tool.
inputSchema (dict) --
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
outputSchema (dict) --
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
mcpServer (dict) --
The MCP server specified as the gateway target.
endpoint (string) --
The endpoint for the MCP server target configuration.
credentialProviderConfigurations (list) --
The provider configurations.
(dict) --
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType (string) --
The type of credential provider. This field specifies which authentication method the gateway uses.
credentialProvider (dict) --
The credential provider. This field contains the specific configuration for the credential provider type.
oauthCredentialProvider (dict) --
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
scopes (list) --
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string) --
customParameters (dict) --
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
(string) --
(string) --
apiKeyCredentialProvider (dict) --
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
credentialParameterName (string) --
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
credentialPrefix (string) --
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
credentialLocation (string) --
The location of the API key credential. This field specifies where in the request the API key should be placed.
lastSynchronizedAt (datetime) --
The last synchronization time.
{'targetConfiguration': {'mcp': {'mcpServer': {'endpoint': 'string'}}}}
Response {'lastSynchronizedAt': 'timestamp',
'status': {'SYNCHRONIZING', 'SYNCHRONIZE_UNSUCCESSFUL'},
'targetConfiguration': {'mcp': {'mcpServer': {'endpoint': 'string'}}}}
Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.
See also: AWS API Documentation
Request Syntax
client.create_gateway_target(
gatewayIdentifier='string',
name='string',
description='string',
clientToken='string',
targetConfiguration={
'mcp': {
'openApiSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'smithyModel': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'lambda': {
'lambdaArn': 'string',
'toolSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': [
{
'name': 'string',
'description': 'string',
'inputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
},
'outputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
}
},
]
}
},
'mcpServer': {
'endpoint': 'string'
}
}
},
credentialProviderConfigurations=[
{
'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'apiKeyCredentialProvider': {
'providerArn': 'string',
'credentialParameterName': 'string',
'credentialPrefix': 'string',
'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
}
}
},
]
)
string
[REQUIRED]
The identifier of the gateway to create a target for.
string
[REQUIRED]
The name of the gateway target. The name must be unique within the gateway.
string
The description of the gateway target.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
[REQUIRED]
The configuration settings for the target, including endpoint information and schema definitions.
mcp (dict) --
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
openApiSchema (dict) --
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
smithyModel (dict) --
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
lambda (dict) --
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
toolSchema (dict) -- [REQUIRED]
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
s3 (dict) --
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (list) --
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(dict) --
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name (string) -- [REQUIRED]
The name of the tool. This name identifies the tool in the Model Context Protocol.
description (string) -- [REQUIRED]
The description of the tool. This description provides information about the purpose and usage of the tool.
inputSchema (dict) -- [REQUIRED]
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type (string) -- [REQUIRED]
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
outputSchema (dict) --
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type (string) -- [REQUIRED]
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
mcpServer (dict) --
The MCP server specified as the gateway target.
endpoint (string) -- [REQUIRED]
The endpoint for the MCP server target configuration.
list
The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.
(dict) --
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider. This field specifies which authentication method the gateway uses.
credentialProvider (dict) --
The credential provider. This field contains the specific configuration for the credential provider type.
oauthCredentialProvider (dict) --
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
scopes (list) -- [REQUIRED]
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string) --
customParameters (dict) --
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
(string) --
(string) --
apiKeyCredentialProvider (dict) --
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
credentialParameterName (string) --
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
credentialPrefix (string) --
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
credentialLocation (string) --
The location of the API key credential. This field specifies where in the request the API key should be placed.
dict
Response Syntax
{
'gatewayArn': 'string',
'targetId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
'statusReasons': [
'string',
],
'name': 'string',
'description': 'string',
'targetConfiguration': {
'mcp': {
'openApiSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'smithyModel': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'lambda': {
'lambdaArn': 'string',
'toolSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': [
{
'name': 'string',
'description': 'string',
'inputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
},
'outputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
}
},
]
}
},
'mcpServer': {
'endpoint': 'string'
}
}
},
'credentialProviderConfigurations': [
{
'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'apiKeyCredentialProvider': {
'providerArn': 'string',
'credentialParameterName': 'string',
'credentialPrefix': 'string',
'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
}
}
},
],
'lastSynchronizedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
gatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway.
targetId (string) --
The unique identifier of the created target.
createdAt (datetime) --
The timestamp when the target was created.
updatedAt (datetime) --
The timestamp when the target was last updated.
status (string) --
The current status of the target.
statusReasons (list) --
The reasons for the current status of the target.
(string) --
name (string) --
The name of the target.
description (string) --
The description of the target.
targetConfiguration (dict) --
The configuration settings for the target.
mcp (dict) --
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
openApiSchema (dict) --
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
smithyModel (dict) --
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
lambda (dict) --
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
toolSchema (dict) --
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
s3 (dict) --
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (list) --
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(dict) --
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name (string) --
The name of the tool. This name identifies the tool in the Model Context Protocol.
description (string) --
The description of the tool. This description provides information about the purpose and usage of the tool.
inputSchema (dict) --
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
outputSchema (dict) --
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
mcpServer (dict) --
The MCP server specified as the gateway target.
endpoint (string) --
The endpoint for the MCP server target configuration.
credentialProviderConfigurations (list) --
The credential provider configurations for the target.
(dict) --
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType (string) --
The type of credential provider. This field specifies which authentication method the gateway uses.
credentialProvider (dict) --
The credential provider. This field contains the specific configuration for the credential provider type.
oauthCredentialProvider (dict) --
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
scopes (list) --
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string) --
customParameters (dict) --
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
(string) --
(string) --
apiKeyCredentialProvider (dict) --
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
credentialParameterName (string) --
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
credentialPrefix (string) --
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
credentialLocation (string) --
The location of the API key credential. This field specifies where in the request the API key should be placed.
lastSynchronizedAt (datetime) --
The last synchronization of the target.
{'memoryStrategies': {'customMemoryStrategy': {'configuration': {'selfManagedConfiguration': {'historicalContextWindowSize': 'integer',
'invocationConfiguration': {'payloadDeliveryBucketName': 'string',
'topicArn': 'string'},
'triggerConditions': [{'messageBasedTrigger': {'messageCount': 'integer'},
'timeBasedTrigger': {'idleSessionTimeout': 'integer'},
'tokenBasedTrigger': {'tokenCount': 'integer'}}]}}}}}
Response {'memory': {'strategies': {'configuration': {'selfManagedConfiguration': {'historicalContextWindowSize': 'integer',
'invocationConfiguration': {'payloadDeliveryBucketName': 'string',
'topicArn': 'string'},
'triggerConditions': [{'messageBasedTrigger': {'messageCount': 'integer'},
'timeBasedTrigger': {'idleSessionTimeout': 'integer'},
'tokenBasedTrigger': {'tokenCount': 'integer'}}]},
'type': {'SELF_MANAGED'}}}}}
Creates a new Amazon Bedrock AgentCore Memory resource.
See also: AWS API Documentation
Request Syntax
client.create_memory(
clientToken='string',
name='string',
description='string',
encryptionKeyArn='string',
memoryExecutionRoleArn='string',
eventExpiryDuration=123,
memoryStrategies=[
{
'semanticMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
]
},
'summaryMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
]
},
'userPreferenceMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
]
},
'customMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
],
'configuration': {
'semanticOverride': {
'extraction': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'consolidation': {
'appendToPrompt': 'string',
'modelId': 'string'
}
},
'summaryOverride': {
'consolidation': {
'appendToPrompt': 'string',
'modelId': 'string'
}
},
'userPreferenceOverride': {
'extraction': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'consolidation': {
'appendToPrompt': 'string',
'modelId': 'string'
}
},
'selfManagedConfiguration': {
'triggerConditions': [
{
'messageBasedTrigger': {
'messageCount': 123
},
'tokenBasedTrigger': {
'tokenCount': 123
},
'timeBasedTrigger': {
'idleSessionTimeout': 123
}
},
],
'invocationConfiguration': {
'topicArn': 'string',
'payloadDeliveryBucketName': 'string'
},
'historicalContextWindowSize': 123
}
}
}
},
],
tags={
'string': 'string'
}
)
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the memory. The name must be unique within your account.
string
The description of the memory.
string
The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.
string
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.
integer
[REQUIRED]
The duration after which memory events expire. Specified as an ISO 8601 duration.
list
The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.
(dict) --
Contains input information for creating a memory strategy.
semanticMemoryStrategy (dict) --
Input for creating a semantic memory strategy.
name (string) -- [REQUIRED]
The name of the semantic memory strategy.
description (string) --
The description of the semantic memory strategy.
namespaces (list) --
The namespaces associated with the semantic memory strategy.
(string) --
summaryMemoryStrategy (dict) --
Input for creating a summary memory strategy.
name (string) -- [REQUIRED]
The name of the summary memory strategy.
description (string) --
The description of the summary memory strategy.
namespaces (list) --
The namespaces associated with the summary memory strategy.
(string) --
userPreferenceMemoryStrategy (dict) --
Input for creating a user preference memory strategy.
name (string) -- [REQUIRED]
The name of the user preference memory strategy.
description (string) --
The description of the user preference memory strategy.
namespaces (list) --
The namespaces associated with the user preference memory strategy.
(string) --
customMemoryStrategy (dict) --
Input for creating a custom memory strategy.
name (string) -- [REQUIRED]
The name of the custom memory strategy.
description (string) --
The description of the custom memory strategy.
namespaces (list) --
The namespaces associated with the custom memory strategy.
(string) --
configuration (dict) --
The configuration for the custom memory strategy.
semanticOverride (dict) --
The semantic override configuration for a custom memory strategy.
extraction (dict) --
The extraction configuration for a semantic override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for semantic extraction.
modelId (string) -- [REQUIRED]
The model ID to use for semantic extraction.
consolidation (dict) --
The consolidation configuration for a semantic override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for semantic consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for semantic consolidation.
summaryOverride (dict) --
The summary override configuration for a custom memory strategy.
consolidation (dict) --
The consolidation configuration for a summary override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for summary consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for summary consolidation.
userPreferenceOverride (dict) --
The user preference override configuration for a custom memory strategy.
extraction (dict) --
The extraction configuration for a user preference override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for user preference extraction.
modelId (string) -- [REQUIRED]
The model ID to use for user preference extraction.
consolidation (dict) --
The consolidation configuration for a user preference override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for user preference consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for user preference consolidation.
selfManagedConfiguration (dict) --
The self managed configuration for a custom memory strategy.
triggerConditions (list) --
A list of conditions that trigger memory processing.
(dict) --
Condition that triggers memory processing.
messageBasedTrigger (dict) --
Message based trigger configuration.
messageCount (integer) --
The number of messages that trigger memory processing.
tokenBasedTrigger (dict) --
Token based trigger configuration.
tokenCount (integer) --
Number of tokens that trigger memory processing.
timeBasedTrigger (dict) --
Time based trigger configuration.
idleSessionTimeout (integer) --
Idle session timeout (seconds) that triggers memory processing.
invocationConfiguration (dict) -- [REQUIRED]
Configuration to invoke a self-managed memory processing pipeline with.
topicArn (string) -- [REQUIRED]
The ARN of the SNS topic for job notifications.
payloadDeliveryBucketName (string) -- [REQUIRED]
The S3 bucket name for event payload delivery.
historicalContextWindowSize (integer) --
Number of historical messages to include in processing context.
dict
A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
(string) --
(string) --
dict
Response Syntax
{
'memory': {
'arn': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'encryptionKeyArn': 'string',
'memoryExecutionRoleArn': 'string',
'eventExpiryDuration': 123,
'status': 'CREATING'|'ACTIVE'|'FAILED'|'DELETING',
'failureReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'strategies': [
{
'strategyId': 'string',
'name': 'string',
'description': 'string',
'configuration': {
'type': 'SEMANTIC_OVERRIDE'|'SUMMARY_OVERRIDE'|'USER_PREFERENCE_OVERRIDE'|'SELF_MANAGED',
'extraction': {
'customExtractionConfiguration': {
'semanticExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'consolidation': {
'customConsolidationConfiguration': {
'semanticConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'summaryConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'selfManagedConfiguration': {
'triggerConditions': [
{
'messageBasedTrigger': {
'messageCount': 123
},
'tokenBasedTrigger': {
'tokenCount': 123
},
'timeBasedTrigger': {
'idleSessionTimeout': 123
}
},
],
'invocationConfiguration': {
'topicArn': 'string',
'payloadDeliveryBucketName': 'string'
},
'historicalContextWindowSize': 123
}
},
'type': 'SEMANTIC'|'SUMMARIZATION'|'USER_PREFERENCE'|'CUSTOM',
'namespaces': [
'string',
],
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'
},
]
}
}
Response Structure
(dict) --
memory (dict) --
The details of the created memory, including its ID, ARN, name, description, and configuration settings.
arn (string) --
The Amazon Resource Name (ARN) of the memory.
id (string) --
The unique identifier of the memory.
name (string) --
The name of the memory.
description (string) --
The description of the memory.
encryptionKeyArn (string) --
The ARN of the KMS key used to encrypt the memory.
memoryExecutionRoleArn (string) --
The ARN of the IAM role that provides permissions for the memory.
eventExpiryDuration (integer) --
The number of days after which memory events will expire.
status (string) --
The current status of the memory.
failureReason (string) --
The reason for failure if the memory is in a failed state.
createdAt (datetime) --
The timestamp when the memory was created.
updatedAt (datetime) --
The timestamp when the memory was last updated.
strategies (list) --
The list of memory strategies associated with this memory.
(dict) --
Contains information about a memory strategy.
strategyId (string) --
The unique identifier of the memory strategy.
name (string) --
The name of the memory strategy.
description (string) --
The description of the memory strategy.
configuration (dict) --
The configuration of the memory strategy.
type (string) --
The type of override for the strategy configuration.
extraction (dict) --
The extraction configuration for the memory strategy.
customExtractionConfiguration (dict) --
The custom extraction configuration.
semanticExtractionOverride (dict) --
The semantic extraction override configuration.
appendToPrompt (string) --
The text to append to the prompt for semantic extraction.
modelId (string) --
The model ID to use for semantic extraction.
userPreferenceExtractionOverride (dict) --
The user preference extraction override configuration.
appendToPrompt (string) --
The text to append to the prompt for user preference extraction.
modelId (string) --
The model ID to use for user preference extraction.
consolidation (dict) --
The consolidation configuration for the memory strategy.
customConsolidationConfiguration (dict) --
The custom consolidation configuration.
semanticConsolidationOverride (dict) --
The semantic consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for semantic consolidation.
modelId (string) --
The model ID to use for semantic consolidation.
summaryConsolidationOverride (dict) --
The summary consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for summary consolidation.
modelId (string) --
The model ID to use for summary consolidation.
userPreferenceConsolidationOverride (dict) --
The user preference consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for user preference consolidation.
modelId (string) --
The model ID to use for user preference consolidation.
selfManagedConfiguration (dict) --
Self-managed configuration settings.
triggerConditions (list) --
A list of conditions that trigger memory processing.
(dict) --
Condition that triggers memory processing.
messageBasedTrigger (dict) --
Message based trigger configuration.
messageCount (integer) --
The number of messages that trigger memory processing.
tokenBasedTrigger (dict) --
Token based trigger configuration.
tokenCount (integer) --
Number of tokens that trigger memory processing.
timeBasedTrigger (dict) --
Time based trigger configuration.
idleSessionTimeout (integer) --
Idle session timeout (seconds) that triggers memory processing.
invocationConfiguration (dict) --
The configuration to use when invoking memory processing.
topicArn (string) --
The ARN of the SNS topic for job notifications.
payloadDeliveryBucketName (string) --
The S3 bucket name for event payload delivery.
historicalContextWindowSize (integer) --
The number of historical messages to include in processing context.
type (string) --
The type of the memory strategy.
namespaces (list) --
The namespaces associated with the memory strategy.
(string) --
createdAt (datetime) --
The timestamp when the memory strategy was created.
updatedAt (datetime) --
The timestamp when the memory strategy was last updated.
status (string) --
The current status of the memory strategy.
{'status': {'SYNCHRONIZING', 'SYNCHRONIZE_UNSUCCESSFUL'}}
Deletes a gateway target.
See also: AWS API Documentation
Request Syntax
client.delete_gateway_target(
gatewayIdentifier='string',
targetId='string'
)
string
[REQUIRED]
The unique identifier of the gateway associated with the target.
string
[REQUIRED]
The unique identifier of the gateway target to delete.
dict
Response Syntax
{
'gatewayArn': 'string',
'targetId': 'string',
'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
'statusReasons': [
'string',
]
}
Response Structure
(dict) --
gatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway.
targetId (string) --
The unique identifier of the deleted gateway target.
status (string) --
The current status of the gateway target deletion.
statusReasons (list) --
The reasons for the current status of the gateway target deletion.
(string) --
{'lastSynchronizedAt': 'timestamp',
'status': {'SYNCHRONIZING', 'SYNCHRONIZE_UNSUCCESSFUL'},
'targetConfiguration': {'mcp': {'mcpServer': {'endpoint': 'string'}}}}
Retrieves information about a specific gateway target.
See also: AWS API Documentation
Request Syntax
client.get_gateway_target(
gatewayIdentifier='string',
targetId='string'
)
string
[REQUIRED]
The identifier of the gateway that contains the target.
string
[REQUIRED]
The unique identifier of the target to retrieve.
dict
Response Syntax
{
'gatewayArn': 'string',
'targetId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
'statusReasons': [
'string',
],
'name': 'string',
'description': 'string',
'targetConfiguration': {
'mcp': {
'openApiSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'smithyModel': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'lambda': {
'lambdaArn': 'string',
'toolSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': [
{
'name': 'string',
'description': 'string',
'inputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
},
'outputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
}
},
]
}
},
'mcpServer': {
'endpoint': 'string'
}
}
},
'credentialProviderConfigurations': [
{
'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'apiKeyCredentialProvider': {
'providerArn': 'string',
'credentialParameterName': 'string',
'credentialPrefix': 'string',
'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
}
}
},
],
'lastSynchronizedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
gatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway.
targetId (string) --
The unique identifier of the gateway target.
createdAt (datetime) --
The timestamp when the gateway target was created.
updatedAt (datetime) --
The timestamp when the gateway target was last updated.
status (string) --
The current status of the gateway target.
statusReasons (list) --
The reasons for the current status of the gateway target.
(string) --
name (string) --
The name of the gateway target.
description (string) --
The description of the gateway target.
targetConfiguration (dict) --
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
mcp (dict) --
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
openApiSchema (dict) --
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
smithyModel (dict) --
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
lambda (dict) --
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
toolSchema (dict) --
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
s3 (dict) --
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (list) --
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(dict) --
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name (string) --
The name of the tool. This name identifies the tool in the Model Context Protocol.
description (string) --
The description of the tool. This description provides information about the purpose and usage of the tool.
inputSchema (dict) --
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
outputSchema (dict) --
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
mcpServer (dict) --
The MCP server specified as the gateway target.
endpoint (string) --
The endpoint for the MCP server target configuration.
credentialProviderConfigurations (list) --
The credential provider configurations for the gateway target.
(dict) --
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType (string) --
The type of credential provider. This field specifies which authentication method the gateway uses.
credentialProvider (dict) --
The credential provider. This field contains the specific configuration for the credential provider type.
oauthCredentialProvider (dict) --
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
scopes (list) --
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string) --
customParameters (dict) --
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
(string) --
(string) --
apiKeyCredentialProvider (dict) --
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
credentialParameterName (string) --
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
credentialPrefix (string) --
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
credentialLocation (string) --
The location of the API key credential. This field specifies where in the request the API key should be placed.
lastSynchronizedAt (datetime) --
The last synchronization of the target.
{'memory': {'strategies': {'configuration': {'selfManagedConfiguration': {'historicalContextWindowSize': 'integer',
'invocationConfiguration': {'payloadDeliveryBucketName': 'string',
'topicArn': 'string'},
'triggerConditions': [{'messageBasedTrigger': {'messageCount': 'integer'},
'timeBasedTrigger': {'idleSessionTimeout': 'integer'},
'tokenBasedTrigger': {'tokenCount': 'integer'}}]},
'type': {'SELF_MANAGED'}}}}}
Retrieve an existing Amazon Bedrock AgentCore Memory resource.
See also: AWS API Documentation
Request Syntax
client.get_memory(
memoryId='string'
)
string
[REQUIRED]
The unique identifier of the memory to retrieve.
dict
Response Syntax
{
'memory': {
'arn': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'encryptionKeyArn': 'string',
'memoryExecutionRoleArn': 'string',
'eventExpiryDuration': 123,
'status': 'CREATING'|'ACTIVE'|'FAILED'|'DELETING',
'failureReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'strategies': [
{
'strategyId': 'string',
'name': 'string',
'description': 'string',
'configuration': {
'type': 'SEMANTIC_OVERRIDE'|'SUMMARY_OVERRIDE'|'USER_PREFERENCE_OVERRIDE'|'SELF_MANAGED',
'extraction': {
'customExtractionConfiguration': {
'semanticExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'consolidation': {
'customConsolidationConfiguration': {
'semanticConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'summaryConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'selfManagedConfiguration': {
'triggerConditions': [
{
'messageBasedTrigger': {
'messageCount': 123
},
'tokenBasedTrigger': {
'tokenCount': 123
},
'timeBasedTrigger': {
'idleSessionTimeout': 123
}
},
],
'invocationConfiguration': {
'topicArn': 'string',
'payloadDeliveryBucketName': 'string'
},
'historicalContextWindowSize': 123
}
},
'type': 'SEMANTIC'|'SUMMARIZATION'|'USER_PREFERENCE'|'CUSTOM',
'namespaces': [
'string',
],
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'
},
]
}
}
Response Structure
(dict) --
memory (dict) --
The retrieved AgentCore Memory resource details.
arn (string) --
The Amazon Resource Name (ARN) of the memory.
id (string) --
The unique identifier of the memory.
name (string) --
The name of the memory.
description (string) --
The description of the memory.
encryptionKeyArn (string) --
The ARN of the KMS key used to encrypt the memory.
memoryExecutionRoleArn (string) --
The ARN of the IAM role that provides permissions for the memory.
eventExpiryDuration (integer) --
The number of days after which memory events will expire.
status (string) --
The current status of the memory.
failureReason (string) --
The reason for failure if the memory is in a failed state.
createdAt (datetime) --
The timestamp when the memory was created.
updatedAt (datetime) --
The timestamp when the memory was last updated.
strategies (list) --
The list of memory strategies associated with this memory.
(dict) --
Contains information about a memory strategy.
strategyId (string) --
The unique identifier of the memory strategy.
name (string) --
The name of the memory strategy.
description (string) --
The description of the memory strategy.
configuration (dict) --
The configuration of the memory strategy.
type (string) --
The type of override for the strategy configuration.
extraction (dict) --
The extraction configuration for the memory strategy.
customExtractionConfiguration (dict) --
The custom extraction configuration.
semanticExtractionOverride (dict) --
The semantic extraction override configuration.
appendToPrompt (string) --
The text to append to the prompt for semantic extraction.
modelId (string) --
The model ID to use for semantic extraction.
userPreferenceExtractionOverride (dict) --
The user preference extraction override configuration.
appendToPrompt (string) --
The text to append to the prompt for user preference extraction.
modelId (string) --
The model ID to use for user preference extraction.
consolidation (dict) --
The consolidation configuration for the memory strategy.
customConsolidationConfiguration (dict) --
The custom consolidation configuration.
semanticConsolidationOverride (dict) --
The semantic consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for semantic consolidation.
modelId (string) --
The model ID to use for semantic consolidation.
summaryConsolidationOverride (dict) --
The summary consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for summary consolidation.
modelId (string) --
The model ID to use for summary consolidation.
userPreferenceConsolidationOverride (dict) --
The user preference consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for user preference consolidation.
modelId (string) --
The model ID to use for user preference consolidation.
selfManagedConfiguration (dict) --
Self-managed configuration settings.
triggerConditions (list) --
A list of conditions that trigger memory processing.
(dict) --
Condition that triggers memory processing.
messageBasedTrigger (dict) --
Message based trigger configuration.
messageCount (integer) --
The number of messages that trigger memory processing.
tokenBasedTrigger (dict) --
Token based trigger configuration.
tokenCount (integer) --
Number of tokens that trigger memory processing.
timeBasedTrigger (dict) --
Time based trigger configuration.
idleSessionTimeout (integer) --
Idle session timeout (seconds) that triggers memory processing.
invocationConfiguration (dict) --
The configuration to use when invoking memory processing.
topicArn (string) --
The ARN of the SNS topic for job notifications.
payloadDeliveryBucketName (string) --
The S3 bucket name for event payload delivery.
historicalContextWindowSize (integer) --
The number of historical messages to include in processing context.
type (string) --
The type of the memory strategy.
namespaces (list) --
The namespaces associated with the memory strategy.
(string) --
createdAt (datetime) --
The timestamp when the memory strategy was created.
updatedAt (datetime) --
The timestamp when the memory strategy was last updated.
status (string) --
The current status of the memory strategy.
{'items': {'status': {'SYNCHRONIZING', 'SYNCHRONIZE_UNSUCCESSFUL'}}}
Lists all targets for a specific gateway.
See also: AWS API Documentation
Request Syntax
client.list_gateway_targets(
gatewayIdentifier='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the gateway to list targets for.
integer
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
string
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
dict
Response Syntax
{
'items': [
{
'targetId': 'string',
'name': 'string',
'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The list of gateway target summaries.
(dict) --
Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.
targetId (string) --
The unique identifier of the target.
name (string) --
The name of the target.
status (string) --
The current status of the target.
description (string) --
The description of the target.
createdAt (datetime) --
The timestamp when the target was created.
updatedAt (datetime) --
The timestamp when the target was last updated.
nextToken (string) --
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
{'targetConfiguration': {'mcp': {'mcpServer': {'endpoint': 'string'}}}}
Response {'lastSynchronizedAt': 'timestamp',
'status': {'SYNCHRONIZING', 'SYNCHRONIZE_UNSUCCESSFUL'},
'targetConfiguration': {'mcp': {'mcpServer': {'endpoint': 'string'}}}}
Updates an existing gateway target.
See also: AWS API Documentation
Request Syntax
client.update_gateway_target(
gatewayIdentifier='string',
targetId='string',
name='string',
description='string',
targetConfiguration={
'mcp': {
'openApiSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'smithyModel': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'lambda': {
'lambdaArn': 'string',
'toolSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': [
{
'name': 'string',
'description': 'string',
'inputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
},
'outputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
}
},
]
}
},
'mcpServer': {
'endpoint': 'string'
}
}
},
credentialProviderConfigurations=[
{
'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'apiKeyCredentialProvider': {
'providerArn': 'string',
'credentialParameterName': 'string',
'credentialPrefix': 'string',
'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
}
}
},
]
)
string
[REQUIRED]
The unique identifier of the gateway associated with the target.
string
[REQUIRED]
The unique identifier of the gateway target to update.
string
[REQUIRED]
The updated name for the gateway target.
string
The updated description for the gateway target.
dict
[REQUIRED]
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
mcp (dict) --
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
openApiSchema (dict) --
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
smithyModel (dict) --
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
lambda (dict) --
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
toolSchema (dict) -- [REQUIRED]
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
s3 (dict) --
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (list) --
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(dict) --
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name (string) -- [REQUIRED]
The name of the tool. This name identifies the tool in the Model Context Protocol.
description (string) -- [REQUIRED]
The description of the tool. This description provides information about the purpose and usage of the tool.
inputSchema (dict) -- [REQUIRED]
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type (string) -- [REQUIRED]
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
outputSchema (dict) --
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type (string) -- [REQUIRED]
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
mcpServer (dict) --
The MCP server specified as the gateway target.
endpoint (string) -- [REQUIRED]
The endpoint for the MCP server target configuration.
list
The updated credential provider configurations for the gateway target.
(dict) --
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType (string) -- [REQUIRED]
The type of credential provider. This field specifies which authentication method the gateway uses.
credentialProvider (dict) --
The credential provider. This field contains the specific configuration for the credential provider type.
oauthCredentialProvider (dict) --
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
scopes (list) -- [REQUIRED]
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string) --
customParameters (dict) --
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
(string) --
(string) --
apiKeyCredentialProvider (dict) --
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
credentialParameterName (string) --
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
credentialPrefix (string) --
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
credentialLocation (string) --
The location of the API key credential. This field specifies where in the request the API key should be placed.
dict
Response Syntax
{
'gatewayArn': 'string',
'targetId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED'|'SYNCHRONIZING'|'SYNCHRONIZE_UNSUCCESSFUL',
'statusReasons': [
'string',
],
'name': 'string',
'description': 'string',
'targetConfiguration': {
'mcp': {
'openApiSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'smithyModel': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': 'string'
},
'lambda': {
'lambdaArn': 'string',
'toolSchema': {
's3': {
'uri': 'string',
'bucketOwnerAccountId': 'string'
},
'inlinePayload': [
{
'name': 'string',
'description': 'string',
'inputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
},
'outputSchema': {
'type': 'string'|'number'|'object'|'array'|'boolean'|'integer',
'properties': {
'string': {'... recursive ...'}
},
'required': [
'string',
],
'items': {'... recursive ...'},
'description': 'string'
}
},
]
}
},
'mcpServer': {
'endpoint': 'string'
}
}
},
'credentialProviderConfigurations': [
{
'credentialProviderType': 'GATEWAY_IAM_ROLE'|'OAUTH'|'API_KEY',
'credentialProvider': {
'oauthCredentialProvider': {
'providerArn': 'string',
'scopes': [
'string',
],
'customParameters': {
'string': 'string'
}
},
'apiKeyCredentialProvider': {
'providerArn': 'string',
'credentialParameterName': 'string',
'credentialPrefix': 'string',
'credentialLocation': 'HEADER'|'QUERY_PARAMETER'
}
}
},
],
'lastSynchronizedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
gatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway.
targetId (string) --
The unique identifier of the updated gateway target.
createdAt (datetime) --
The timestamp when the gateway target was created.
updatedAt (datetime) --
The timestamp when the gateway target was last updated.
status (string) --
The current status of the updated gateway target.
statusReasons (list) --
The reasons for the current status of the updated gateway target.
(string) --
name (string) --
The updated name of the gateway target.
description (string) --
The updated description of the gateway target.
targetConfiguration (dict) --
The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.
mcp (dict) --
The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.
openApiSchema (dict) --
The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
smithyModel (dict) --
The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.
s3 (dict) --
The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (string) --
The inline payload containing the API schema definition.
lambda (dict) --
The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.
lambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.
toolSchema (dict) --
The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.
s3 (dict) --
The Amazon S3 location of the tool schema. This location contains the schema definition file.
uri (string) --
The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.
bucketOwnerAccountId (string) --
The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.
inlinePayload (list) --
The inline payload of the tool schema. This payload contains the schema definition directly in the request.
(dict) --
A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.
name (string) --
The name of the tool. This name identifies the tool in the Model Context Protocol.
description (string) --
The description of the tool. This description provides information about the purpose and usage of the tool.
inputSchema (dict) --
The input schema for the tool. This schema defines the structure of the input that the tool accepts.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
outputSchema (dict) --
The output schema for the tool. This schema defines the structure of the output that the tool produces.
type (string) --
The type of the schema definition. This field specifies the data type of the schema.
properties (dict) --
The properties of the schema definition. These properties define the fields in the schema.
(string) --
(dict) --
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
required (list) --
The required fields in the schema definition. These fields must be provided when using the schema.
(string) --
items (dict) --
The items in the schema definition. This field is used for array types to define the structure of the array elements.
description (string) --
The description of the schema definition. This description provides information about the purpose and usage of the schema.
mcpServer (dict) --
The MCP server specified as the gateway target.
endpoint (string) --
The endpoint for the MCP server target configuration.
credentialProviderConfigurations (list) --
The updated credential provider configurations for the gateway target.
(dict) --
The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.
credentialProviderType (string) --
The type of credential provider. This field specifies which authentication method the gateway uses.
credentialProvider (dict) --
The credential provider. This field contains the specific configuration for the credential provider type.
oauthCredentialProvider (dict) --
The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
scopes (list) --
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
(string) --
customParameters (dict) --
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
(string) --
(string) --
apiKeyCredentialProvider (dict) --
The API key credential provider. This provider uses an API key to authenticate with the target endpoint.
providerArn (string) --
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
credentialParameterName (string) --
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
credentialPrefix (string) --
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
credentialLocation (string) --
The location of the API key credential. This field specifies where in the request the API key should be placed.
lastSynchronizedAt (datetime) --
The date and time at which the targets were last synchronized.
{'memoryStrategies': {'addMemoryStrategies': {'customMemoryStrategy': {'configuration': {'selfManagedConfiguration': {'historicalContextWindowSize': 'integer',
'invocationConfiguration': {'payloadDeliveryBucketName': 'string',
'topicArn': 'string'},
'triggerConditions': [{'messageBasedTrigger': {'messageCount': 'integer'},
'timeBasedTrigger': {'idleSessionTimeout': 'integer'},
'tokenBasedTrigger': {'tokenCount': 'integer'}}]}}}},
'modifyMemoryStrategies': {'configuration': {'selfManagedConfiguration': {'historicalContextWindowSize': 'integer',
'invocationConfiguration': {'payloadDeliveryBucketName': 'string',
'topicArn': 'string'},
'triggerConditions': [{'messageBasedTrigger': {'messageCount': 'integer'},
'timeBasedTrigger': {'idleSessionTimeout': 'integer'},
'tokenBasedTrigger': {'tokenCount': 'integer'}}]}}}}}
Response {'memory': {'strategies': {'configuration': {'selfManagedConfiguration': {'historicalContextWindowSize': 'integer',
'invocationConfiguration': {'payloadDeliveryBucketName': 'string',
'topicArn': 'string'},
'triggerConditions': [{'messageBasedTrigger': {'messageCount': 'integer'},
'timeBasedTrigger': {'idleSessionTimeout': 'integer'},
'tokenBasedTrigger': {'tokenCount': 'integer'}}]},
'type': {'SELF_MANAGED'}}}}}
Update an Amazon Bedrock AgentCore Memory resource memory.
See also: AWS API Documentation
Request Syntax
client.update_memory(
clientToken='string',
memoryId='string',
description='string',
eventExpiryDuration=123,
memoryExecutionRoleArn='string',
memoryStrategies={
'addMemoryStrategies': [
{
'semanticMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
]
},
'summaryMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
]
},
'userPreferenceMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
]
},
'customMemoryStrategy': {
'name': 'string',
'description': 'string',
'namespaces': [
'string',
],
'configuration': {
'semanticOverride': {
'extraction': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'consolidation': {
'appendToPrompt': 'string',
'modelId': 'string'
}
},
'summaryOverride': {
'consolidation': {
'appendToPrompt': 'string',
'modelId': 'string'
}
},
'userPreferenceOverride': {
'extraction': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'consolidation': {
'appendToPrompt': 'string',
'modelId': 'string'
}
},
'selfManagedConfiguration': {
'triggerConditions': [
{
'messageBasedTrigger': {
'messageCount': 123
},
'tokenBasedTrigger': {
'tokenCount': 123
},
'timeBasedTrigger': {
'idleSessionTimeout': 123
}
},
],
'invocationConfiguration': {
'topicArn': 'string',
'payloadDeliveryBucketName': 'string'
},
'historicalContextWindowSize': 123
}
}
}
},
],
'modifyMemoryStrategies': [
{
'memoryStrategyId': 'string',
'description': 'string',
'namespaces': [
'string',
],
'configuration': {
'extraction': {
'customExtractionConfiguration': {
'semanticExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'consolidation': {
'customConsolidationConfiguration': {
'semanticConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'summaryConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'selfManagedConfiguration': {
'triggerConditions': [
{
'messageBasedTrigger': {
'messageCount': 123
},
'tokenBasedTrigger': {
'tokenCount': 123
},
'timeBasedTrigger': {
'idleSessionTimeout': 123
}
},
],
'invocationConfiguration': {
'topicArn': 'string',
'payloadDeliveryBucketName': 'string'
},
'historicalContextWindowSize': 123
}
}
},
],
'deleteMemoryStrategies': [
{
'memoryStrategyId': 'string'
},
]
}
)
string
A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the memory to update.
string
The updated description of the AgentCore Memory resource.
integer
The number of days after which memory events will expire, between 7 and 365 days.
string
The ARN of the IAM role that provides permissions for the AgentCore Memory resource.
dict
The memory strategies to add, modify, or delete.
addMemoryStrategies (list) --
The list of memory strategies to add.
(dict) --
Contains input information for creating a memory strategy.
semanticMemoryStrategy (dict) --
Input for creating a semantic memory strategy.
name (string) -- [REQUIRED]
The name of the semantic memory strategy.
description (string) --
The description of the semantic memory strategy.
namespaces (list) --
The namespaces associated with the semantic memory strategy.
(string) --
summaryMemoryStrategy (dict) --
Input for creating a summary memory strategy.
name (string) -- [REQUIRED]
The name of the summary memory strategy.
description (string) --
The description of the summary memory strategy.
namespaces (list) --
The namespaces associated with the summary memory strategy.
(string) --
userPreferenceMemoryStrategy (dict) --
Input for creating a user preference memory strategy.
name (string) -- [REQUIRED]
The name of the user preference memory strategy.
description (string) --
The description of the user preference memory strategy.
namespaces (list) --
The namespaces associated with the user preference memory strategy.
(string) --
customMemoryStrategy (dict) --
Input for creating a custom memory strategy.
name (string) -- [REQUIRED]
The name of the custom memory strategy.
description (string) --
The description of the custom memory strategy.
namespaces (list) --
The namespaces associated with the custom memory strategy.
(string) --
configuration (dict) --
The configuration for the custom memory strategy.
semanticOverride (dict) --
The semantic override configuration for a custom memory strategy.
extraction (dict) --
The extraction configuration for a semantic override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for semantic extraction.
modelId (string) -- [REQUIRED]
The model ID to use for semantic extraction.
consolidation (dict) --
The consolidation configuration for a semantic override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for semantic consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for semantic consolidation.
summaryOverride (dict) --
The summary override configuration for a custom memory strategy.
consolidation (dict) --
The consolidation configuration for a summary override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for summary consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for summary consolidation.
userPreferenceOverride (dict) --
The user preference override configuration for a custom memory strategy.
extraction (dict) --
The extraction configuration for a user preference override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for user preference extraction.
modelId (string) -- [REQUIRED]
The model ID to use for user preference extraction.
consolidation (dict) --
The consolidation configuration for a user preference override.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for user preference consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for user preference consolidation.
selfManagedConfiguration (dict) --
The self managed configuration for a custom memory strategy.
triggerConditions (list) --
A list of conditions that trigger memory processing.
(dict) --
Condition that triggers memory processing.
messageBasedTrigger (dict) --
Message based trigger configuration.
messageCount (integer) --
The number of messages that trigger memory processing.
tokenBasedTrigger (dict) --
Token based trigger configuration.
tokenCount (integer) --
Number of tokens that trigger memory processing.
timeBasedTrigger (dict) --
Time based trigger configuration.
idleSessionTimeout (integer) --
Idle session timeout (seconds) that triggers memory processing.
invocationConfiguration (dict) -- [REQUIRED]
Configuration to invoke a self-managed memory processing pipeline with.
topicArn (string) -- [REQUIRED]
The ARN of the SNS topic for job notifications.
payloadDeliveryBucketName (string) -- [REQUIRED]
The S3 bucket name for event payload delivery.
historicalContextWindowSize (integer) --
Number of historical messages to include in processing context.
modifyMemoryStrategies (list) --
The list of memory strategies to modify.
(dict) --
Input for modifying a memory strategy.
memoryStrategyId (string) -- [REQUIRED]
The unique identifier of the memory strategy to modify.
description (string) --
The updated description of the memory strategy.
namespaces (list) --
The updated namespaces for the memory strategy.
(string) --
configuration (dict) --
The updated configuration for the memory strategy.
extraction (dict) --
The updated extraction configuration.
customExtractionConfiguration (dict) --
The updated custom extraction configuration.
semanticExtractionOverride (dict) --
The semantic extraction override configuration input.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for semantic extraction.
modelId (string) -- [REQUIRED]
The model ID to use for semantic extraction.
userPreferenceExtractionOverride (dict) --
The user preference extraction override configuration input.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for user preference extraction.
modelId (string) -- [REQUIRED]
The model ID to use for user preference extraction.
consolidation (dict) --
The updated consolidation configuration.
customConsolidationConfiguration (dict) --
The updated custom consolidation configuration.
semanticConsolidationOverride (dict) --
The semantic consolidation override configuration input.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for semantic consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for semantic consolidation.
summaryConsolidationOverride (dict) --
The summary consolidation override configuration input.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for summary consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for summary consolidation.
userPreferenceConsolidationOverride (dict) --
The user preference consolidation override configuration input.
appendToPrompt (string) -- [REQUIRED]
The text to append to the prompt for user preference consolidation.
modelId (string) -- [REQUIRED]
The model ID to use for user preference consolidation.
selfManagedConfiguration (dict) --
The updated self-managed configuration.
triggerConditions (list) --
The updated list of conditions that trigger memory processing.
(dict) --
Condition that triggers memory processing.
messageBasedTrigger (dict) --
Message based trigger configuration.
messageCount (integer) --
The number of messages that trigger memory processing.
tokenBasedTrigger (dict) --
Token based trigger configuration.
tokenCount (integer) --
Number of tokens that trigger memory processing.
timeBasedTrigger (dict) --
Time based trigger configuration.
idleSessionTimeout (integer) --
Idle session timeout (seconds) that triggers memory processing.
invocationConfiguration (dict) --
The updated configuration to invoke self-managed memory processing pipeline.
topicArn (string) --
The updated ARN of the SNS topic for job notifications.
payloadDeliveryBucketName (string) --
The updated S3 bucket name for event payload delivery.
historicalContextWindowSize (integer) --
The updated number of historical messages to include in processing context.
deleteMemoryStrategies (list) --
The list of memory strategies to delete.
(dict) --
Input for deleting a memory strategy.
memoryStrategyId (string) -- [REQUIRED]
The unique identifier of the memory strategy to delete.
dict
Response Syntax
{
'memory': {
'arn': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'encryptionKeyArn': 'string',
'memoryExecutionRoleArn': 'string',
'eventExpiryDuration': 123,
'status': 'CREATING'|'ACTIVE'|'FAILED'|'DELETING',
'failureReason': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'strategies': [
{
'strategyId': 'string',
'name': 'string',
'description': 'string',
'configuration': {
'type': 'SEMANTIC_OVERRIDE'|'SUMMARY_OVERRIDE'|'USER_PREFERENCE_OVERRIDE'|'SELF_MANAGED',
'extraction': {
'customExtractionConfiguration': {
'semanticExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceExtractionOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'consolidation': {
'customConsolidationConfiguration': {
'semanticConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'summaryConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
},
'userPreferenceConsolidationOverride': {
'appendToPrompt': 'string',
'modelId': 'string'
}
}
},
'selfManagedConfiguration': {
'triggerConditions': [
{
'messageBasedTrigger': {
'messageCount': 123
},
'tokenBasedTrigger': {
'tokenCount': 123
},
'timeBasedTrigger': {
'idleSessionTimeout': 123
}
},
],
'invocationConfiguration': {
'topicArn': 'string',
'payloadDeliveryBucketName': 'string'
},
'historicalContextWindowSize': 123
}
},
'type': 'SEMANTIC'|'SUMMARIZATION'|'USER_PREFERENCE'|'CUSTOM',
'namespaces': [
'string',
],
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'
},
]
}
}
Response Structure
(dict) --
memory (dict) --
The updated AgentCore Memory resource details.
arn (string) --
The Amazon Resource Name (ARN) of the memory.
id (string) --
The unique identifier of the memory.
name (string) --
The name of the memory.
description (string) --
The description of the memory.
encryptionKeyArn (string) --
The ARN of the KMS key used to encrypt the memory.
memoryExecutionRoleArn (string) --
The ARN of the IAM role that provides permissions for the memory.
eventExpiryDuration (integer) --
The number of days after which memory events will expire.
status (string) --
The current status of the memory.
failureReason (string) --
The reason for failure if the memory is in a failed state.
createdAt (datetime) --
The timestamp when the memory was created.
updatedAt (datetime) --
The timestamp when the memory was last updated.
strategies (list) --
The list of memory strategies associated with this memory.
(dict) --
Contains information about a memory strategy.
strategyId (string) --
The unique identifier of the memory strategy.
name (string) --
The name of the memory strategy.
description (string) --
The description of the memory strategy.
configuration (dict) --
The configuration of the memory strategy.
type (string) --
The type of override for the strategy configuration.
extraction (dict) --
The extraction configuration for the memory strategy.
customExtractionConfiguration (dict) --
The custom extraction configuration.
semanticExtractionOverride (dict) --
The semantic extraction override configuration.
appendToPrompt (string) --
The text to append to the prompt for semantic extraction.
modelId (string) --
The model ID to use for semantic extraction.
userPreferenceExtractionOverride (dict) --
The user preference extraction override configuration.
appendToPrompt (string) --
The text to append to the prompt for user preference extraction.
modelId (string) --
The model ID to use for user preference extraction.
consolidation (dict) --
The consolidation configuration for the memory strategy.
customConsolidationConfiguration (dict) --
The custom consolidation configuration.
semanticConsolidationOverride (dict) --
The semantic consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for semantic consolidation.
modelId (string) --
The model ID to use for semantic consolidation.
summaryConsolidationOverride (dict) --
The summary consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for summary consolidation.
modelId (string) --
The model ID to use for summary consolidation.
userPreferenceConsolidationOverride (dict) --
The user preference consolidation override configuration.
appendToPrompt (string) --
The text to append to the prompt for user preference consolidation.
modelId (string) --
The model ID to use for user preference consolidation.
selfManagedConfiguration (dict) --
Self-managed configuration settings.
triggerConditions (list) --
A list of conditions that trigger memory processing.
(dict) --
Condition that triggers memory processing.
messageBasedTrigger (dict) --
Message based trigger configuration.
messageCount (integer) --
The number of messages that trigger memory processing.
tokenBasedTrigger (dict) --
Token based trigger configuration.
tokenCount (integer) --
Number of tokens that trigger memory processing.
timeBasedTrigger (dict) --
Time based trigger configuration.
idleSessionTimeout (integer) --
Idle session timeout (seconds) that triggers memory processing.
invocationConfiguration (dict) --
The configuration to use when invoking memory processing.
topicArn (string) --
The ARN of the SNS topic for job notifications.
payloadDeliveryBucketName (string) --
The S3 bucket name for event payload delivery.
historicalContextWindowSize (integer) --
The number of historical messages to include in processing context.
type (string) --
The type of the memory strategy.
namespaces (list) --
The namespaces associated with the memory strategy.
(string) --
createdAt (datetime) --
The timestamp when the memory strategy was created.
updatedAt (datetime) --
The timestamp when the memory strategy was last updated.
status (string) --
The current status of the memory strategy.