Skip to content

PutFileInput

Source code in docs_src/capo_codecommit/types/put_file_input.py
class PutFileInput(TypedDict, closed=True):
    repository_name: "capo_codecommit.types.repository_name.RepositoryName"
    """<p>The name of the repository where you want to add or update the file.</p>"""
    branch_name: "capo_codecommit.types.branch_name.BranchName"
    """<p>The name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.</p>"""
    file_content: "capo_codecommit.types.file_content.FileContent"
    """<p>The content of the file, in binary object format. </p>"""
    file_path: "capo_codecommit.types.path.Path"
    """<p>The name of the file you want to add or update, including the relative path to the file in the repository.</p> <note> <p>If the path does not currently exist in the repository, the path is created as part of adding the file.</p> </note>"""
    file_mode: NotRequired["capo_codecommit.types.file_mode_type_enum.FileModeTypeEnum"]
    """<p>The file mode permissions of the blob. Valid file mode permissions are listed here.</p>"""
    parent_commit_id: NotRequired["capo_codecommit.types.commit_id.CommitId"]
    """<p>The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required. </p> <p>The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.</p>"""
    commit_message: NotRequired["capo_codecommit.types.message.Message"]
    """<p>A message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.</p>"""
    name: NotRequired["capo_codecommit.types.name.Name"]
    """<p>The name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.</p>"""
    email: NotRequired["capo_codecommit.types.email.Email"]
    """<p>An email address for the person adding or updating the file.</p>"""

branch_name instance-attribute

branch_name: BranchName

The name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.

commit_message instance-attribute

commit_message: NotRequired[Message]

A message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.

email instance-attribute

email: NotRequired[Email]

An email address for the person adding or updating the file.

file_content instance-attribute

file_content: FileContent

The content of the file, in binary object format.

file_mode instance-attribute

file_mode: NotRequired[FileModeTypeEnum]

The file mode permissions of the blob. Valid file mode permissions are listed here.

file_path instance-attribute

file_path: Path

The name of the file you want to add or update, including the relative path to the file in the repository.

If the path does not currently exist in the repository, the path is created as part of adding the file.

name instance-attribute

name: NotRequired[Name]

The name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.

parent_commit_id instance-attribute

parent_commit_id: NotRequired[CommitId]

The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.

The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.

repository_name instance-attribute

repository_name: RepositoryName

The name of the repository where you want to add or update the file.