Transfer / Client / create_user

create_user

Transfer.Client.create_user(**kwargs)

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user’s public key, and assign the user’s Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    HomeDirectory='string',
    HomeDirectoryType='PATH'|'LOGICAL',
    HomeDirectoryMappings=[
        {
            'Entry': 'string',
            'Target': 'string',
            'Type': 'FILE'|'DIRECTORY'
        },
    ],
    Policy='string',
    PosixProfile={
        'Uid': 123,
        'Gid': 123,
        'SecondaryGids': [
            123,
        ]
    },
    Role='string',
    ServerId='string',
    SshPublicKeyBody='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    UserName='string'
)

Parameters:

• HomeDirectory (string) –

  The landing directory (folder) for a user when they log in to the server using the client.

  A HomeDirectory example is /bucket_name/home/mydirectory.

  Note

  The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

• HomeDirectoryType (string) –

  The type of landing directory (folder) that you want your users’ home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

  Note

  If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

• HomeDirectoryMappings (list) –

  Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

  The following is an Entry and Target pair example.

  [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

  In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (” chroot”). To do this, you can set Entry to / and set Target to the value the user should see for their home directory when they log in.

  The following is an Entry and Target pair example for chroot.

  [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

  • (dict) –

    Represents an object that contains entries and targets for HomeDirectoryMappings.

    The following is an Entry and Target pair example for chroot.

    [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

    • Entry (string) – [REQUIRED]

      Represents an entry for HomeDirectoryMappings.

    • Target (string) – [REQUIRED]

      Represents the map target that is used in a HomeDirectoryMapEntry.

    • Type (string) –

      Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

      Note

      By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.

• Policy (string) –

  A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user’s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

  Note

  This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

  For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

  For an example of a session policy, see Example session policy.

  For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

• PosixProfile (dict) –

  Specifies the full POSIX identity, including user ID ( Uid), group ID ( Gid), and any secondary groups IDs ( SecondaryGids), that controls your users’ access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

  • Uid (integer) – [REQUIRED]

    The POSIX user ID used for all EFS operations by this user.

  • Gid (integer) – [REQUIRED]

    The POSIX group ID used for all EFS operations by this user.

  • SecondaryGids (list) –

    The secondary POSIX group IDs used for all EFS operations by this user.

    • (integer) –

• Role (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users’ access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users’ transfer requests.

• ServerId (string) –

  [REQUIRED]

  A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

• SshPublicKeyBody (string) –

  The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

  The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

  Transfer Family accepts RSA, ECDSA, and ED25519 keys.

  • For RSA keys, the key type is ssh-rsa.

  • For ED25519 keys, the key type is ssh-ed25519.

  • For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

• Tags (list) –

  Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

  • (dict) –

    Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

    • Key (string) – [REQUIRED]

      The name assigned to the tag that you create.

    • Value (string) – [REQUIRED]

      Contains one or more values that you assigned to the key name you create.

• UserName (string) –

  [REQUIRED]

  A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore ‘_’, hyphen ‘-’, period ‘.’, and at sign ‘@’. The user name can’t start with a hyphen, period, or at sign.

Return type:

dict

Returns:

Response Syntax

{
    'ServerId': 'string',
    'UserName': 'string'
}

Response Structure

• (dict) –

  • ServerId (string) –

    The identifier of the server that the user is attached to.

  • UserName (string) –

    A unique string that identifies a Transfer Family user.

Exceptions

• Transfer.Client.exceptions.ResourceNotFoundException

• Transfer.Client.exceptions.InvalidRequestException

• Transfer.Client.exceptions.InternalServiceError

• Transfer.Client.exceptions.ServiceUnavailableException

• Transfer.Client.exceptions.ResourceExistsException