Device Management System
Overview
This use case implements a comprehensive Device Management System using Amazon Bedrock AgentCore. It provides a unified interface for managing IoT devices, WiFi networks, users, and activities through AWS Lambda, allowing users to interact with their smart home devices through natural language.
Information | Details |
---|---|
Use case type | Conversational |
Agent type | Single agent |
Use case components | Tools, Gateway |
Use case vertical | IoT/Smart Home |
Example complexity | Intermediate |
SDK used | Amazon Bedrock AgentCore SDK, boto3 |
Use case Architecture
Process Flow
-
User Interaction: Users interact with the Device Management system through Amazon Q or other clients that support the MCP protocol.
-
Request Processing:
- The request is sent to Amazon Bedrock AgentCore
- AgentCore routes the request to the appropriate Gateway
- The Gateway forwards the request to the Gateway Target (Lambda function)
-
Tool Execution:
- The Lambda function receives the request and identifies the appropriate tool to execute
- The function interacts with DynamoDB tables to perform CRUD operations
- Results are processed and formatted according to the MCP protocol
-
Response Flow:
- The Lambda function returns the response to the Gateway
- The Gateway forwards the response back to AgentCore
- AgentCore delivers the response to the client
-
Data Flow: All device data, user information, and configuration settings are stored in and retrieved from DynamoDB tables.
Use case key Features
The Device Management System provides the following capabilities:
- List devices in the system
- Get device settings
- List WiFi networks for a device
- Update WiFi network settings (SSID, security type)
- List users within an account
- Query user activity within a time period
Prerequisites
- Python 3.10+
- AWS account with appropriate permissions
- boto3 and Amazon Bedrock AgentCore SDK
- Cognito User Pool with configured app client
- Cognito Domain (optional but recommended for hosted UI)
- IAM Role for Bedrock Agent Core Gateway with appropriate permissions
Attach the below policy to your IAM role:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"iam:PassRole",
"bedrock-agentcore:*"
],
"Resource": "*"
}
]
}
Use case setup
1. Environment Configuration
Create a .env
file in the project root with the following variables:
# AWS and endpoint configuration
AWS_REGION=<Your AWS Region>
ENDPOINT_URL=https://bedrock-agentcore-control.<REGION>.amazonaws.com
# Lambda configuration
LAMBDA_ARN=arn:aws:lambda:<REGION>:your-account-id:function:DeviceManagementLambda
# Target configuration
GATEWAY_IDENTIFIER=your-gateway-identifier
TARGET_NAME=device-management-target
TARGET_DESCRIPTION=List, Update device management activities
# Gateway creation configuration
COGNITO_USERPOOL_ID=your-cognito-userpool-id
COGNITO_APP_CLIENT_ID=your-cognito-app-client-id
GATEWAY_NAME=Device-Management-Gateway
ROLE_ARN=arn:aws:iam::your-account-id:role/YourGatewayRole
GATEWAY_DESCRIPTION=Device Management Gateway
2. Install Dependencies
Install the required Python packages:
pip install -r requirements.txt
3. Deploy the Lambda Function
You can deploy the Lambda function using the provided deployment script:
chmod +x deploy.sh
./deploy.sh
The deployment script performs the following actions:
- Packages the Lambda function code with dependencies
- Creates an IAM role with necessary permissions (if it doesn't exist)
- Creates or updates the Lambda function
- Configures the function with appropriate memory and timeout settings
4. Create a Gateway (Optional if you want to use the existing gateway)
To create a new gateway, execute the below script:
python create_gateway.py
5. Create Gateway Target
After deploying the Lambda function, create a gateway target to expose the Lambda function as targets:
python device-management-target.py
6. Generate Test Data (Optional)
To populate the tables with synthetic test data:
python synthetic_data.py
Execution instructions
1. Test the Lambda Function
You can test the Lambda function locally using the provided test script:
python test_lambda.py
2. Invoking tools using Q CLI
Generating the Bearer Token
To generate the Bearer token required for authentication, use the following curl command to request an access token from the Cognito OAuth2 endpoint:
curl --http1.1 -X POST https://<cognito domain>.auth.us-west-2.amazoncognito.com/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=<client id>&client_secret=<client_secret>"
This command will return a JSON response containing the access token that should be used as the Bearer token in the MCP configuration.
Configuring MCP
Update the mcp.json file with this config:
cd ~/.aws/amazonq
vi mcp.json
## Update this json
{
"mcpServers": {
"<you_desired_mcp_server_name>": {
"command": "npx",
"timeout": 60000,
"args": [
"mcp-remote@latest",
"https://<gateway id>.gateway.bedrock-agentcore.<REGION>.amazonaws.com/mcp",
"--header",
"Authorization: Bearer <Bearer token>"
]
}
}
}
Replace <Bearer token>
with the access token obtained from the Cognito authentication request.
3. Sample prompts:
- "Can you list all the dormant devices?"
- "Can you update SSID for my device ID DG-10016 to XXXXXXXXXX'?"
- "Can you list all the available tools?"
- "Can you show me the device settings for the device ID DG-10016?"
- "Can you show me the Wifi setting for the device ID DB-10005?"
Clean up instructions
To clean up resources created by this use case:
- Delete the Lambda function:
aws lambda delete-function --function-name DeviceManagementLambda
- Delete the Gateway Target:
aws bedrock-agentcore delete-gateway-target --gateway-identifier <your-gateway-identifier> --target-name device-management-target
- Delete the Gateway (if you created a new one):
aws bedrock-agentcore delete-gateway --gateway-identifier <your-gateway-identifier>
- Delete the DynamoDB tables (if you created them for this use case):
aws dynamodb delete-table --table-name Devices
aws dynamodb delete-table --table-name DeviceSettings
aws dynamodb delete-table --table-name WifiNetworks
aws dynamodb delete-table --table-name Users
aws dynamodb delete-table --table-name UserActivities
Disclaimer
The examples provided in this repository are for experimental and educational purposes only. They demonstrate concepts and techniques but are not intended for direct use in production environments. Make sure to have Amazon Bedrock Guardrails in place to protect against prompt injection.
Additional Information
Files
lambda_function.py
: Main Lambda handler that implements all MCP toolsdynamodb_models.py
: DynamoDB table definitions and initializationsynthetic_data.py
: Script to generate synthetic test datarequirements.txt
: Python dependenciesdeploy.sh
: Deployment script for the Lambda functioncreate_gateway.py
: Script to create a gateway for the MCP serverdevice-management-target.py
: Script to create a gateway target for the Lambda function.env
: Environment variables configuration filetest_lambda.py
: Script to test the Lambda function locally
IAM Permissions
The Lambda function requires the following IAM permissions:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dynamodb:GetItem",
"dynamodb:Query",
"dynamodb:Scan",
"dynamodb:UpdateItem"
],
"Resource": [
"arn:aws:dynamodb:<Region>:*:table/Devices",
"arn:aws:dynamodb:<Region>:*:table/DeviceSettings",
"arn:aws:dynamodb:<Region>:*:table/WifiNetworks",
"arn:aws:dynamodb:<Region>:*:table/Users",
"arn:aws:dynamodb:<Region>:*:table/UserActivities",
"arn:aws:dynamodb:<Region>:*:table/UserActivities/index/ActivityTypeIndex"
]
}
]
}
Troubleshooting
- Missing environment variables: Ensure all required variables are set in the
.env
file - Lambda deployment failures: Check AWS IAM permissions and Lambda service quotas
- Gateway creation failures: Verify the Cognito User Pool ID, App Client ID, and IAM role ARN
- Gateway target creation failures: Verify the gateway identifier and Lambda ARN are correct
- DynamoDB access issues: Confirm the Lambda execution role has the necessary permissions