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 WorkMail UpdateUser API operation.

Syntax

Update-WMUser
-UserId <String>
-City <String>
-Company <String>
-Country <String>
-Department <String>
-DisplayName <String>
-FirstName <String>
-HiddenFromGlobalAddressList <Boolean>
-IdentityProviderUserId <String>
-Initial <String>
-JobTitle <String>
-LastName <String>
-Office <String>
-OrganizationId <String>
-Role <UserRole>
-Street <String>
-Telephone <String>
-ZipCode <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkMailConfig>

Description

Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.

Parameters

-City <String>
Updates the user's city.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonWorkMailConfig>
Amazon.PowerShell.Cmdlets.WM.AmazonWorkMailClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Company <String>
Updates the user's company.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Country <String>
Updates the user's country.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Department <String>
Updates the user's department.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
Updates the display name of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirstName <String>
Updates the user's first name.
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)
-HiddenFromGlobalAddressList <Boolean>
If enabled, the user is hidden from the global address list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityProviderUserId <String>
User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Initial <String>
Updates the user's initials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitials
-JobTitle <String>
Updates the user's job title.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LastName <String>
Updates the user's last name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Office <String>
Updates the user's office.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OrganizationId <String>
The identifier for the organization under which the user exists.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Role <UserRole>
Updates the user role.You cannot pass SYSTEM_USER or RESOURCE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.WorkMail.Model.UpdateUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Street <String>
Updates the user's street address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Telephone <String>
Updates the user's contact details.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserId <String>
The identifier for the user to be updated.The identifier can be the UserId, Username, or email. The following identity formats are available:
  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
  • Email address: user@domain.tld
  • User name: user
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ZipCode <String>
Updates the user's zip code.
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.WorkMail.Model.UpdateUserResponse
This cmdlet does not generate any output.The service response (type Amazon.WorkMail.Model.UpdateUserResponse) be returned by specifying '-Select *'.
Administrator Guide
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

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