Amazon Bedrock AgentCore Data Plane Fronting Layer Update: Remove superfluous field from API

Author: AWS

.attach_pid803

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Bedrock AgentCore Data Plane Fronting Layer",
+    "contributor": "",
+    "description": "Remove superfluous field from API"
+}

.changes/next-release/feature-AmazonBedrockAgentCoreDataPlaneFrontingLayer-4c53aff.json

@@ -31,7 +31,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Creates an event in a memory store. Events represent interactions or activities that occur within a session and are associated with specific actors.</p> <p>To use this operation, you must have the <code>genesismemory:CreateEvent</code> permission.</p> <p>This operation is subject to request rate limiting.</p>",
+      "documentation":"<p>Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:CreateEvent</code> permission.</p> <p>This operation is subject to request rate limiting.</p>",
       "idempotent":true
     },
     "DeleteEvent":{
@@ -52,7 +52,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Deletes an event from a memory store. When you delete an event, it is permanently removed.</p> <p>To use this operation, you must have the <code>genesismemory:DeleteEvent</code> permission.</p>"
+      "documentation":"<p>Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:DeleteEvent</code> permission.</p>"
     },
     "DeleteMemoryRecord":{
       "name":"DeleteMemoryRecord",
@@ -72,7 +72,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Deletes a memory record from a memory store. When you delete a memory record, it is permanently removed.</p> <p>To use this operation, you must have the <code>genesismemory:DeleteMemoryRecord</code> permission.</p>"
+      "documentation":"<p>Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:DeleteMemoryRecord</code> permission.</p>"
     },
     "GetBrowserSession":{
       "name":"GetBrowserSession",
@@ -128,7 +128,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Retrieves information about a specific event in a memory store.</p> <p>To use this operation, you must have the <code>genesismemory:GetEvent</code> permission.</p>"
+      "documentation":"<p>Retrieves information about a specific event in an AgentCore Memory resource.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:GetEvent</code> permission.</p>"
     },
     "GetMemoryRecord":{
       "name":"GetMemoryRecord",
@@ -148,7 +148,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Retrieves a specific memory record from a memory store.</p> <p>To use this operation, you must have the <code>genesismemory:GetMemoryRecord</code> permission.</p>"
+      "documentation":"<p>Retrieves a specific memory record from an AgentCore Memory resource.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:GetMemoryRecord</code> permission.</p>"
     },
     "GetResourceApiKey":{
       "name":"GetResourceApiKey",
@@ -186,7 +186,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Reaturns the Oauth2Token of the provided resource</p>"
+      "documentation":"<p>Returns the OAuth 2.0 token of the provided resource</p>"
     },
     "GetWorkloadAccessToken":{
       "name":"GetWorkloadAccessToken",
@@ -263,7 +263,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Sends a request to an agent runtime in Amazon Bedrock and receives responses in real-time. The agent processes the request using the configured foundation model and any associated knowledge bases or action groups.</p> <p>To invoke an agent runtime, you must specify the agent runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or alias of the agent.</p> <p>This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.</p>"
+      "documentation":"<p>Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time. </p> <p>To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.</p> <p>This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.</p> <p>For example code, see <a href=\"https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-invoke-agent.html\">Invoke an AgentCore Runtime agent</a>. </p> <p>If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call <code>InvokeAgentRuntime</code>. Instead, make a HTTPS request to <code>InvokeAgentRuntime</code>. For an example, see <a href=\"https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-oauth.html\">Authenticate and authorize with Inbound Auth and Outbound Auth</a>.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:InvokeAgentRuntime</code> permission.</p>"
     },
     "InvokeCodeInterpreter":{
       "name":"InvokeCodeInterpreter",
@@ -303,7 +303,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Lists all actors in a memory store. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>genesismemory:ListActors</code> permission.</p>"
+      "documentation":"<p>Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:ListActors</code> permission.</p>"
     },
     "ListBrowserSessions":{
       "name":"ListBrowserSessions",
@@ -359,7 +359,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Lists events in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>genesismemory:ListEvents</code> permission.</p>"
+      "documentation":"<p>Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:ListEvents</code> permission.</p>"
     },
     "ListMemoryRecords":{
       "name":"ListMemoryRecords",
@@ -379,7 +379,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Lists memory records in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>genesismemory:ListMemoryRecords</code> permission.</p>"
+      "documentation":"<p>Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:ListMemoryRecords</code> permission.</p>"
     },
     "ListSessions":{
       "name":"ListSessions",
@@ -399,7 +399,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Lists sessions in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>genesismemory:ListSessions</code> permission.</p>"
+      "documentation":"<p>Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:ListSessions</code> permission.</p>"
     },
     "RetrieveMemoryRecords":{
       "name":"RetrieveMemoryRecords",
@@ -419,7 +419,7 @@
         {"shape":"ThrottledException"},
         {"shape":"ServiceException"}
       ],
