Skip to content

DeleteFileInput

Source code in docs_src/capo_codecommit/types/delete_file_input.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class DeleteFileInput(TypedDict, closed=True):
    repository_name: "capo_codecommit.types.repository_name.RepositoryName"
    """<p>The name of the repository that contains the file to delete.</p>"""
    branch_name: "capo_codecommit.types.branch_name.BranchName"
    """<p>The name of the branch where the commit that deletes the file is made.</p>"""
    file_path: "capo_codecommit.types.path.Path"
    """<p>The fully qualified path to the file that to be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.</p>"""
    parent_commit_id: "capo_codecommit.types.commit_id.CommitId"
    """<p>The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file. This must be the HEAD commit for the branch. The commit that deletes the file is created from this commit ID.</p>"""
    keep_empty_folders: "capo_codecommit.types.keep_empty_folders.KeepEmptyFolders"
    """<p>If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file. By default, empty folders are deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 also deletes the empty folders dir4, dir3, and dir2.</p>"""
    commit_message: NotRequired["capo_codecommit.types.message.Message"]
    """<p>The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message is used.</p>"""
    name: NotRequired["capo_codecommit.types.name.Name"]
    """<p>The name of the author of the commit that deletes the file. If no name is specified, the user's ARN is used as the author name and committer name.</p>"""
    email: NotRequired["capo_codecommit.types.email.Email"]
    """<p>The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.</p>"""

branch_name instance-attribute 

branch_name: BranchName

The name of the branch where the commit that deletes the file is made.

commit_message instance-attribute 

commit_message: NotRequired[Message]

The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message is used.

email instance-attribute 

email: NotRequired[Email]

The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.

file_path instance-attribute 

file_path: Path

The fully qualified path to the file that to be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.

keep_empty_folders instance-attribute 

keep_empty_folders: KeepEmptyFolders

If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file. By default, empty folders are deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 also deletes the empty folders dir4, dir3, and dir2.

name instance-attribute 

name: NotRequired[Name]

The name of the author of the commit that deletes the file. If no name is specified, the user's ARN is used as the author name and committer name.

parent_commit_id instance-attribute 

parent_commit_id: CommitId

The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file. This must be the HEAD commit for the branch. The commit that deletes the file is created from this commit ID.

repository_name instance-attribute 

repository_name: RepositoryName

The name of the repository that contains the file to delete.