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 AWS Wickr Admin API UpdateSecurityGroup API operation.

Syntax

Update-WICSecurityGroup
-SecurityGroupSettings_AlwaysReauthenticate <Boolean>
-SecurityGroupSettings_AtakPackageValue <String[]>
-SecurityGroupSettings_Shredder_CanProcessManually <Boolean>
-SecurityGroupSettings_Calling_CanStart11Call <Boolean>
-SecurityGroupSettings_Calling_CanVideoCall <Boolean>
-SecurityGroupSettings_CheckForUpdate <Boolean>
-SecurityGroupSettings_EnableAtak <Boolean>
-SecurityGroupSettings_EnableCrashReport <Boolean>
-SecurityGroupSettings_EnableFileDownload <Boolean>
-SecurityGroupSettings_EnableGuestFederation <Boolean>
-SecurityGroupSettings_EnableNotificationPreview <Boolean>
-SecurityGroupSettings_EnableOpenAccessOption <Boolean>
-SecurityGroupSettings_EnableRestrictedGlobalFederation <Boolean>
-SecurityGroupSettings_FederationMode <Int32>
-SecurityGroupSettings_FilesEnabled <Boolean>
-SecurityGroupSettings_ForceDeviceLockout <Int32>
-SecurityGroupSettings_ForceOpenAccess <Boolean>
-SecurityGroupSettings_ForceReadReceipt <Boolean>
-SecurityGroupSettings_Calling_ForceTcpCall <Boolean>
-SecurityGroupSettings_GlobalFederation <Boolean>
-GroupId <String>
-SecurityGroupSettings_Shredder_Intensity <Int32>
-SecurityGroupSettings_IsAtoEnabled <Boolean>
-SecurityGroupSettings_IsLinkPreviewEnabled <Boolean>
-SecurityGroupSettings_LocationAllowMap <Boolean>
-SecurityGroupSettings_LocationEnabled <Boolean>
-SecurityGroupSettings_LockoutThreshold <Int32>
-SecurityGroupSettings_PasswordRequirements_Lowercase <Int32>
-SecurityGroupSettings_MaxAutoDownloadSize <Int64>
-SecurityGroupSettings_MaxBor <Int32>
-SecurityGroupSettings_MaxTtl <Int64>
-SecurityGroupSettings_MessageForwardingEnabled <Boolean>
-SecurityGroupSettings_PasswordRequirements_MinLength <Int32>
-Name <String>
-NetworkId <String>
-SecurityGroupSettings_PasswordRequirements_Number <Int32>
-SecurityGroupSettings_PermittedNetwork <String[]>
-SecurityGroupSettings_PermittedWickrAwsNetwork <WickrAwsNetworks[]>
-SecurityGroupSettings_PermittedWickrEnterpriseNetwork <PermittedWickrEnterpriseNetwork[]>
-SecurityGroupSettings_PresenceEnabled <Boolean>
-SecurityGroupSettings_QuickResponse <String[]>
-SecurityGroupSettings_ShowMasterRecoveryKey <Boolean>
-SecurityGroupSettings_SsoMaxIdleMinute <Int32>
-SecurityGroupSettings_PasswordRequirements_Symbol <Int32>
-SecurityGroupSettings_PasswordRequirements_Uppercase <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonWickrConfig>

Description

Updates the properties of an existing security group in a Wickr network, such as its name or settings.

Parameters

