AWS aws-sdk-php documentation change
Summary
Added new API operations for managing sessions, invocations, and invocation steps in Amazon Bedrock. This includes operations like CreateSession, DeleteSession, CreateInvocation, GetInvocationStep, ListInvocationSteps, ListInvocations, ListSessions, PutInvocationStep, TagResource, UntagResource, and UpdateSession. Also added new data structures like BedrockSessionContentBlock, ImageBlock, ImageSource, InvocationStep, InvocationStepPayload, InvocationStepSummary, InvocationSummary, S3Location, and SessionSummary.
Security assessment
The changes add new API operations and data structures for managing sessions and invocations in Amazon Bedrock. While some operations involve encryption settings, there is no evidence these changes address specific security vulnerabilities or incidents. The changes are focused on adding new functionality rather than addressing security concerns.
Diff
diff --git a/aws-sdk-php/v3/api/api-bedrock-agent-runtime-2023-07-26.md index b82673b5c..36978b44e 100644 --- a/aws-sdk-php/v3/api/api-bedrock-agent-runtime-2023-07-26.md +++ b/aws-sdk-php/v3/api/api-bedrock-agent-runtime-2023-07-26.md @@ -470,0 +471,2 @@ You can also create and send a command immediately using the magic methods avail +**CreateInvocation** ( array $params = [] ) Creates a new invocation within a session. +**CreateSession** ( array $params = [] ) Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. @@ -471,0 +474,2 @@ You can also create and send a command immediately using the magic methods avail +**DeleteSession** ( array $params = [] ) Deletes a session that you ended. +**EndSession** ( array $params = [] ) Ends the session. @@ -473,0 +478,2 @@ You can also create and send a command immediately using the magic methods avail +**GetInvocationStep** ( array $params = [] ) Retrieves the details of a specific invocation step within an invocation in a session. +**GetSession** ( array $params = [] ) Retrieves details about a specific session. @@ -476,0 +483,4 @@ You can also create and send a command immediately using the magic methods avail +**ListInvocationSteps** ( array $params = [] ) Lists all invocation steps associated with a session and optionally, an invocation within the session. +**ListInvocations** ( array $params = [] ) Lists all invocations associated with a specific session. +**ListSessions** ( array $params = [] ) Lists all sessions in your Amazon Web Services account. +**ListTagsForResource** ( array $params = [] ) List all the tags for the resource you specify. @@ -477,0 +488 @@ You can also create and send a command immediately using the magic methods avail +**PutInvocationStep** ( array $params = [] ) Add an invocation step to an invocation in a session. @@ -481,0 +493,3 @@ You can also create and send a command immediately using the magic methods avail +**TagResource** ( array $params = [] ) Associate tags with a resource. +**UntagResource** ( array $params = [] ) Remove tags from a resource. +**UpdateSession** ( array $params = [] ) Updates the metadata or encryption settings of a session. @@ -487,0 +502,3 @@ Paginators handle automatically iterating over paginated API results. Paginators +**ListInvocationSteps** +**ListInvocations** +**ListSessions** @@ -493 +510 @@ Paginators handle automatically iterating over paginated API results. Paginators -### DeleteAgentMemory +### CreateInvocation @@ -496,2 +513,14 @@ Paginators handle automatically iterating over paginated API results. Paginators - $result = $client->deleteAgentMemory([/* ... */]); - $promise = $client->deleteAgentMemoryAsync([/* ... */]); + $result = $client->createInvocation([/* ... */]); + $promise = $client->createInvocationAsync([/* ... */]); + + +Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html). + +Related APIs + + * [ListInvocations](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html) + + * [ListSessions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListSessions.html) + + * [GetSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetSession.html) + @@ -500 +528,0 @@ Paginators handle automatically iterating over paginated API results. Paginators -Deletes memory from the specified memory identifier. @@ -505,5 +533,4 @@ Deletes memory from the specified memory identifier. - $result = $client->deleteAgentMemory([ - 'agentAliasId' => '<string>', // REQUIRED - 'agentId' => '<string>', // REQUIRED - 'memoryId' => '<string>', - 'sessionId' => '<string>', + $result = $client->createInvocation([ + 'description' => '<string>', + 'invocationId' => '<string>', + 'sessionIdentifier' => '<string>', // REQUIRED @@ -517 +544 @@ Deletes memory from the specified memory identifier. -**agentAliasId** +**description** @@ -520 +546,0 @@ Deletes memory from the specified memory identifier. - **Required** : _Yes_ @@ -523 +549 @@ Deletes memory from the specified memory identifier. -The unique identifier of an alias of an agent. +A description for the interactions in the invocation. For example, "User asking about weather in Seattle". @@ -525 +551 @@ The unique identifier of an alias of an agent. -**agentId** +**invocationId** @@ -528 +553,0 @@ The unique identifier of an alias of an agent. - **Required** : _Yes_ @@ -531 +556 @@ The unique identifier of an alias of an agent. -The unique identifier of the agent to which the alias belongs. +A unique identifier for the invocation in UUID format. @@ -533 +558 @@ The unique identifier of the agent to which the alias belongs. -**memoryId** +**sessionIdentifier** @@ -535,0 +561 @@ The unique identifier of the agent to which the alias belongs. + **Required** : _Yes_ @@ -538 +564 @@ The unique identifier of the agent to which the alias belongs. -The unique identifier of the memory. +The unique identifier for the associated session for the invocation. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN). @@ -540 +566 @@ The unique identifier of the memory. -**sessionId** +#### Result Syntax @@ -543 +569,5 @@ The unique identifier of the memory. - **Type:** _string_ + [ + 'createdAt' => <DateTime>, + 'invocationId' => '<string>', + 'sessionId' => '<string>', + ] @@ -545 +575 @@ The unique identifier of the memory. -The unique session identifier of the memory. +#### Result Details @@ -547 +577 @@ The unique session identifier of the memory. -#### Result Syntax +##### Members @@ -548,0 +579 @@ The unique session identifier of the memory. +**createdAt** @@ -550 +580,0 @@ The unique session identifier of the memory. - [] @@ -552 +582,6 @@ The unique session identifier of the memory. -#### Result Details + **Required** : _Yes_ + **Type:** _timestamp (string|DateTime or anything parsable by strtotime)_ + +The timestamp for when the invocation was created. + +**invocationId** @@ -554 +589,13 @@ The unique session identifier of the memory. -The results for this operation are always empty. + + **Required** : _Yes_ + **Type:** _string_ + +The unique identifier for the invocation. + +**sessionId** + + + **Required** : _Yes_ + **Type:** _string_ + +The unique identifier for the session associated with the invocation. @@ -574,8 +620,0 @@ An internal server error occurred. Retry your request. -[**DependencyFailedException:**](class-Aws.BedrockAgentRuntime.Exception.BedrockAgentRuntimeException.html#shape-dependencyfailedexception) - -There was an issue with a dependency. Check the resource configurations and retry the request. - -[**BadGatewayException:**](class-Aws.BedrockAgentRuntime.Exception.BedrockAgentRuntimeException.html#shape-badgatewayexception) - -There was an issue with a dependency due to a server issue. Retry your request. - @@ -594 +633 @@ The number of requests exceeds the service quota. Resubmit your request later. -### GenerateQuery +### CreateSession @@ -597,2 +636,20 @@ The number of requests exceeds the service quota. Resubmit your request later. - $result = $client->generateQuery([/* ... */]); - $promise = $client->generateQueryAsync([/* ... */]); + $result = $client->createSession([/* ... */]); + $promise = $client->createSessionAsync([/* ... */]); + + +Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html). + +By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see [Amazon Bedrock session encryption](https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html). + +You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/API_agent-runtime_InvokeAgent.html) API operation. + +Related APIs: + + * [ListSessions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListSessions.html) + + * [GetSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetSession.html) + + * [EndSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_EndSession.html) + + * [DeleteSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_DeleteSession.html) + @@ -601 +657,0 @@ The number of requests exceeds the service quota. Resubmit your request later. -Generates an SQL query from a natural language query. For more information, see [Generate a query for structured data](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-generate-query.html) in the Amazon Bedrock User Guide. @@ -606,14 +662,4 @@ Generates an SQL query from a natural language query. For more information, see - $result = $client->generateQuery([ - 'queryGenerationInput' => [ // REQUIRED - 'text' => '<string>', // REQUIRED - 'type' => 'TEXT', // REQUIRED - ], - 'transformationConfiguration' => [ // REQUIRED - 'mode' => 'TEXT_TO_SQL', // REQUIRED - 'textToSqlConfiguration' => [ - 'knowledgeBaseConfiguration' => [ - 'knowledgeBaseArn' => '<string>', // REQUIRED - ], - 'type' => 'KNOWLEDGE_BASE', // REQUIRED - ], - ], + $result = $client->createSession([ + 'encryptionKeyArn' => '<string>', + 'sessionMetadata' => ['<string>', ...], + 'tags' => ['<string>', ...], @@ -627 +673 @@ Generates an SQL query from a natural language query. For more information, see -**queryGenerationInput** +**encryptionKeyArn** @@ -630,2 +676 @@ Generates an SQL query from a natural language query. For more information, see - **Required** : _Yes_ - **Type:** _QueryGenerationInput structure_ + **Type:** _string_ @@ -633 +678 @@ Generates an SQL query from a natural language query. For more information, see -Specifies information about a natural language query to transform into SQL. +The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see [Amazon Bedrock session encryption](https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html). @@ -635 +680 @@ Specifies information about a natural language query to transform into SQL. -**transformationConfiguration** +**sessionMetadata** @@ -638,2 +683 @@ Specifies information about a natural language query to transform into SQL. - **Required** : _Yes_ - **Type:** _TransformationConfiguration structure_ + **Type:** _Associative array of custom strings keys (SessionMetadataKey) to strings_