CodeCommit / Client / get_file

get_file

CodeCommit.Client.get_file(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_file(
    repositoryName='string',
    commitSpecifier='string',
    filePath='string'
)

Parameters:

• repositoryName (string) –

  [REQUIRED]

  The name of the repository that contains the file.

• commitSpecifier (string) – 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 (string) –

  [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.

Return type:

dict

Returns:

Response Syntax

{
    'commitId': 'string',
    'blobId': 'string',
    'filePath': 'string',
    'fileMode': 'EXECUTABLE'|'NORMAL'|'SYMLINK',
    'fileSize': 123,
    'fileContent': b'bytes'
}

Response Structure

• (dict) –

  • commitId (string) –

    The full commit ID of the commit that contains the content returned by GetFile.

  • blobId (string) –

    The blob ID of the object that represents the file content.

  • filePath (string) –

    The fully qualified path to the specified file. Returns the name and extension of the file.

  • fileMode (string) –

    The extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not numeric values.

    Note

    The file mode permissions returned by this API are not the standard file mode permission values, such as 100644, but rather extrapolated values. See the supported return values.

  • fileSize (integer) –

    The size of the contents of the file, in bytes.

  • fileContent (bytes) –

    The base-64 encoded binary data object that represents the content of the file.

Exceptions

• CodeCommit.Client.exceptions.RepositoryNameRequiredException

• CodeCommit.Client.exceptions.InvalidRepositoryNameException

• CodeCommit.Client.exceptions.RepositoryDoesNotExistException

• CodeCommit.Client.exceptions.InvalidCommitException

• CodeCommit.Client.exceptions.CommitDoesNotExistException

• CodeCommit.Client.exceptions.PathRequiredException

• CodeCommit.Client.exceptions.InvalidPathException

• CodeCommit.Client.exceptions.FileDoesNotExistException

• CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException

• CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException

• CodeCommit.Client.exceptions.EncryptionKeyDisabledException

• CodeCommit.Client.exceptions.EncryptionKeyNotFoundException

• CodeCommit.Client.exceptions.EncryptionKeyUnavailableException

• CodeCommit.Client.exceptions.FileTooLargeException