Skip to content

Returns the base-64 encoded contents of a specified file and its metadata

Description

Returns the base-64 encoded contents of a specified file and its metadata.

Usage

codecommit_get_file(repositoryName, commitSpecifier, filePath)

Arguments

  • repositoryName

    [required] The name of the repository that contains the file.

  • commitSpecifier

    The fully quaified reference that identifies the commit that contains the file. For example, you can specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/main. If none is provided, the head commit is used.

  • filePath

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

Value

A list with the following syntax:

list(
  commitId = "string",
  blobId = "string",
  filePath = "string",
  fileMode = "EXECUTABLE"|"NORMAL"|"SYMLINK",
  fileSize = 123,
  fileContent = raw
)

Request syntax

svc$get_file(
  repositoryName = "string",
  commitSpecifier = "string",
  filePath = "string"
)