DirectoryService / Client / create_computer

create_computer#

DirectoryService.Client.create_computer(**kwargs)#

Creates an Active Directory computer object in the specified directory.

See also: AWS API Documentation

Request Syntax

response = client.create_computer(
    DirectoryId='string',
    ComputerName='string',
    Password='string',
    OrganizationalUnitDistinguishedName='string',
    ComputerAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory in which to create the computer account.

  • ComputerName (string) –

    [REQUIRED]

    The name of the computer account.

  • Password (string) –

    [REQUIRED]

    A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

  • OrganizationalUnitDistinguishedName (string) – The fully-qualified distinguished name of the organizational unit to place the computer account in.

  • ComputerAttributes (list) –

    An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

    • (dict) –

      Represents a named directory attribute.

      • Name (string) –

        The name of the attribute.

      • Value (string) –

        The value of the attribute.

Return type:

dict

Returns:

Response Syntax

{
    'Computer': {
        'ComputerId': 'string',
        'ComputerName': 'string',
        'ComputerAttributes': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    Contains the results for the CreateComputer operation.

    • Computer (dict) –

      A Computer object that represents the computer account.

      • ComputerId (string) –

        The identifier of the computer.

      • ComputerName (string) –

        The computer name.

      • ComputerAttributes (list) –

        An array of Attribute objects containing the LDAP attributes that belong to the computer account.

        • (dict) –

          Represents a named directory attribute.

          • Name (string) –

            The name of the attribute.

          • Value (string) –

            The value of the attribute.

Exceptions