BedrockAgentCoreControlPlaneFrontingLayer / Client / get_memory

get_memory

BedrockAgentCoreControlPlaneFrontingLayer.Client.get_memory(**kwargs)

Retrieve an existing memory.

See also: AWS API Documentation

Request Syntax

response = client.get_memory(
    memoryId='string'
)
Parameters:

memoryId (string) –

[REQUIRED]

The unique identifier of the memory to retrieve.

Return type:

dict

Returns:

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

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: customExtractionConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • customExtractionConfiguration (dict) –

                The custom extraction configuration.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: semanticExtractionOverride, userPreferenceExtractionOverride. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

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

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: customConsolidationConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • customConsolidationConfiguration (dict) –

                The custom consolidation configuration.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: semanticConsolidationOverride, summaryConsolidationOverride, userPreferenceConsolidationOverride. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

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

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

Exceptions