-ClientConfig <AmazonWickrConfig>
Amazon.PowerShell.Cmdlets.WIC.AmazonWickrClientCmdlet.ClientConfig
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)
-GroupId <String>
The unique identifier of the security group to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The new name for the security group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkId <String>
The ID of the Wickr network containing the security group to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_AlwaysReauthenticate <Boolean>
Requires users to reauthenticate every time they return to the application, providing an additional layer of security.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_AtakPackageValue <String[]>
Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_AtakPackageValues
-SecurityGroupSettings_Calling_CanStart11Call <Boolean>
Specifies whether users can start one-to-one calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_Calling_CanVideoCall <Boolean>
Specifies whether users can make video calls (as opposed to audio-only calls). Valid only when audio call(canStart11Call) is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_Calling_ForceTcpCall <Boolean>
When enabled, forces all calls to use TCP protocol instead of UDP for network traversal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_CheckForUpdate <Boolean>
Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_CheckForUpdates
-SecurityGroupSettings_EnableAtak <Boolean>
Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_EnableCrashReport <Boolean>
Allow users to report crashes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_EnableCrashReports
-SecurityGroupSettings_EnableFileDownload <Boolean>
Specifies whether users can download files from messages to their devices.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_EnableGuestFederation <Boolean>
Allows users to communicate with guest users from other Wickr networks and federated external networks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_EnableNotificationPreview <Boolean>
Enables message preview text in push notifications, allowing users to see message content before opening the app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_EnableOpenAccessOption <Boolean>
Allow users to avoid censorship when they are geo-blocked or have network limitations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_EnableRestrictedGlobalFederation <Boolean>
Enables restricted global federation, limiting external communication to only specified permitted networks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_FederationMode <Int32>
The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_FilesEnabled <Boolean>
Enables file sharing capabilities, allowing users to send and receive files in conversations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_ForceDeviceLockout <Int32>
Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_ForceOpenAccess <Boolean>
Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_ForceReadReceipt <Boolean>
Allow user approved bots to read messages in rooms without using a slash command.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_ForceReadReceipts
-SecurityGroupSettings_GlobalFederation <Boolean>
Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_IsAtoEnabled <Boolean>
Enforces a two-factor authentication when a user adds a new device to their account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_IsLinkPreviewEnabled <Boolean>
Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_LocationAllowMap <Boolean>
Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_LocationAllowMaps
-SecurityGroupSettings_LocationEnabled <Boolean>
Enables location sharing features, allowing users to share their current location with others.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_LockoutThreshold <Int32>
The number of failed password attempts before a user account is locked out.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_MaxAutoDownloadSize <Int64>
The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_MaxBor <Int32>
The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_MaxTtl <Int64>
The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_MessageForwardingEnabled <Boolean>
Enables message forwarding, allowing users to forward messages from one conversation to another.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_PasswordRequirements_Lowercase <Int32>
The minimum number of lowercase letters required in passwords.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_PasswordRequirements_MinLength <Int32>
The minimum password length in characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_PasswordRequirements_Number <Int32>
The minimum number of numeric characters required in passwords.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_PasswordRequirements_Numbers
-SecurityGroupSettings_PasswordRequirements_Symbol <Int32>
The minimum number of special symbol characters required in passwords.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_PasswordRequirements_Symbols
-SecurityGroupSettings_PasswordRequirements_Uppercase <Int32>
The minimum number of uppercase letters required in passwords.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_PermittedNetwork <String[]>
A list of network IDs that are permitted for local federation when federation mode is set to restricted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_PermittedNetworks
-SecurityGroupSettings_PermittedWickrAwsNetwork <WickrAwsNetworks[]>
A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_PermittedWickrAwsNetworks
-SecurityGroupSettings_PermittedWickrEnterpriseNetwork <PermittedWickrEnterpriseNetwork[]>
A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_PermittedWickrEnterpriseNetworks
-SecurityGroupSettings_PresenceEnabled <Boolean>
Enables presence indicators that show whether users are online, away, or offline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_QuickResponse <String[]>
A list of pre-defined quick response message templates that users can send with a single tap.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_QuickResponses
-SecurityGroupSettings_ShowMasterRecoveryKey <Boolean>
Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_Shredder_CanProcessManually <Boolean>
Specifies whether users can manually trigger the shredder to delete content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_Shredder_Intensity <Int32>
Prevents Wickr data from being recovered by overwriting deleted Wickr data. Valid Values: Must be one of [0, 20, 60, 100]
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupSettings_SsoMaxIdleMinute <Int32>
The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupSettings_SsoMaxIdleMinutes
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'SecurityGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Wickr.Model.UpdateSecurityGroupResponse). Specifying the name of a property of type Amazon.Wickr.Model.UpdateSecurityGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
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

Amazon.Wickr.Model.SecurityGroup or Amazon.Wickr.Model.UpdateSecurityGroupResponse
This cmdlet returns an Amazon.Wickr.Model.SecurityGroup object. The service call response (type Amazon.Wickr.Model.UpdateSecurityGroupResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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