/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeCommit::DeleteFile

NAME

Paws::CodeCommit::DeleteFile - Arguments for method DeleteFile on Paws::CodeCommit

DESCRIPTION

This class represents the parameters used for calling the method DeleteFile on the AWS CodeCommit service. Use the attributes of this class as arguments to method DeleteFile.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteFile.

SYNOPSIS

my $codecommit = Paws->service('CodeCommit');
my $DeleteFileOutput = $codecommit->DeleteFile(
  BranchName       => 'MyBranchName',
  FilePath         => 'MyPath',
  ParentCommitId   => 'MyCommitId',
  RepositoryName   => 'MyRepositoryName',
  CommitMessage    => 'MyMessage',          # OPTIONAL
  Email            => 'MyEmail',            # OPTIONAL
  KeepEmptyFolders => 1,                    # OPTIONAL
  Name             => 'MyName',             # OPTIONAL
);

# Results:
my $BlobId   = $DeleteFileOutput->BlobId;
my $CommitId = $DeleteFileOutput->CommitId;
my $FilePath = $DeleteFileOutput->FilePath;
my $TreeId   = $DeleteFileOutput->TreeId;

# Returns a L<Paws::CodeCommit::DeleteFileOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codecommit/DeleteFile

ATTRIBUTES

REQUIRED BranchName => Str

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

CommitMessage => Str

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 => Str

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

REQUIRED FilePath => Str

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.

KeepEmptyFolders => 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.

Name => Str

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.

REQUIRED ParentCommitId => Str

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.

REQUIRED RepositoryName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteFile in Paws::CodeCommit

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues