AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QBusiness UpdatePlugin API operation.

Syntax

Update-QBUSPlugin
-PluginId <String>
-CustomPluginConfiguration_ApiSchemaType <APISchemaType>
-ApplicationId <String>
-OAuth2ClientCredentialConfiguration_AuthorizationUrl <String>
-S3_Bucket <String>
-CustomPluginConfiguration_Description <String>
-DisplayName <String>
-IdcAuthConfiguration_IdcApplicationArn <String>
-S3_Key <String>
-AuthConfiguration_NoAuthConfiguration <NoAuthConfiguration>
-ApiSchema_Payload <String>
-BasicAuthConfiguration_RoleArn <String>
-IdcAuthConfiguration_RoleArn <String>
-OAuth2ClientCredentialConfiguration_RoleArn <String>
-BasicAuthConfiguration_SecretArn <String>
-OAuth2ClientCredentialConfiguration_SecretArn <String>
-ServerUrl <String>
-State <PluginState>
-OAuth2ClientCredentialConfiguration_TokenUrl <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQBusinessConfig>

Description

Updates an Amazon Q Business plugin.

Parameters

-ApiSchema_Payload <String>
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomPluginConfiguration_ApiSchema_Payload
-ApplicationId <String>
The identifier of the application the plugin is attached to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthConfiguration_NoAuthConfiguration <NoAuthConfiguration>
Information about invoking a custom plugin without any authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BasicAuthConfiguration_RoleArn <String>
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_BasicAuthConfiguration_RoleArn
-BasicAuthConfiguration_SecretArn <String>
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_BasicAuthConfiguration_SecretArn
-ClientConfig <AmazonQBusinessConfig>
Amazon.PowerShell.Cmdlets.QBUS.AmazonQBusinessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPluginConfiguration_ApiSchemaType <APISchemaType>
The type of OpenAPI schema to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPluginConfiguration_Description <String>
A description for your custom plugin configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
The name of the plugin.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdcAuthConfiguration_IdcApplicationArn <String>
The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_IdcAuthConfiguration_IdcApplicationArn
-IdcAuthConfiguration_RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_IdcAuthConfiguration_RoleArn
-OAuth2ClientCredentialConfiguration_AuthorizationUrl <String>
The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_OAuth2ClientCredentialConfiguration_AuthorizationUrl
-OAuth2ClientCredentialConfiguration_RoleArn <String>
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_OAuth2ClientCredentialConfiguration_RoleArn
-OAuth2ClientCredentialConfiguration_SecretArn <String>
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_OAuth2ClientCredentialConfiguration_SecretArn
-OAuth2ClientCredentialConfiguration_TokenUrl <String>
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthConfiguration_OAuth2ClientCredentialConfiguration_TokenUrl
-PluginId <String>
The identifier of the plugin.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-S3_Bucket <String>
The name of the S3 bucket that contains the file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomPluginConfiguration_ApiSchema_S3_Bucket
-S3_Key <String>
The name of the file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomPluginConfiguration_ApiSchema_S3_Key
-Select <String>
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.QBusiness.Model.UpdatePluginResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerUrl <String>
The source URL used for plugin configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <PluginState>
The status of the plugin.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.QBusiness.Model.UpdatePluginResponse
This cmdlet does not generate any output.The service response (type Amazon.QBusiness.Model.UpdatePluginResponse) be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z