Skip to content

GetFolderInput

Source code in docs_src/capo_codecommit/types/get_folder_input.py
class GetFolderInput(TypedDict, closed=True):
    repository_name: "capo_codecommit.types.repository_name.RepositoryName"
    """<p>The name of the repository.</p>"""
    commit_specifier: NotRequired["capo_codecommit.types.commit_name.CommitName"]
    """<p>A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.</p>"""
    folder_path: "capo_codecommit.types.path.Path"
    """<p>The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository. </p>"""

commit_specifier instance-attribute

commit_specifier: NotRequired[CommitName]

A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.

folder_path instance-attribute

folder_path: Path

The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

repository_name instance-attribute

repository_name: RepositoryName

The name of the repository.