Skip to content

GetFolderOutput

Source code in docs_src/capo_codecommit/types/get_folder_output.py
class GetFolderOutput(TypedDict, closed=True):
    commit_id: "capo_codecommit.types.object_id.ObjectId"
    """<p>The full commit ID used as a reference for the returned version of the folder content.</p>"""
    folder_path: "capo_codecommit.types.path.Path"
    """<p>The fully qualified path of the folder whose contents are returned.</p>"""
    tree_id: NotRequired["capo_codecommit.types.object_id.ObjectId"]
    """<p>The full SHA-1 pointer of the tree information for the commit that contains the folder.</p>"""
    sub_folders: NotRequired["capo_codecommit.types.folder_list.FolderList"]
    """<p>The list of folders that exist under the specified folder, if any.</p>"""
    files: NotRequired["capo_codecommit.types.file_list.FileList"]
    """<p>The list of files in the specified folder, if any.</p>"""
    symbolic_links: NotRequired[
        "capo_codecommit.types.symbolic_link_list.SymbolicLinkList"
    ]
    """<p>The list of symbolic links to other files and folders in the specified folder, if any.</p>"""
    sub_modules: NotRequired["capo_codecommit.types.sub_module_list.SubModuleList"]
    """<p>The list of submodules in the specified folder, if any.</p>"""

commit_id instance-attribute

commit_id: ObjectId

The full commit ID used as a reference for the returned version of the folder content.

files instance-attribute

files: NotRequired[FileList]

The list of files in the specified folder, if any.

folder_path instance-attribute

folder_path: Path

The fully qualified path of the folder whose contents are returned.

sub_folders instance-attribute

sub_folders: NotRequired[FolderList]

The list of folders that exist under the specified folder, if any.

sub_modules instance-attribute

sub_modules: NotRequired[SubModuleList]

The list of submodules in the specified folder, if any.

symbolic_links: NotRequired[SymbolicLinkList]

The list of symbolic links to other files and folders in the specified folder, if any.

tree_id instance-attribute

tree_id: NotRequired[ObjectId]

The full SHA-1 pointer of the tree information for the commit that contains the folder.