CloudDirectory / Client / create_directory

create_directory

CloudDirectory.Client.create_directory(**kwargs)

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_directory(
    Name='string',
    SchemaArn='string'
)

Parameters:

• Name (string) –

  [REQUIRED]

  The name of the Directory. Should be unique per account, per region.

• SchemaArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Return type:

dict

Returns:

Response Syntax

{
    'DirectoryArn': 'string',
    'Name': 'string',
    'ObjectIdentifier': 'string',
    'AppliedSchemaArn': 'string'
}

Response Structure

• (dict) –

  • DirectoryArn (string) –

    The ARN that is associated with the Directory. For more information, see arns.

  • Name (string) –

    The name of the Directory.

  • ObjectIdentifier (string) –

    The root object node of the created directory.

  • AppliedSchemaArn (string) –

    The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

Exceptions

• CloudDirectory.Client.exceptions.InternalServiceException

• CloudDirectory.Client.exceptions.InvalidArnException

• CloudDirectory.Client.exceptions.RetryableConflictException

• CloudDirectory.Client.exceptions.ValidationException

• CloudDirectory.Client.exceptions.LimitExceededException

• CloudDirectory.Client.exceptions.AccessDeniedException

• CloudDirectory.Client.exceptions.DirectoryAlreadyExistsException

• CloudDirectory.Client.exceptions.ResourceNotFoundException