Method: Aws::IAM::User#update

Defined in:
lib/aws-sdk-iam/user.rb

#update(options = {}) ⇒ User

Examples:

Request syntax with placeholder values


user = user.update({
  new_path: "pathType",
  new_user_name: "userNameType",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :new_path (String) —

    New path for the IAM user. Include this parameter only if you’re changing the user’s path.

    This parameter allows (through its [regex pattern]) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (‘u0021`) through the DEL character (`u007F`), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: wikipedia.org/wiki/regex

  • :new_user_name (String) —

    New name for the user. Include this parameter only if you’re changing the user’s name.

    IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.

Returns:



703
704
705
706
707
708
709
710
711
712
 
# File 'lib/aws-sdk-iam/user.rb', line 703

def update(options = {})
  options = options.merge(user_name: @name)
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_user(options)
  end
  User.new(
    name: options[:new_user_name],
    client: @client
  )
end