Skip to content

StartSchemaExtensionRequest

Source code in docs_src/capo_directory_service/types/start_schema_extension_request.py
class StartSchemaExtensionRequest(TypedDict, closed=True):
    directory_id: "capo_directory_service.types.directory_id.DirectoryId"
    """<p>The identifier of the directory for which the schema extension will be applied to.</p>"""
    create_snapshot_before_schema_extension: "capo_directory_service.types.create_snapshot_before_schema_extension.CreateSnapshotBeforeSchemaExtension"
    """<p>If true, creates a snapshot of the directory before applying the schema extension.</p>"""
    ldif_content: "capo_directory_service.types.ldif_content.LdifContent"
    r"""<p>The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.</p>"""
    description: "capo_directory_service.types.description.Description"
    """<p>A description of the schema extension.</p>"""

create_snapshot_before_schema_extension instance-attribute

create_snapshot_before_schema_extension: CreateSnapshotBeforeSchemaExtension

If true, creates a snapshot of the directory before applying the schema extension.

description instance-attribute

description: Description

A description of the schema extension.

directory_id instance-attribute

directory_id: DirectoryId

The identifier of the directory for which the schema extension will be applied to.

ldif_content instance-attribute

ldif_content: LdifContent

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.