-      "documentation":"<p>Searches for and retrieves memory records from a memory store based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>genesismemory:RetrieveMemoryRecords</code> permission.</p>"
+      "documentation":"<p>Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:RetrieveMemoryRecords</code> permission.</p>"
     },
     "StartBrowserSession":{
       "name":"StartBrowserSession",
@@ -561,7 +561,7 @@
           "documentation":"<p>The unique identifier of the actor.</p>"
         }
       },
-      "documentation":"<p>Contains summary information about an actor in a memory store.</p>"
+      "documentation":"<p>Contains summary information about an actor in an AgentCore Memory resource.</p>"
     },
     "ActorSummaryList":{
       "type":"list",
@@ -632,7 +632,7 @@
           "documentation":"<p>The name of the branch.</p>"
         }
       },
-      "documentation":"<p>Contains information about a branch in a memory store. Branches allow for organizing events into different conversation threads or paths.</p>"
+      "documentation":"<p>Contains information about a branch in an AgentCore Memory resource. Branches allow for organizing events into different conversation threads or paths.</p>"
     },
     "BranchFilter":{
       "type":"structure",
@@ -944,7 +944,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store in which to create the event.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource in which to create the event.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1023,7 +1023,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store from which to delete the event.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource from which to delete the event.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1066,7 +1066,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store from which to delete the memory record.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource from which to delete the memory record.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1110,7 +1110,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store containing the event.</p>"
+          "documentation":"<p>The identifier of the AgentCore Memory resource containing the event.</p>"
         },
         "actorId":{
           "shape":"ActorId",
@@ -1137,7 +1137,7 @@
           "documentation":"<p>The branch information for the event.</p>"
         }
       },
-      "documentation":"<p>Contains information about an event in a memory store.</p>"
+      "documentation":"<p>Contains information about an event in an AgentCore Memory resource.</p>"
     },
     "EventId":{
       "type":"string",
@@ -1291,7 +1291,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store containing the event.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource containing the event.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1334,7 +1334,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store containing the memory record.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource containing the memory record.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1396,10 +1396,6 @@
           "shape":"WorkloadIdentityTokenType",
           "documentation":"<p>The identity token of the workload you want to retrive the Oauth2 Token of.</p>"
         },
-        "userId":{
-          "shape":"UserIdType",
-          "documentation":"<p>The user ID of the user you're retrieving the token on behalf of.</p>"
-        },
         "resourceCredentialProviderName":{
           "shape":"CredentialProviderName",
           "documentation":"<p>Reference to the credential provider</p>"
@@ -1643,7 +1639,7 @@
         },
         "qualifier":{
           "shape":"String",
-          "documentation":"<p>The qualifier to use for the agent runtime. This can be a version number or an alias name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.</p>",
+          "documentation":"<p>The qualifier to use for the agent runtime. This can be a version number or an endpoint name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.</p>",
           "location":"querystring",
           "locationName":"qualifier"
         },
@@ -1790,7 +1786,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store for which to list actors.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource for which to list actors.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1904,7 +1900,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store for which to list events.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource for which to list events.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -1961,7 +1957,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store for which to list memory records.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource for which to list memory records.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -2006,7 +2002,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store for which to list sessions.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource for which to list sessions.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -2112,7 +2108,7 @@
           "documentation":"<p>The timestamp when the memory record was created.</p>"
         }
       },
-      "documentation":"<p>Contains information about a memory record in a memory store.</p>"
+      "documentation":"<p>Contains information about a memory record in an AgentCore Memory resource.</p>"
     },
     "MemoryRecordId":{
       "type":"string",
@@ -2302,7 +2298,7 @@
       "members":{
         "memoryId":{
           "shape":"MemoryId",
-          "documentation":"<p>The identifier of the memory store from which to retrieve memory records.</p>",
+          "documentation":"<p>The identifier of the AgentCore Memory resource from which to retrieve memory records.</p>",
           "location":"uri",
           "locationName":"memoryId"
         },
@@ -2453,7 +2449,7 @@
           "documentation":"<p>The timestamp when the session was created.</p>"
         }
       },
-      "documentation":"<p>Contains summary information about a session in a memory store.</p>"
+      "documentation":"<p>Contains summary information about a session in an AgentCore Memory resource.</p>"
     },
     "SessionSummaryList":{
       "type":"list",
@@ -2977,5 +2973,5 @@
       "sensitive":true
     }
   },
-  "documentation":"<p><note> <p>Amazon Bedrock AgentCore is in preview release and is subject to change.</p> </note> <p>Data plane operations for Amazon Bedrock AgentCore.</p></p>"
+  "documentation":"<p><note> <p>Amazon Bedrock AgentCore is in preview release and is subject to change.</p> </note> <p>Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services. </p></p>"
 }