AWS.Tools.QApps.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QApps</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.qapps.AddqappsResourceTagCmdlet"> <summary> Associates tags with an Amazon Q Apps resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.AddqappsResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.AddqappsResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.AddqappsResourceTagCmdlet.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.QApps.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.AddqappsResourceTagCmdlet.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.qapps.AddqappsResourceTagCmdlet.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.qapps.ConvertFromqappsQAppCmdlet"> <summary> Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call <c>CreateQApp</c>. This API doesn't create Amazon Q Apps directly. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ConvertFromqappsQAppCmdlet.Options_Conversation"> <summary> <para> <para>A conversation to use as input for generating the Q App definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ConvertFromqappsQAppCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ConvertFromqappsQAppCmdlet.Options_ProblemStatement"> <summary> <para> <para>A problem statement to use as input for generating the Q App definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ConvertFromqappsQAppCmdlet.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.QApps.Model.PredictQAppResponse). Specifying the name of a property of type Amazon.QApps.Model.PredictQAppResponse 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.qapps.ConvertFromqappsQAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ConvertFromqappsQAppCmdlet.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.qapps.GetqappsLibraryItemCmdlet"> <summary> Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Amazon Q App associated with the library item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemCmdlet.LibraryItemId"> <summary> <para> <para>The unique identifier of the library item to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemCmdlet.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.QApps.Model.GetLibraryItemResponse). Specifying the name of a property of type Amazon.QApps.Model.GetLibraryItemResponse 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.qapps.GetqappsLibraryItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LibraryItemId parameter. The -PassThru parameter is deprecated, use -Select '^LibraryItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemListCmdlet"> <summary> Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemListCmdlet.CategoryId"> <summary> <para> <para>Optional category to filter the library items by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemListCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemListCmdlet.Limit"> <summary> <para> <para>The maximum number of library items to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemListCmdlet.NextToken"> <summary> <para> <para>The token to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsLibraryItemListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LibraryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QApps.Model.ListLibraryItemsResponse). Specifying the name of a property of type Amazon.QApps.Model.ListLibraryItemsResponse 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.qapps.GetqappsLibraryItemListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppCmdlet"> <summary> Retrieves the full details of an Q App, including its definition specifying the cards and flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Q App to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppCmdlet.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.QApps.Model.GetQAppResponse). Specifying the name of a property of type Amazon.QApps.Model.GetQAppResponse 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.qapps.GetqappsQAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppListCmdlet"> <summary> Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation.. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppListCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppListCmdlet.Limit"> <summary> <para> <para>The maximum number of Q Apps to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppListCmdlet.NextToken"> <summary> <para> <para>The token to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Apps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QApps.Model.ListQAppsResponse). Specifying the name of a property of type Amazon.QApps.Model.ListQAppsResponse 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.qapps.GetqappsQAppListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppSessionCmdlet"> <summary> Retrieves the current state and results for an active session of an Amazon Q App. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppSessionCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppSessionCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the Q App session to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsQAppSessionCmdlet.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.QApps.Model.GetQAppSessionResponse). Specifying the name of a property of type Amazon.QApps.Model.GetQAppSessionResponse 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.qapps.GetqappsQAppSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.qapps.GetqappsResourceTagCmdlet"> <summary> Lists the tags associated with an Amazon Q Apps resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags should be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.GetqappsResourceTagCmdlet.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.QApps.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.QApps.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.qapps.GetqappsResourceTagCmdlet.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.qapps.ImportqappsDocumentCmdlet"> <summary> Uploads a file that can then be used either as a default in a <c>FileUploadCard</c> from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Q App the file is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.CardId"> <summary> <para> <para>The unique identifier of the card the file is associated with, if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.FileContentsBase64"> <summary> <para> <para>The base64-encoded contents of the file to upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.FileName"> <summary> <para> <para>The name of the file being uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.Scope"> <summary> <para> <para>Whether the file is associated with an Q App definition or a specific Q App session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the Q App session the file is associated with, if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FileId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QApps.Model.ImportDocumentResponse). Specifying the name of a property of type Amazon.QApps.Model.ImportDocumentResponse 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.qapps.ImportqappsDocumentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FileName parameter. The -PassThru parameter is deprecated, use -Select '^FileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.ImportqappsDocumentCmdlet.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.qapps.NewqappsLibraryItemCmdlet"> <summary> Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsLibraryItemCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Amazon Q App to publish to the library.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsLibraryItemCmdlet.AppVersion"> <summary> <para> <para>The version of the Amazon Q App to publish to the library.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsLibraryItemCmdlet.Category"> <summary> <para> <para>The categories to associate with the library item for easier discovery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsLibraryItemCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsLibraryItemCmdlet.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.QApps.Model.CreateLibraryItemResponse). Specifying the name of a property of type Amazon.QApps.Model.CreateLibraryItemResponse 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.qapps.NewqappsLibraryItemCmdlet.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.qapps.NewqappsQAppCmdlet"> <summary> Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.AppDefinition_Card"> <summary> <para> <para>The cards that make up the Q App definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.Description"> <summary> <para> <para>The description of the new Q App.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.AppDefinition_InitialPrompt"> <summary> <para> <para>The initial prompt displayed when the Q App is started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.Tag"> <summary> <para> <para>Optional tags to associate with the new Q App.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.Title"> <summary> <para> <para>The title of the new Q App.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.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.QApps.Model.CreateQAppResponse). Specifying the name of a property of type Amazon.QApps.Model.CreateQAppResponse 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.qapps.NewqappsQAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Title parameter. The -PassThru parameter is deprecated, use -Select '^Title' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.NewqappsQAppCmdlet.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.qapps.RegisterqappsLibraryItemReviewCmdlet"> <summary> Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsLibraryItemReviewCmdlet.InstanceId"> <summary> <para> <para>The unique identifier for the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsLibraryItemReviewCmdlet.LibraryItemId"> <summary> <para> <para>The unique identifier of the library item to associate the review with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsLibraryItemReviewCmdlet.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.QApps.Model.AssociateLibraryItemReviewResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsLibraryItemReviewCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LibraryItemId parameter. The -PassThru parameter is deprecated, use -Select '^LibraryItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsLibraryItemReviewCmdlet.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.qapps.RegisterqappsQAppWithUserCmdlet"> <summary> This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a <i>favorite</i> for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsQAppWithUserCmdlet.AppId"> <summary> <para> <para>The ID of the Amazon Q App to associate with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsQAppWithUserCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsQAppWithUserCmdlet.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.QApps.Model.AssociateQAppWithUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsQAppWithUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RegisterqappsQAppWithUserCmdlet.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.qapps.RemoveqappsLibraryItemCmdlet"> <summary> Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsLibraryItemCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsLibraryItemCmdlet.LibraryItemId"> <summary> <para> <para>The unique identifier of the library item to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsLibraryItemCmdlet.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.QApps.Model.DeleteLibraryItemResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsLibraryItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LibraryItemId parameter. The -PassThru parameter is deprecated, use -Select '^LibraryItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsLibraryItemCmdlet.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.qapps.RemoveqappsQAppCmdlet"> <summary> Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsQAppCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Q App to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsQAppCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsQAppCmdlet.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.QApps.Model.DeleteQAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsQAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsQAppCmdlet.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.qapps.RemoveqappsResourceTagCmdlet"> <summary> Disassociates tags from an Amazon Q Apps resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to disassociate the tag from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to disassociate from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsResourceTagCmdlet.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.QApps.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.RemoveqappsResourceTagCmdlet.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.qapps.RemoveqappsResourceTagCmdlet.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.qapps.StartqappsQAppSessionCmdlet"> <summary> Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. <note><para> Each Q App session will be condensed into a single conversation in the web experience. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Q App to start a session for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.AppVersion"> <summary> <para> <para>The version of the Q App to use for the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.InitialValue"> <summary> <para> <para>Optional initial input values to provide for the Q App session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.Tag"> <summary> <para> <para>Optional tags to associate with the new Q App session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.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.QApps.Model.StartQAppSessionResponse). Specifying the name of a property of type Amazon.QApps.Model.StartQAppSessionResponse 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.qapps.StartqappsQAppSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StartqappsQAppSessionCmdlet.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.qapps.StopqappsQAppSessionCmdlet"> <summary> Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StopqappsQAppSessionCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StopqappsQAppSessionCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the Q App session to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StopqappsQAppSessionCmdlet.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.QApps.Model.StopQAppSessionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StopqappsQAppSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.StopqappsQAppSessionCmdlet.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.qapps.UnregisterqappsLibraryItemReviewCmdlet"> <summary> Removes a rating or review previously submitted by the user for a library item. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsLibraryItemReviewCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsLibraryItemReviewCmdlet.LibraryItemId"> <summary> <para> <para>The unique identifier of the library item to remove the review from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsLibraryItemReviewCmdlet.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.QApps.Model.DisassociateLibraryItemReviewResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsLibraryItemReviewCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LibraryItemId parameter. The -PassThru parameter is deprecated, use -Select '^LibraryItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsLibraryItemReviewCmdlet.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.qapps.UnregisterqappsQAppFromUserCmdlet"> <summary> Disassociates a Q App from a user removing the user's access to run the Q App. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsQAppFromUserCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Q App to disassociate from the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsQAppFromUserCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsQAppFromUserCmdlet.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.QApps.Model.DisassociateQAppFromUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsQAppFromUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UnregisterqappsQAppFromUserCmdlet.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.qapps.UpdateqappsLibraryItemCmdlet"> <summary> Updates the metadata and status of a library item for an Amazon Q App. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsLibraryItemCmdlet.Category"> <summary> <para> <para>The new categories to associate with the library item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsLibraryItemCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsLibraryItemCmdlet.LibraryItemId"> <summary> <para> <para>The unique identifier of the library item to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsLibraryItemCmdlet.Status"> <summary> <para> <para>The new status to set for the library item, such as "Published" or "Hidden".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsLibraryItemCmdlet.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.QApps.Model.UpdateLibraryItemResponse). Specifying the name of a property of type Amazon.QApps.Model.UpdateLibraryItemResponse 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.qapps.UpdateqappsLibraryItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LibraryItemId parameter. The -PassThru parameter is deprecated, use -Select '^LibraryItemId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsLibraryItemCmdlet.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.qapps.UpdateqappsQAppCmdlet"> <summary> Updates an existing Amazon Q App, allowing modifications to its title, description, and definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.AppId"> <summary> <para> <para>The unique identifier of the Q App to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.AppDefinition_Card"> <summary> <para> <para>The cards that make up the Q App definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.Description"> <summary> <para> <para>The new description for the Q App.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.AppDefinition_InitialPrompt"> <summary> <para> <para>The initial prompt displayed when the Q App is started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.Title"> <summary> <para> <para>The new title for the Q App.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.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.QApps.Model.UpdateQAppResponse). Specifying the name of a property of type Amazon.QApps.Model.UpdateQAppResponse 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.qapps.UpdateqappsQAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppCmdlet.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.qapps.UpdateqappsQAppSessionCmdlet"> <summary> Updates the session for a given Q App <c>sessionId</c>. This is only valid when at least one card of the session is in the <c>WAITING</c> state. Data for each <c>WAITING</c> card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the <c>WAITING</c> status will be ignored. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppSessionCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Q Business application environment instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppSessionCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the Q App session to provide input for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppSessionCmdlet.Value"> <summary> <para> <para>The input values to provide for the current state of the Q App session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppSessionCmdlet.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.QApps.Model.UpdateQAppSessionResponse). Specifying the name of a property of type Amazon.QApps.Model.UpdateQAppSessionResponse 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.qapps.UpdateqappsQAppSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.qapps.UpdateqappsQAppSessionCmdlet.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> |