Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codecommit ]

get-folder

Description

Returns the contents of a specified folder in a repository.

See also: AWS API Documentation

Synopsis

  get-folder
--repository-name <value>
[--commit-specifier <value>]
--folder-path <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--repository-name (string)

The name of the repository.

--commit-specifier (string)

A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.

--folder-path (string)

The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get the contents of a folder in an AWS CodeCommit repository

The following get-folder example demonstrates how to get the contents of a top-level folder from a repository named MyDemoRepo.

aws codecommit get-folder --repository-name MyDemoRepo --folder-path ""

Output:

{
    "commitId":"c5709475EXAMPLE",
    "files":[
        {
            "absolutePath":".gitignore",
            "blobId":"74094e8bEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":".gitignore"
        },
        {
            "absolutePath":"Gemfile",
            "blobId":"9ceb72f6EXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"Gemfile"
        },
        {
            "absolutePath":"Gemfile.lock",
            "blobId":"795c4a2aEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"Gemfile.lock"
        },
        {
            "absolutePath":"LICENSE.txt",
            "blobId":"0c7932c8EXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"LICENSE.txt"
        },
        {
            "absolutePath":"README.md",
            "blobId":"559b44feEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"README.md"
        }
    ],
    "folderPath":"",
    "subFolders":[
        {
            "absolutePath":"public",
            "relativePath":"public",
            "treeId":"d5e92ae3aEXAMPLE"
        },
        {
            "absolutePath":"tmp",
            "relativePath":"tmp",
            "treeId":"d564d0bcEXAMPLE"
        }
    ],
    "subModules":[],
    "symbolicLinks":[],
    "treeId":"7b3c4dadEXAMPLE"
}

For more information, see GetFolder in the AWS CodeCommit API Reference guide.

Output

commitId -> (string)

The full commit ID used as a reference for the returned version of the folder content.

folderPath -> (string)

The fully qualified path of the folder whose contents are returned.

treeId -> (string)

The full SHA-1 pointer of the tree information for the commit that contains the folder.

subFolders -> (list)

The list of folders that exist under the specified folder, if any.

(structure)

Returns information about a folder in a repository.

treeId -> (string)

The full SHA-1 pointer of the tree information for the commit that contains the folder.

absolutePath -> (string)

The fully qualified path of the folder in the repository.

relativePath -> (string)

The relative path of the specified folder from the folder where the query originated.

files -> (list)

The list of files in the specified folder, if any.

(structure)

Returns information about a file in a repository.

blobId -> (string)

The blob ID that contains the file information.

absolutePath -> (string)

The fully qualified path to the file in the repository.

relativePath -> (string)

The relative path of the file from the folder where the query originated.

fileMode -> (string)

The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

symbolicLinks -> (list)

The list of symbolic links to other files and folders in the specified folder, if any.

(structure)

Returns information about a symbolic link in a repository folder.

blobId -> (string)

The blob ID that contains the information about the symbolic link.

absolutePath -> (string)

The fully qualified path to the folder that contains the symbolic link.

relativePath -> (string)

The relative path of the symbolic link from the folder where the query originated.

fileMode -> (string)

The file mode permissions of the blob that cotains information about the symbolic link.

subModules -> (list)

The list of submodules in the specified folder, if any.

(structure)

Returns information about a submodule reference in a repository folder.

commitId -> (string)

The commit ID that contains the reference to the submodule.

absolutePath -> (string)

The fully qualified path to the folder that contains the reference to the submodule.

relativePath -> (string)

The relative path of the submodule from the folder where the query originated.