AWS.Tools.BedrockAgent.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BedrockAgent</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet"> <summary> Ingests documents directly into the knowledge base that is connected to the data source. The <c>dataSourceType</c> specified in the content for each document must match the type of the data source that you specify in the header. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source connected to the knowledge base that you're adding documents to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet.Document"> <summary> <para> <para>A list of objects, each of which contains information about the documents to add.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to ingest the documents into.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.IngestKnowledgeBaseDocumentsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.IngestKnowledgeBaseDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABKnowledgeBaseDocumentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.AddAABResourceTagCmdlet"> <summary> Associate tags with a resource. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABResourceTagCmdlet.Tag"> <summary> <para> <para>An object containing key-value pairs that define the tags to attach to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.AddAABResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.ConfirmAABFlowDefinitionCmdlet"> <summary> Validates the definition of a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.ConfirmAABFlowDefinitionCmdlet.Definition_Connection"> <summary> <para> <para>An array of connection definitions in the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.ConfirmAABFlowDefinitionCmdlet.Definition_Node"> <summary> <para> <para>An array of node definitions in the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.ConfirmAABFlowDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Validations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ValidateFlowDefinitionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ValidateFlowDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.ConfirmAABFlowDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentCmdlet"> <summary> Gets information about an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Agent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetAgentResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupCmdlet"> <summary> Gets information about an action group for an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupCmdlet.ActionGroupId"> <summary> <para> <para>The unique identifier of the action group for which to get information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent that the action group belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent that the action group belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentActionGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetAgentActionGroupResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetAgentActionGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet"> <summary> Lists the action groups for an agent and information about each one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActionGroupSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListAgentActionGroupsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListAgentActionGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentActionGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasCmdlet"> <summary> Gets information about an alias of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasCmdlet.AgentAliasId"> <summary> <para> <para>The unique identifier of the alias for which to get information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent to which the alias to get information belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetAgentAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetAgentAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasListCmdlet"> <summary> Lists the aliases of an agent and information about each one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasListCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentAliasSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListAgentAliasesResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListAgentAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentAliasListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBaseCmdlet"> <summary> Gets information about a knowledge base associated with an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBaseCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent with which the knowledge base is associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBaseCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent with which the knowledge base is associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base associated with the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentKnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetAgentKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetAgentKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet"> <summary> Lists knowledge bases associated with an agent and information about each one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent for which to return information about knowledge bases associated with it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent for which to return information about knowledge bases associated with it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentKnowledgeBaseSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListAgentKnowledgeBasesResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListAgentKnowledgeBasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentKnowledgeBasisListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentListCmdlet"> <summary> Lists the agents belonging to an account and information about each agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListAgentsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListAgentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionCmdlet"> <summary> Gets details about a version of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetAgentVersionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetAgentVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionListCmdlet"> <summary> Lists the versions of an agent and information about each version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionListCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentVersionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListAgentVersionsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListAgentVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABAgentVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceCmdlet"> <summary> Gets information about a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetDataSourceResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceListCmdlet"> <summary> Lists the data sources in a knowledge base and information about each one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for which to return a list of information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSourceSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListDataSourcesResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListDataSourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABDataSourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowCmdlet"> <summary> Retrieves information about a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html">Manage a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetFlowResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasCmdlet"> <summary> Retrieves information about a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasCmdlet.AliasIdentifier"> <summary> <para> <para>The unique identifier of the alias for which to retrieve information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow that the alias belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetFlowAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetFlowAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasListCmdlet"> <summary> Returns a list of aliases for a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasListCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow for which aliases are being returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowAliasSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListFlowAliasesResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListFlowAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowAliasListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowListCmdlet"> <summary> Returns a list of flows and information about each flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html">Manage a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListFlowsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListFlowsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionCmdlet"> <summary> Retrieves information about a version of a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow for which to get information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionCmdlet.FlowVersion"> <summary> <para> <para>The version of the flow for which to get information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetFlowVersionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetFlowVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionListCmdlet"> <summary> Returns a list of information about each flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionListCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowVersionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListFlowVersionsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListFlowVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABFlowVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobCmdlet"> <summary> Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source for the data ingestion job you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobCmdlet.IngestionJobId"> <summary> <para> <para>The unique identifier of the data ingestion job you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for the data ingestion job you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IngestionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetIngestionJobResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetIngestionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet"> <summary> Lists the data ingestion jobs for a data source. The list also includes information about each job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.SortBy_Attribute"> <summary> <para> <para>The name of field or attribute to apply sorting of data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source for the list of data ingestion jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.Filter"> <summary> <para> <para>Contains information about the filters for filtering the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for the list of data ingestion jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.SortBy_Order"> <summary> <para> <para>The order for sorting the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IngestionJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListIngestionJobsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListIngestionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABIngestionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseCmdlet"> <summary> Gets information about a knoweldge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentCmdlet"> <summary> Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source that contains the documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentCmdlet.DocumentIdentifier"> <summary> <para> <para>A list of objects, each of which contains information to identify a document for which to retrieve information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base that is connected to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetKnowledgeBaseDocumentsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetKnowledgeBaseDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentListCmdlet"> <summary> Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentListCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source that contains the documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentListCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base that is connected to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBaseDocumentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListKnowledgeBaseDocumentsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListKnowledgeBaseDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBasisListCmdlet"> <summary> Lists the knowledge bases in an account. The list also includesinformation about each knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBasisListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBasisListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABKnowledgeBasisListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBaseSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListKnowledgeBasesResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListKnowledgeBasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptCmdlet"> <summary> Retrieves information about the working draft (<c>DRAFT</c> version) of a prompt or a version of it, depending on whether you include the <c>promptVersion</c> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-view.html">View information about a version of your prompt</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptCmdlet.PromptIdentifier"> <summary> <para> <para>The unique identifier of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptCmdlet.PromptVersion"> <summary> <para> <para>The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.GetPromptResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.GetPromptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^PromptIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptListCmdlet"> <summary> Returns either information about the working draft (<c>DRAFT</c> version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the <c>promptIdentifier</c> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptListCmdlet.PromptIdentifier"> <summary> <para> <para>The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptListCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the <c>maxResults</c> value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PromptSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListPromptsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListPromptsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABPromptListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^PromptIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.GetAABResourceTagCmdlet"> <summary> List all the tags for the resource you specify. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which to list tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.GetAABResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.InitializeAABAgentCmdlet"> <summary> Creates a <c>DRAFT</c> version of the agent that can be used for internal testing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABAgentCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent for which to create a <c>DRAFT</c> version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.PrepareAgentResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.PrepareAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABAgentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.InitializeAABFlowCmdlet"> <summary> Prepares the <c>DRAFT</c> version of a flow so that it can be invoked. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html">Test a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABFlowCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.PrepareFlowResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.PrepareFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.InitializeAABFlowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet"> <summary> Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. <ul><li><para> Specify the following fields for security purposes. </para><ul><li><para><c>agentResourceRoleArn</c> – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. </para></li><li><para> (Optional) <c>customerEncryptionKeyArn</c> – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. </para></li><li><para> (Optional) <c>idleSessionTTLinSeconds</c> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <c>InvokeAgent</c> request begins a new session. </para></li></ul></li><li><para> To enable your agent to retain conversational context across multiple sessions, include a <c>memoryConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-configure-memory.html">Configure memory</a>. </para></li><li><para> To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <c>promptOverrideConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </para></li><li><para> If your agent fails to be created, the response returns a list of <c>failureReasons</c> alongside a list of <c>recommendedActions</c> for you to troubleshoot. </para></li><li><para> The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.AgentName"> <summary> <para> <para>A name for the agent that you create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.AgentResourceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.Description"> <summary> <para> <para>A description of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.MemoryConfiguration_EnabledMemoryType"> <summary> <para> <para>The type of memory that is stored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.FoundationModel"> <summary> <para> <para>The identifier for the model that you want to be used for orchestration by the agent you create.</para><para>The <c>modelId</c> to provide depends on the type of model or throughput that you use:</para><ul><li><para>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.GuardrailConfiguration_GuardrailIdentifier"> <summary> <para> <para>The unique identifier of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.IdleSessionTTLInSecond"> <summary> <para> <para>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</para><para>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.Instruction"> <summary> <para> <para>Instructions that tell the agent what it should do and how it should interact with users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.Executor_Lambda"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.OrchestrationType"> <summary> <para> <para> Specifies the type of orchestration strategy for the agent. This is set to <c>DEFAULT</c> orchestration type, by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.PromptOverrideConfiguration_OverrideLambda"> <summary> <para> <para>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the <c>promptConfigurations</c> must contain a <c>parserMode</c> value that is set to <c>OVERRIDDEN</c>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Amazon Bedrock Agents</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.PromptOverrideConfiguration_PromptConfiguration"> <summary> <para> <para>Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.MemoryConfiguration_StorageDay"> <summary> <para> <para>The number of days the agent is configured to retain the conversational context.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.Tag"> <summary> <para> <para>Any tags that you want to attach to the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Agent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateAgentResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentName parameter. The -PassThru parameter is deprecated, use -Select '^AgentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet"> <summary> Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. <para> To allow your agent to request the user for additional information when trying to complete a task, add an action group with the <c>parentActionGroupSignature</c> field set to <c>AMAZON.UserInput</c>. </para><para> To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the <c>parentActionGroupSignature</c> field set to <c>AMAZON.CodeInterpreter</c>. </para><para> You must leave the <c>description</c>, <c>apiSchema</c>, and <c>actionGroupExecutor</c> fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ActionGroupName"> <summary> <para> <para>The name to give the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ActionGroupState"> <summary> <para> <para>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent for which to create the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent for which to create the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ActionGroupExecutor_CustomControl"> <summary> <para> <para>To return the action group invocation results directly in the <c>InvokeAgent</c> response, specify <c>RETURN_CONTROL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.Description"> <summary> <para> <para>A description of the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.FunctionSchema_Function"> <summary> <para> <para>A list of functions that each define an action in the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ActionGroupExecutor_Lambda"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ParentActionGroupSignature"> <summary> <para> <para>To allow your agent to request the user for additional information when trying to complete a task, set this field to <c>AMAZON.UserInput</c>. You must leave the <c>description</c>, <c>apiSchema</c>, and <c>actionGroupExecutor</c> fields blank for this action group.</para><para>To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to <c>AMAZON.CodeInterpreter</c>. You must leave the <c>description</c>, <c>apiSchema</c>, and <c>actionGroupExecutor</c> fields blank for this action group.</para><para>During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ApiSchema_Payload"> <summary> <para> <para>The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.S3_S3BucketName"> <summary> <para> <para>The name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.S3_S3ObjectKey"> <summary> <para> <para>The S3 object key for the S3 resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentActionGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateAgentActionGroupResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateAgentActionGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentActionGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet"> <summary> Creates an alias of an agent that can be used to deploy the agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.AgentAliasName"> <summary> <para> <para>The name of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.Description"> <summary> <para> <para>A description of the alias of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.RoutingConfiguration"> <summary> <para> <para>Contains details about the routing configuration of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.Tag"> <summary> <para> <para>Any tags that you want to attach to the alias of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateAgentAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateAgentAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABAgentAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet"> <summary> Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the <c>dataSourceConfiguration</c> field. <important><para> You can't change the <c>chunkingConfiguration</c> after you create the data source connector. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_AuthType"> <summary> <para> <para>The supported authentication type to authenticate and connect to your Confluence instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_AuthType"> <summary> <para> <para>The supported authentication type to authenticate and connect to your Salesforce instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_AuthType"> <summary> <para> <para>The supported authentication type to authenticate and connect to your SharePoint site/sites.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.SemanticChunkingConfiguration_BreakpointPercentileThreshold"> <summary> <para> <para>The dissimilarity threshold for splitting chunks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.S3Configuration_BucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the S3 bucket that contains your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.S3Configuration_BucketOwnerAccountId"> <summary> <para> <para>The account ID for the owner of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.SemanticChunkingConfiguration_BufferSize"> <summary> <para> <para>The buffer size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.ChunkingConfiguration_ChunkingStrategy"> <summary> <para> <para>Knowledge base can split your source data into chunks. A <i>chunk</i> refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for <c>NONE</c>, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.</para><ul><li><para><c>FIXED_SIZE</c> – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the <c>fixedSizeChunkingConfiguration</c>.</para></li><li><para><c>HIERARCHICAL</c> – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</para></li><li><para><c>SEMANTIC</c> – Split documents into chunks based on groups of similar content derived with natural language processing.</para></li><li><para><c>NONE</c> – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector">Confluence connection configuration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector">Salesforce connection configuration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector">SharePoint connection configuration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataDeletionPolicy"> <summary> <para> <para>The data deletion policy for the data source.</para><para>You can set the data deletion policy to:</para><ul><li><para>DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b>, only the data. This flag is ignored if an Amazon Web Services account is deleted.</para></li><li><para>RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b> if you delete a knowledge base or data source resource.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.Description"> <summary> <para> <para>A description of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.SourceConfiguration_Domain"> <summary> <para> <para>The domain of your SharePoint instance or site URL/URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.CrawlerConfiguration_ExclusionFilter"> <summary> <para> <para>A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters"> <summary> <para> <para>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters"> <summary> <para> <para>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters"> <summary> <para> <para>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostType"> <summary> <para> <para>The supported host type, whether online/cloud or server/on-premises.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_HostType"> <summary> <para> <para>The supported host type, whether online/cloud or server/on-premises.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostUrl"> <summary> <para> <para>The Confluence host URL or instance URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_HostUrl"> <summary> <para> <para>The Salesforce host URL or instance URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.CrawlerConfiguration_InclusionFilter"> <summary> <para> <para>A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.S3Configuration_InclusionPrefix"> <summary> <para> <para>A list of S3 prefixes to include certain files or content. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.ServerSideEncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to which to add the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.HierarchicalChunkingConfiguration_LevelConfiguration"> <summary> <para> <para>Token settings for each layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.FixedSizeChunkingConfiguration_MaxToken"> <summary> <para> <para>The maximum number of tokens to include in a chunk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.SemanticChunkingConfiguration_MaxToken"> <summary> <para> <para>The maximum number of tokens that a chunk can contain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.BedrockFoundationModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.Name"> <summary> <para> <para>The name of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.FixedSizeChunkingConfiguration_OverlapPercentage"> <summary> <para> <para>The percentage of overlap between adjacent chunks of a data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.HierarchicalChunkingConfiguration_OverlapToken"> <summary> <para> <para>The number of tokens to repeat across chunks in the same layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.ParsingPrompt_ParsingPromptText"> <summary> <para> <para>Instructions for interpreting the contents of a document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.ParsingConfiguration_ParsingStrategy"> <summary> <para> <para>The parsing strategy for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.CrawlerLimits_RateLimit"> <summary> <para> <para>The max rate at which pages are crawled, up to 300 per minute per host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.CrawlerConfiguration_Scope"> <summary> <para> <para>The scope of what is crawled for your URLs.</para><para>You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.UrlConfiguration_SeedUrl"> <summary> <para> <para>One or more seed or starting point URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.SourceConfiguration_SiteUrl"> <summary> <para> <para>A list of one or more SharePoint site URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.SourceConfiguration_TenantId"> <summary> <para> <para>The identifier of your Microsoft 365 tenant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.CustomTransformationConfiguration_Transformation"> <summary> <para> <para>A Lambda function that processes documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_Type"> <summary> <para> <para>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <c>PATTERN</c> type is regular expression patterns you can apply to filter your content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_Type"> <summary> <para> <para>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <c>PATTERN</c> type is regular expression patterns you can apply to filter your content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_Type"> <summary> <para> <para>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <c>PATTERN</c> type is regular expression patterns you can apply to filter your content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.DataSourceConfiguration_Type"> <summary> <para> <para>The type of data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.S3Location_Uri"> <summary> <para> <para>The location's URI. For example, <c>s3://my-bucket/chunk-processor/</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateDataSourceResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet"> <summary> Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html">How it works</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html">Create a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Definition_Connection"> <summary> <para> <para>An array of connection definitions in the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Description"> <summary> <para> <para>A description for the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Name"> <summary> <para> <para>A name for the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Definition_Node"> <summary> <para> <para>An array of node definitions in the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Tag"> <summary> <para> <para>Any tags that you want to attach to the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateFlowResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet"> <summary> Creates an alias of a flow for deployment. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.Description"> <summary> <para> <para>A description for the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow for which to create an alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.Name"> <summary> <para> <para>A name for the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.RoutingConfiguration"> <summary> <para> <para>Contains information about the version to which to map the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.Tag"> <summary> <para> <para>Any tags that you want to attach to the alias of the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateFlowAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateFlowAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet"> <summary> Creates a version of the flow that you can deploy. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet.Description"> <summary> <para> <para>A description of the version of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow that you want to create a version of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateFlowVersionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateFlowVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABFlowVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet"> <summary> Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html">Set up a knowledge base</a>. <note><para> If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create">Create a knowledge base</a>. </para></note><ul><li><para> Provide the <c>name</c> and an optional <c>description</c>. </para></li><li><para> Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the <c>roleArn</c> field. </para></li><li><para> Provide the embedding model to use in the <c>embeddingModelArn</c> field in the <c>knowledgeBaseConfiguration</c> object. </para></li><li><para> Provide the configuration for your vector store in the <c>storageConfiguration</c> object. </para><ul><li><para> For an Amazon OpenSearch Service database, use the <c>opensearchServerlessConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector store in Amazon OpenSearch Service</a>. </para></li><li><para> For an Amazon Aurora database, use the <c>RdsConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector store in Amazon Aurora</a>. </para></li><li><para> For a Pinecone database, use the <c>pineconeConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector store in Pinecone</a>. </para></li><li><para> For a Redis Enterprise Cloud database, use the <c>redisEnterpriseCloudConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html">Create a vector store in Redis Enterprise Cloud</a>. </para></li></ul></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.OpensearchServerlessConfiguration_CollectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_CollectionName"> <summary> <para> <para>The collection name of the knowledge base in MongoDB Atlas.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.PineconeConfiguration_ConnectionString"> <summary> <para> <para>The endpoint URL for your index management page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.PineconeConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RdsConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RedisEnterpriseCloudConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_DatabaseName"> <summary> <para> <para>The database name in your MongoDB Atlas cluster for your knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RdsConfiguration_DatabaseName"> <summary> <para> <para>The name of your Amazon RDS database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.Description"> <summary> <para> <para>A description of the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.BedrockEmbeddingModelConfiguration_Dimension"> <summary> <para> <para>The dimensions details for the vector configuration used on the Bedrock embeddings model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.BedrockEmbeddingModelConfiguration_EmbeddingDataType"> <summary> <para> <para>The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings models</a> for information on the available models and their vector data types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.VectorKnowledgeBaseConfiguration_EmbeddingModelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_Endpoint"> <summary> <para> <para>The endpoint URL of your MongoDB Atlas cluster for your knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RedisEnterpriseCloudConfiguration_Endpoint"> <summary> <para> <para>The endpoint URL of the Redis Enterprise Cloud database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_EndpointServiceName"> <summary> <para> <para>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_PineconeConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.Name"> <summary> <para> <para>A name for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.PineconeConfiguration_Namespace"> <summary> <para> <para>The namespace to be used to write new data to your database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.FieldMapping_PrimaryKeyField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the ID for each entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RdsConfiguration_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RdsConfiguration_TableName"> <summary> <para> <para>The name of the table in the database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.Tag"> <summary> <para> <para>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_PineconeConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.KnowledgeBaseConfiguration_Type"> <summary> <para> <para>The type of data that the data source is converted into for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_Type"> <summary> <para> <para>The vector store service in which the knowledge base is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_VectorIndexName"> <summary> <para> <para>The name of the MongoDB Atlas vector search index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.OpensearchServerlessConfiguration_VectorIndexName"> <summary> <para> <para>The name of the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.RedisEnterpriseCloudConfiguration_VectorIndexName"> <summary> <para> <para>The name of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABKnowledgeBaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet"> <summary> Creates a prompt in your prompt library that you can add to a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Prompt management in Amazon Bedrock</a>, <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows.html">Prompt flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.DefaultVariant"> <summary> <para> <para>The name of the default variant for the prompt. This value must match the <c>name</c> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.Description"> <summary> <para> <para>A description for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.Name"> <summary> <para> <para>A name for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.Tag"> <summary> <para> <para>Any tags that you want to attach to the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.Variant"> <summary> <para> <para>A list of objects, each containing details about a variant of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreatePromptResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreatePromptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet"> <summary> Creates a static snapshot of your prompt that can be deployed to production. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html">Deploy prompts using Prompt management by creating versions</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.Description"> <summary> <para> <para>A description for the version of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.PromptIdentifier"> <summary> <para> <para>The unique identifier of the prompt that you want to create a version of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.Tag"> <summary> <para> <para>Any tags that you want to attach to the version of the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreatePromptVersionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreatePromptVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^PromptIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.NewAABPromptVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet"> <summary> Associates a knowledge base with an agent. If a knowledge base is associated and its <c>indexState</c> is set to <c>Enabled</c>, the agent queries the knowledge base for information to augment its response to the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent with which you want to associate the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent with which you want to associate the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.Description"> <summary> <para> <para>A description of what the agent should use the knowledge base for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to associate with the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.KnowledgeBaseState"> <summary> <para> <para>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentKnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.AssociateAgentKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.AssociateAgentKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RegisterAABAgentKnowledgeBaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentCmdlet"> <summary> Deletes an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentCmdlet.SkipResourceInUseCheck"> <summary> <para> <para>By default, this value is <c>false</c> and deletion is stopped if the resource is in use. If you set it to <c>true</c>, the resource will be deleted even if the resource is in use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteAgentResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet"> <summary> Deletes an action group in an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.ActionGroupId"> <summary> <para> <para>The unique identifier of the action group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent that the action group belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent that the action group belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.SkipResourceInUseCheck"> <summary> <para> <para>By default, this value is <c>false</c> and deletion is stopped if the resource is in use. If you set it to <c>true</c>, the resource will be deleted even if the resource is in use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteAgentActionGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentActionGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentAliasCmdlet"> <summary> Deletes an alias of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentAliasCmdlet.AgentAliasId"> <summary> <para> <para>The unique identifier of the alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentAliasCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent that the alias belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteAgentAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteAgentAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet"> <summary> Deletes a version of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent that the version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet.SkipResourceInUseCheck"> <summary> <para> <para>By default, this value is <c>false</c> and deletion is stopped if the resource is in use. If you set it to <c>true</c>, the resource will be deleted even if the resource is in use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteAgentVersionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteAgentVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABAgentVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABDataSourceCmdlet"> <summary> Deletes a data source from a knowledge base. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABDataSourceCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base from which to delete the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteDataSourceResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowCmdlet"> <summary> Deletes a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowCmdlet.SkipResourceInUseCheck"> <summary> <para> <para>By default, this value is <c>false</c> and deletion is stopped if the resource is in use. If you set it to <c>true</c>, the resource will be deleted even if the resource is in use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Id'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteFlowResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowAliasCmdlet"> <summary> Deletes an alias of a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowAliasCmdlet.AliasIdentifier"> <summary> <para> <para>The unique identifier of the alias to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowAliasCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow that the alias belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteFlowAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteFlowAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet"> <summary> Deletes a version of a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow whose version that you want to delete</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet.FlowVersion"> <summary> <para> <para>The version of the flow that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet.SkipResourceInUseCheck"> <summary> <para> <para>By default, this value is <c>false</c> and deletion is stopped if the resource is in use. If you set it to <c>true</c>, the resource will be deleted even if the resource is in use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteFlowVersionResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteFlowVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABFlowVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseCmdlet"> <summary> Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html">DisassociateAgentKnowledgeBase</a> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet"> <summary> Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source that contains the documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet.DocumentIdentifier"> <summary> <para> <para>A list of objects, each of which contains information to identify a document to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base that is connected to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeleteKnowledgeBaseDocumentsResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeleteKnowledgeBaseDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABKnowledgeBaseDocumentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABPromptCmdlet"> <summary> Deletes a prompt or a version of it, depending on whether you include the <c>promptVersion</c> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-delete.html">Delete prompts from the Prompt management tool</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-delete.html">Delete a version of a prompt from the Prompt management tool</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABPromptCmdlet.PromptIdentifier"> <summary> <para> <para>The unique identifier of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABPromptCmdlet.PromptVersion"> <summary> <para> <para>The version of the prompt to delete. To delete the prompt, omit this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DeletePromptResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.DeletePromptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^PromptIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABPromptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.RemoveAABResourceTagCmdlet"> <summary> Remove tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource from which to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of keys of the tags to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.RemoveAABResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet"> <summary> Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source you want to ingest into your knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.Description"> <summary> <para> <para>A description of the data ingestion job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for the data ingestion job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IngestionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.StartIngestionJobResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.StartIngestionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StartAABIngestionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.StopAABIngestionJobCmdlet"> <summary> Stops a currently running data ingestion job. You can send a <c>StartIngestionJob</c> request again to ingest the rest of your data when you are ready. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StopAABIngestionJobCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source for the data ingestion job you want to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StopAABIngestionJobCmdlet.IngestionJobId"> <summary> <para> <para>The unique identifier of the data ingestion job you want to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StopAABIngestionJobCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for the data ingestion job you want to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StopAABIngestionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IngestionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.StopIngestionJobResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.StopIngestionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.StopAABIngestionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet"> <summary> Disassociates a knowledge base from an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent from which to disassociate the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent from which to disassociate the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to disassociate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.DisassociateAgentKnowledgeBaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UnregisterAABAgentKnowledgeBaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet"> <summary> Updates the configuration of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.AgentName"> <summary> <para> <para>Specifies a new name for the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.AgentResourceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.Description"> <summary> <para> <para>Specifies a new description of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.MemoryConfiguration_EnabledMemoryType"> <summary> <para> <para>The type of memory that is stored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.FoundationModel"> <summary> <para> <para>The identifier for the model that you want to be used for orchestration by the agent you create.</para><para>The <c>modelId</c> to provide depends on the type of model or throughput that you use:</para><ul><li><para>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</para></li><li><para>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.GuardrailConfiguration_GuardrailIdentifier"> <summary> <para> <para>The unique identifier of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.IdleSessionTTLInSecond"> <summary> <para> <para>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</para><para>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.Instruction"> <summary> <para> <para>Specifies new instructions that tell the agent what it should do and how it should interact with users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.Executor_Lambda"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.OrchestrationType"> <summary> <para> <para> Specifies the type of orchestration strategy for the agent. This is set to <c>DEFAULT</c> orchestration type, by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.PromptOverrideConfiguration_OverrideLambda"> <summary> <para> <para>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the <c>promptConfigurations</c> must contain a <c>parserMode</c> value that is set to <c>OVERRIDDEN</c>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Amazon Bedrock Agents</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.PromptOverrideConfiguration_PromptConfiguration"> <summary> <para> <para>Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.MemoryConfiguration_StorageDay"> <summary> <para> <para>The number of days the agent is configured to retain the conversational context.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Agent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateAgentResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet"> <summary> Updates the configuration for an action group for an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ActionGroupId"> <summary> <para> <para>The unique identifier of the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ActionGroupName"> <summary> <para> <para>Specifies a new name for the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ActionGroupState"> <summary> <para> <para>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent for which to update the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.AgentVersion"> <summary> <para> <para>The unique identifier of the agent version for which to update the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ActionGroupExecutor_CustomControl"> <summary> <para> <para>To return the action group invocation results directly in the <c>InvokeAgent</c> response, specify <c>RETURN_CONTROL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.Description"> <summary> <para> <para>Specifies a new name for the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.FunctionSchema_Function"> <summary> <para> <para>A list of functions that each define an action in the action group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ActionGroupExecutor_Lambda"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ParentActionGroupSignature"> <summary> <para> <para>To allow your agent to request the user for additional information when trying to complete a task, set this field to <c>AMAZON.UserInput</c>. You must leave the <c>description</c>, <c>apiSchema</c>, and <c>actionGroupExecutor</c> fields blank for this action group.</para><para>During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.ApiSchema_Payload"> <summary> <para> <para>The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.S3_S3BucketName"> <summary> <para> <para>The name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.S3_S3ObjectKey"> <summary> <para> <para>The S3 object key for the S3 resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentActionGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateAgentActionGroupResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateAgentActionGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentActionGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet"> <summary> Updates configurations for an alias of an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.AgentAliasId"> <summary> <para> <para>The unique identifier of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.AgentAliasName"> <summary> <para> <para>Specifies a new name for the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.Description"> <summary> <para> <para>Specifies a new description for the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.RoutingConfiguration"> <summary> <para> <para>Contains details about the routing configuration of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateAgentAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateAgentAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet"> <summary> Updates the configuration for a knowledge base that has been associated with an agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent associated with the knowledge base that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.AgentVersion"> <summary> <para> <para>The version of the agent associated with the knowledge base that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.Description"> <summary> <para> <para>Specifies a new description for the knowledge base associated with an agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base that has been associated with an agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.KnowledgeBaseState"> <summary> <para> <para>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentKnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateAgentKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateAgentKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABAgentKnowledgeBaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet"> <summary> Updates the configurations for a data source connector. <important><para> You can't change the <c>chunkingConfiguration</c> after you create the data source connector. Specify the existing <c>chunkingConfiguration</c>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_AuthType"> <summary> <para> <para>The supported authentication type to authenticate and connect to your Confluence instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_AuthType"> <summary> <para> <para>The supported authentication type to authenticate and connect to your Salesforce instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_AuthType"> <summary> <para> <para>The supported authentication type to authenticate and connect to your SharePoint site/sites.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.SemanticChunkingConfiguration_BreakpointPercentileThreshold"> <summary> <para> <para>The dissimilarity threshold for splitting chunks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.S3Configuration_BucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the S3 bucket that contains your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.S3Configuration_BucketOwnerAccountId"> <summary> <para> <para>The account ID for the owner of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.SemanticChunkingConfiguration_BufferSize"> <summary> <para> <para>The buffer size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.ChunkingConfiguration_ChunkingStrategy"> <summary> <para> <para>Knowledge base can split your source data into chunks. A <i>chunk</i> refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for <c>NONE</c>, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.</para><ul><li><para><c>FIXED_SIZE</c> – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the <c>fixedSizeChunkingConfiguration</c>.</para></li><li><para><c>HIERARCHICAL</c> – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</para></li><li><para><c>SEMANTIC</c> – Split documents into chunks based on groups of similar content derived with natural language processing.</para></li><li><para><c>NONE</c> – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector">Confluence connection configuration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector">Salesforce connection configuration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector">SharePoint connection configuration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataDeletionPolicy"> <summary> <para> <para>The data deletion policy for the data source that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The unique identifier of the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.Description"> <summary> <para> <para>Specifies a new description for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.SourceConfiguration_Domain"> <summary> <para> <para>The domain of your SharePoint instance or site URL/URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.CrawlerConfiguration_ExclusionFilter"> <summary> <para> <para>A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters"> <summary> <para> <para>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters"> <summary> <para> <para>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters"> <summary> <para> <para>The configuration of specific filters applied to your data source content. You can filter out or include certain content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostType"> <summary> <para> <para>The supported host type, whether online/cloud or server/on-premises.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_HostType"> <summary> <para> <para>The supported host type, whether online/cloud or server/on-premises.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostUrl"> <summary> <para> <para>The Confluence host URL or instance URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_HostUrl"> <summary> <para> <para>The Salesforce host URL or instance URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.CrawlerConfiguration_InclusionFilter"> <summary> <para> <para>A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.S3Configuration_InclusionPrefix"> <summary> <para> <para>A list of S3 prefixes to include certain files or content. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.ServerSideEncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.HierarchicalChunkingConfiguration_LevelConfiguration"> <summary> <para> <para>Token settings for each layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.FixedSizeChunkingConfiguration_MaxToken"> <summary> <para> <para>The maximum number of tokens to include in a chunk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.SemanticChunkingConfiguration_MaxToken"> <summary> <para> <para>The maximum number of tokens that a chunk can contain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.BedrockFoundationModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.Name"> <summary> <para> <para>Specifies a new name for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.FixedSizeChunkingConfiguration_OverlapPercentage"> <summary> <para> <para>The percentage of overlap between adjacent chunks of a data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.HierarchicalChunkingConfiguration_OverlapToken"> <summary> <para> <para>The number of tokens to repeat across chunks in the same layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.ParsingPrompt_ParsingPromptText"> <summary> <para> <para>Instructions for interpreting the contents of a document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.ParsingConfiguration_ParsingStrategy"> <summary> <para> <para>The parsing strategy for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.CrawlerLimits_RateLimit"> <summary> <para> <para>The max rate at which pages are crawled, up to 300 per minute per host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.CrawlerConfiguration_Scope"> <summary> <para> <para>The scope of what is crawled for your URLs.</para><para>You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.UrlConfiguration_SeedUrl"> <summary> <para> <para>One or more seed or starting point URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.SourceConfiguration_SiteUrl"> <summary> <para> <para>A list of one or more SharePoint site URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.SourceConfiguration_TenantId"> <summary> <para> <para>The identifier of your Microsoft 365 tenant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.CustomTransformationConfiguration_Transformation"> <summary> <para> <para>A Lambda function that processes documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_Type"> <summary> <para> <para>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <c>PATTERN</c> type is regular expression patterns you can apply to filter your content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_Type"> <summary> <para> <para>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <c>PATTERN</c> type is regular expression patterns you can apply to filter your content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_Type"> <summary> <para> <para>The type of filtering that you want to apply to certain objects or content of the data source. For example, the <c>PATTERN</c> type is regular expression patterns you can apply to filter your content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.DataSourceConfiguration_Type"> <summary> <para> <para>The type of data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.S3Location_Uri"> <summary> <para> <para>The location's URI. For example, <c>s3://my-bucket/chunk-processor/</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateDataSourceResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet"> <summary> Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html">How it works</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html">Create a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.Definition_Connection"> <summary> <para> <para>An array of connection definitions in the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.Description"> <summary> <para> <para>A description for the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.Name"> <summary> <para> <para>A name for the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.Definition_Node"> <summary> <para> <para>An array of node definitions in the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateFlowResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet"> <summary> Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html">Deploy a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.AliasIdentifier"> <summary> <para> <para>The unique identifier of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.Description"> <summary> <para> <para>A description for the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.Name"> <summary> <para> <para>The name of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.RoutingConfiguration"> <summary> <para> <para>Contains information about the version to which to map the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateFlowAliasResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateFlowAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^FlowIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABFlowAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet"> <summary> Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same. <para> You can change the following fields: </para><ul><li><para><c>name</c></para></li><li><para><c>description</c></para></li><li><para><c>roleArn</c></para></li></ul><para> You can't change the <c>knowledgeBaseConfiguration</c> or <c>storageConfiguration</c> fields, so you must specify the same configurations as when you created the knowledge base. You can send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html">GetKnowledgeBase</a> request and copy the same configurations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.OpensearchServerlessConfiguration_CollectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_CollectionName"> <summary> <para> <para>The collection name of the knowledge base in MongoDB Atlas.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.PineconeConfiguration_ConnectionString"> <summary> <para> <para>The endpoint URL for your index management page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.PineconeConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RdsConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RedisEnterpriseCloudConfiguration_CredentialsSecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_DatabaseName"> <summary> <para> <para>The database name in your MongoDB Atlas cluster for your knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RdsConfiguration_DatabaseName"> <summary> <para> <para>The name of your Amazon RDS database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.Description"> <summary> <para> <para>Specifies a new description for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.BedrockEmbeddingModelConfiguration_Dimension"> <summary> <para> <para>The dimensions details for the vector configuration used on the Bedrock embeddings model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.BedrockEmbeddingModelConfiguration_EmbeddingDataType"> <summary> <para> <para>The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings models</a> for information on the available models and their vector data types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.VectorKnowledgeBaseConfiguration_EmbeddingModelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_Endpoint"> <summary> <para> <para>The endpoint URL of your MongoDB Atlas cluster for your knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RedisEnterpriseCloudConfiguration_Endpoint"> <summary> <para> <para>The endpoint URL of the Redis Enterprise Cloud database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_EndpointServiceName"> <summary> <para> <para>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_PineconeConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_MetadataField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores metadata about the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.Name"> <summary> <para> <para>Specifies a new name for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.PineconeConfiguration_Namespace"> <summary> <para> <para>The namespace to be used to write new data to your database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.FieldMapping_PrimaryKeyField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the ID for each entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RdsConfiguration_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RoleArn"> <summary> <para> <para>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RdsConfiguration_TableName"> <summary> <para> <para>The name of the table in the database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_PineconeConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_TextField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.KnowledgeBaseConfiguration_Type"> <summary> <para> <para>The type of data that the data source is converted into for the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_Type"> <summary> <para> <para>The vector store service in which the knowledge base is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_VectorField"> <summary> <para> <para>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.MongoDbAtlasConfiguration_VectorIndexName"> <summary> <para> <para>The name of the MongoDB Atlas vector search index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.OpensearchServerlessConfiguration_VectorIndexName"> <summary> <para> <para>The name of the vector store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.RedisEnterpriseCloudConfiguration_VectorIndexName"> <summary> <para> <para>The name of the vector index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABKnowledgeBaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet"> <summary> Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Prompt management in Amazon Bedrock</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-edit">Edit prompts in your prompt library</a> in the Amazon Bedrock User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.DefaultVariant"> <summary> <para> <para>The name of the default variant for the prompt. This value must match the <c>name</c> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.Description"> <summary> <para> <para>A description for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.Name"> <summary> <para> <para>A name for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.PromptIdentifier"> <summary> <para> <para>The unique identifier of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.Variant"> <summary> <para> <para>A list of objects, each containing details about a variant of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdatePromptResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdatePromptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^PromptIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAB.UpdateAABPromptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |