libZSservicesZSamazonka-codecommitZSamazonka-codecommit
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeCommit.DeleteFile

Description

Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file still exists in the commits earlier to the commit that contains the deletion.

Synopsis

Creating a Request

data DeleteFile Source #

See: newDeleteFile smart constructor.

Constructors

DeleteFile' 

Fields

  • email :: Maybe Text

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

  • name :: Maybe Text

    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.

  • commitMessage :: Maybe Text

    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.

  • keepEmptyFolders :: Maybe Bool

    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.

  • repositoryName :: Text

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

  • branchName :: Text

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

  • filePath :: Text

    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.

  • parentCommitId :: Text

    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.

Instances

Instances details
Eq DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

(==) :: DeleteFile -> DeleteFile -> Bool #

(/=) :: DeleteFile -> DeleteFile -> Bool #

Read DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

readsPrec :: Int -> ReadS DeleteFile #

readList :: ReadS [DeleteFile] #

readPrec :: ReadPrec DeleteFile #

readListPrec :: ReadPrec [DeleteFile] #

Show DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

showsPrec :: Int -> DeleteFile -> ShowS #

show :: DeleteFile -> String #

showList :: [DeleteFile] -> ShowS #

Generic DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Associated Types

type Rep DeleteFile :: Type -> Type #

Methods

from :: DeleteFile -> Rep DeleteFile x #

to :: Rep DeleteFile x -> DeleteFile #

NFData DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

rnf :: DeleteFile -> () #

Hashable DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

hashWithSalt :: Int -> DeleteFile -> Int #

hash :: DeleteFile -> Int #

ToJSON DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

toJSON :: DeleteFile -> Value #

toEncoding :: DeleteFile -> Encoding #

toJSONList :: [DeleteFile] -> Value #

toEncodingList :: [DeleteFile] -> Encoding #

AWSRequest DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Associated Types

type AWSResponse DeleteFile #

Methods

request :: DeleteFile -> Request DeleteFile #

response :: MonadResource m => Logger -> Service -> Proxy DeleteFile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteFile))) #

ToHeaders DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

toHeaders :: DeleteFile -> [Header] #

ToPath DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

toPath :: DeleteFile -> ByteString #

ToQuery DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

toQuery :: DeleteFile -> QueryString #

type Rep DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

type Rep DeleteFile = D1 ('MetaData "DeleteFile" "Amazonka.CodeCommit.DeleteFile" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "DeleteFile'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "commitMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keepEmptyFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "filePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "parentCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DeleteFile Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

type AWSResponse DeleteFile = DeleteFileResponse

newDeleteFile Source #

Arguments

:: Text

$sel:repositoryName:DeleteFile'

-> Text

$sel:branchName:DeleteFile'

-> Text

$sel:filePath:DeleteFile'

-> Text

$sel:parentCommitId:DeleteFile'

-> DeleteFile 

Create a value of DeleteFile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:email:DeleteFile', deleteFile_email - The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.

$sel:name:DeleteFile', deleteFile_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.

$sel:commitMessage:DeleteFile', deleteFile_commitMessage - 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.

$sel:keepEmptyFolders:DeleteFile', deleteFile_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.

$sel:repositoryName:DeleteFile', deleteFile_repositoryName - The name of the repository that contains the file to delete.

$sel:branchName:DeleteFile', deleteFile_branchName - The name of the branch where the commit that deletes the file is made.

$sel:filePath:DeleteFile', deleteFile_filePath - 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.

$sel:parentCommitId:DeleteFile', deleteFile_parentCommitId - 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.

Request Lenses

deleteFile_email :: Lens' DeleteFile (Maybe Text) Source #

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

deleteFile_name :: Lens' DeleteFile (Maybe Text) Source #

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.

deleteFile_commitMessage :: Lens' DeleteFile (Maybe Text) Source #

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.

deleteFile_keepEmptyFolders :: Lens' DeleteFile (Maybe Bool) Source #

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.

deleteFile_repositoryName :: Lens' DeleteFile Text Source #

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

deleteFile_branchName :: Lens' DeleteFile Text Source #

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

deleteFile_filePath :: Lens' DeleteFile Text Source #

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.

deleteFile_parentCommitId :: Lens' DeleteFile Text Source #

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.

Destructuring the Response

data DeleteFileResponse Source #

See: newDeleteFileResponse smart constructor.

Constructors

DeleteFileResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • commitId :: Text

    The full commit ID of the commit that contains the change that deletes the file.

  • blobId :: Text

    The blob ID removed from the tree as part of deleting the file.

  • treeId :: Text

    The full SHA-1 pointer of the tree information for the commit that contains the delete file change.

  • filePath :: Text

    The fully qualified path to the file to be deleted, including the full name and extension of that file.

Instances

Instances details
Eq DeleteFileResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

(==) :: DeleteFileResponse -> DeleteFileResponse -> Bool #

(/=) :: DeleteFileResponse -> DeleteFileResponse -> Bool #

Read DeleteFileResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

readsPrec :: Int -> ReadS DeleteFileResponse #

readList :: ReadS [DeleteFileResponse] #

readPrec :: ReadPrec DeleteFileResponse #

readListPrec :: ReadPrec [DeleteFileResponse] #

Show DeleteFileResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

showsPrec :: Int -> DeleteFileResponse -> ShowS #

show :: DeleteFileResponse -> String #

showList :: [DeleteFileResponse] -> ShowS #

Generic DeleteFileResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Associated Types

type Rep DeleteFileResponse :: Type -> Type #

Methods

from :: DeleteFileResponse -> Rep DeleteFileResponse x #

to :: Rep DeleteFileResponse x -> DeleteFileResponse #

NFData DeleteFileResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

Methods

rnf :: DeleteFileResponse -> () #

type Rep DeleteFileResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.DeleteFile

type Rep DeleteFileResponse = D1 ('MetaData "DeleteFileResponse" "Amazonka.CodeCommit.DeleteFile" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "DeleteFileResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "commitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "blobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "treeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "filePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDeleteFileResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteFileResponse'

-> Text

$sel:commitId:DeleteFileResponse'

-> Text

$sel:blobId:DeleteFileResponse'

-> Text

$sel:treeId:DeleteFileResponse'

-> Text

$sel:filePath:DeleteFile'

-> DeleteFileResponse 

Create a value of DeleteFileResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteFileResponse', deleteFileResponse_httpStatus - The response's http status code.

$sel:commitId:DeleteFileResponse', deleteFileResponse_commitId - The full commit ID of the commit that contains the change that deletes the file.

$sel:blobId:DeleteFileResponse', deleteFileResponse_blobId - The blob ID removed from the tree as part of deleting the file.

$sel:treeId:DeleteFileResponse', deleteFileResponse_treeId - The full SHA-1 pointer of the tree information for the commit that contains the delete file change.

$sel:filePath:DeleteFile', deleteFileResponse_filePath - The fully qualified path to the file to be deleted, including the full name and extension of that file.

Response Lenses

deleteFileResponse_httpStatus :: Lens' DeleteFileResponse Int Source #

The response's http status code.

deleteFileResponse_commitId :: Lens' DeleteFileResponse Text Source #

The full commit ID of the commit that contains the change that deletes the file.

deleteFileResponse_blobId :: Lens' DeleteFileResponse Text Source #

The blob ID removed from the tree as part of deleting the file.

deleteFileResponse_treeId :: Lens' DeleteFileResponse Text Source #

The full SHA-1 pointer of the tree information for the commit that contains the delete file change.

deleteFileResponse_filePath :: Lens' DeleteFileResponse Text Source #

The fully qualified path to the file to be deleted, including the full name and extension of that file.