OpsWorks / Client / create_user_profile

create_user_profile#

OpsWorks.Client.create_user_profile(**kwargs)#

Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.create_user_profile(
    IamUserArn='string',
    SshUsername='string',
    SshPublicKey='string',
    AllowSelfManagement=True|False
)
Parameters:

  • IamUserArn (string) –

    [REQUIRED]

    The user’s IAM ARN; this can also be a federated user’s ARN.

  • SshUsername (string) – The user’s SSH user name. The allowable characters are [a-z], [A-Z], [0-9], ‘-’, and ‘_’. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

  • SshPublicKey (string) – The user’s public SSH key.

  • AllowSelfManagement (boolean) – Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User’s Public SSH Key.

Return type:

dict

Returns:

Response Syntax

{
    'IamUserArn': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a CreateUserProfile request.

    • IamUserArn (string) –

      The user’s IAM ARN.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException