Skip to content

create_memory

create_memory(
    name: Name,
    event_expiry_duration: int,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    client_token: Optional[NonEmptyString] = None,
    description: Optional[Description] = None,
    encryption_key_arn: Optional[Arn] = None,
    memory_execution_role_arn: Optional[Arn] = None,
    memory_strategies: Optional[MemoryStrategyInputList] = None,
    indexed_keys: Optional[IndexedKeysList] = None,
    namespace_keys: Optional[NamespaceKeysList] = None,
    stream_delivery_resources: Optional[StreamDeliveryResources] = None,
    tags: Optional[TagsMap] = None,
) -> CreateMemoryOutput

Creates a new Amazon Bedrock AgentCore Memory resource.

Parameters:

  • client_token (Optional[NonEmptyString], default: None ) –

    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.

  • name (Name) –

    The name of the memory. The name must be unique within your account.

  • description (Optional[Description], default: None ) –

    The description of the memory.

  • encryption_key_arn (Optional[Arn], default: None ) –

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.

  • memory_execution_role_arn (Optional[Arn], default: None ) –

    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.

  • event_expiry_duration (int) –

    The duration after which memory events expire. Specified as an ISO 8601 duration.

  • memory_strategies (Optional[MemoryStrategyInputList], default: None ) –

    The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.

  • indexed_keys (Optional[IndexedKeysList], default: None ) –

    Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.

  • namespace_keys (Optional[NamespaceKeysList], default: None ) –

    The namespace variable key definitions with optional validation rules. Use these namespaceKeys in namespaceTemplates to control namespace hierarchy.

  • stream_delivery_resources (Optional[StreamDeliveryResources], default: None ) –

    Configuration for streaming memory record data to external resources.

  • tags (Optional[TagsMap], default: None ) –

    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.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def create_memory(
    self,
    name: "capo_bedrock_agentcore_control.types.name.Name",
    event_expiry_duration: int,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    client_token: Optional[
        "capo_bedrock_agentcore_control.types.non_empty_string.NonEmptyString"
    ] = None,
    description: Optional[
        "capo_bedrock_agentcore_control.types.description.Description"
    ] = None,
    encryption_key_arn: Optional[
        "capo_bedrock_agentcore_control.types.arn.Arn"
    ] = None,
    memory_execution_role_arn: Optional[
        "capo_bedrock_agentcore_control.types.arn.Arn"
    ] = None,
    memory_strategies: Optional[
        "capo_bedrock_agentcore_control.types.memory_strategy_input_list.MemoryStrategyInputList"
    ] = None,
    indexed_keys: Optional[
        "capo_bedrock_agentcore_control.types.indexed_keys_list.IndexedKeysList"
    ] = None,
    namespace_keys: Optional[
        "capo_bedrock_agentcore_control.types.namespace_keys_list.NamespaceKeysList"
    ] = None,
    stream_delivery_resources: Optional[
        "capo_bedrock_agentcore_control.types.stream_delivery_resources.StreamDeliveryResources"
    ] = None,
    tags: Optional["capo_bedrock_agentcore_control.types.tags_map.TagsMap"] = None,
) -> "capo_bedrock_agentcore_control.types.create_memory_output.CreateMemoryOutput":
    """<p>Creates a new Amazon Bedrock AgentCore Memory resource.</p>

    Args:
        client_token: <p>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.</p>
        name: <p>The name of the memory. The name must be unique within your account.</p>
        description: <p>The description of the memory.</p>
        encryption_key_arn: <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.</p>
        memory_execution_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.</p>
        event_expiry_duration: <p>The duration after which memory events expire. Specified as an ISO 8601 duration.</p>
        memory_strategies: <p>The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.</p>
        indexed_keys: <p>Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.</p>
        namespace_keys: <p>The namespace variable key definitions with optional validation rules. Use these <code>namespaceKeys</code> in <code>namespaceTemplates</code> to control namespace hierarchy.</p>
        stream_delivery_resources: <p>Configuration for streaming memory record data to external resources.</p>
        tags: <p>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.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.conflict_exception.ConflictException: <p>This exception is thrown when there is a conflict performing an operation</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.service_exception.ServiceException: <p>An internal error occurred.</p>
        capo_bedrock_agentcore_control.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This exception is thrown when a request is made beyond the service quota</p>
        capo_bedrock_agentcore_control.errors.throttled_exception.ThrottledException: <p>API rate limit has been exceeded.</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.create_memory_input.CreateMemoryInput]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.create_memory_output.CreateMemoryOutput"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.create_memory

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.create_memory.create_memory(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agentcore_control.types.create_memory_input.CreateMemoryInput",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore_control.types.create_memory_input

        return capo_bedrock_agentcore_control.types.create_memory_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_bedrock_agentcore_control.types.create_memory_output.CreateMemoryOutput",
    ) -> dict[str, Any]:
        import capo_bedrock_agentcore_control.types.create_memory_output

        return capo_bedrock_agentcore_control.types.create_memory_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateMemory", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_bedrock_agentcore_control.types.create_memory_input.CreateMemoryInput = {
        "name": name,
        "event_expiry_duration": event_expiry_duration,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if description is not None:
        input_["description"] = description
    if encryption_key_arn is not None:
        input_["encryption_key_arn"] = encryption_key_arn
    if memory_execution_role_arn is not None:
        input_["memory_execution_role_arn"] = memory_execution_role_arn
    if memory_strategies is not None:
        input_["memory_strategies"] = memory_strategies
    if indexed_keys is not None:
        input_["indexed_keys"] = indexed_keys
    if namespace_keys is not None:
        input_["namespace_keys"] = namespace_keys
    if stream_delivery_resources is not None:
        input_["stream_delivery_resources"] = stream_delivery_resources
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output