[ aws . codecommit ]

get-repository

Description

Returns information about a repository.

Note

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-repository
--repository-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--repository-name (string)

The name of the repository to get information about.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

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 information about a repository

This example shows details about an AWS CodeCommit repository.

aws codecommit get-repository \
    --repository-name MyDemoRepo

Output:

{
    "repositoryMetadata": {
        "creationDate": 1429203623.625,
        "defaultBranch": "main",
        "repositoryName": "MyDemoRepo",
        "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/v1/repos/MyDemoRepo",
        "lastModifiedDate": 1430783812.0869999,
        "repositoryDescription": "My demonstration repository",
        "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
        "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
        "Arn": "arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
        "accountId": "111111111111"
    }
}

Output

repositoryMetadata -> (structure)

Information about the repository.

accountId -> (string)

The ID of the AWS account associated with the repository.

repositoryId -> (string)

The ID of the repository.

repositoryName -> (string)

The repository’s name.

repositoryDescription -> (string)

A comment or description about the repository.

defaultBranch -> (string)

The repository’s default branch name.

lastModifiedDate -> (timestamp)

The date and time the repository was last modified, in timestamp format.

creationDate -> (timestamp)

The date and time the repository was created, in timestamp format.

cloneUrlHttp -> (string)

The URL to use for cloning the repository over HTTPS.

cloneUrlSsh -> (string)

The URL to use for cloning the repository over SSH.

Arn -> (string)

The Amazon Resource Name (ARN) of the repository.