AWS API Changes

2015/07/09 - AWS CodeCommit - 11 new api methods

ListRepositories (new)

Gets information about one or more repositories.

Request Syntax

client.list_repositories(
    nextToken='string',
    sortBy='repositoryName'|'lastModifiedDate',
    order='ascending'|'descending'
)

type nextToken

string

param nextToken

An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.

type sortBy

string

param sortBy

The criteria used to sort the results of a list repositories operation.

type order

string

param order

The order in which to sort the results of a list repositories operation.

rtype

dict

returns

Response Syntax

{
    'repositories': [
        {
            'repositoryName': 'string',
            'repositoryId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

Represents the output of a list repositories operation.
- repositories (list) --
  
  Lists the repositories called by the list repositories operation.
  - (dict) --
    
    Information about a repository name and ID.
    - repositoryName (string) -- Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9), ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository name.
    - repositoryId (string) --
      
      The ID associated with the repository name.
- nextToken (string) --
  
  An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.

CreateRepository (new)

Link ¶

Creates a new, empty repository.

Request Syntax

client.create_repository(
    repositoryName='string',
    repositoryDescription='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the new repository to be created.

Note

The repository name must be unique across the calling AWS account. In addition, repository names are restricted to alphanumeric characters. The suffix ".git" is prohibited.

type repositoryDescription

string

param repositoryDescription

A comment or description about the new repository.

rtype

dict

returns

Response Syntax

{
    'repositoryMetadata': {
        'accountId': 'string',
        'repositoryId': 'string',
        'repositoryName': 'string',
        'repositoryDescription': 'string',
        'defaultBranch': 'string',
        'lastModifiedDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'cloneUrlHttp': 'string',
        'cloneUrlSsh': 'string',
        'Arn': 'string'
    }
}

Response Structure

(dict) --

Represents the output of a create repository operation.
- repositoryMetadata (dict) --
  
  Information about the newly created 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 (datetime) --
    
    The date and time the repository was last modified, in timestamp format.
  - creationDate (datetime) --
    
    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.

CreateBranch (new)

Link ¶

Creates a new branch in a repository and points the branch to a commit.

Note

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

Request Syntax

client.create_branch(
    repositoryName='string',
    branchName='string',
    commitId='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository in which you want to create the new branch.

type branchName

string

param branchName

[REQUIRED]

The name of the new branch to create.

type commitId

string

param commitId

[REQUIRED]

The ID of the commit to point the new branch to.

Note

If this commit ID is not specified, the new branch will point to the commit that is pointed to by the repository's default branch.

returns

None

BatchGetRepositories (new)

Link ¶

Gets information about one or more repositories.

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 web page could 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 web page.

Request Syntax

client.batch_get_repositories(
    repositoryNames=[
        'string',
    ]
)

type repositoryNames

list

param repositoryNames

[REQUIRED]

The names of the repositories to get information about.

(string) -- Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9), ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository name.

rtype

dict

returns

Response Syntax

{
    'repositories': [
        {
            'accountId': 'string',
            'repositoryId': 'string',
            'repositoryName': 'string',
            'repositoryDescription': 'string',
            'defaultBranch': 'string',
            'lastModifiedDate': datetime(2015, 1, 1),
            'creationDate': datetime(2015, 1, 1),
            'cloneUrlHttp': 'string',
            'cloneUrlSsh': 'string',
            'Arn': 'string'
        },
    ],
    'repositoriesNotFound': [
        'string',
    ]
}

Response Structure

(dict) --

Represents the output of a batch get repositories operation.
- repositories (list) --
  
  A list of repositories returned by the batch get repositories operation.
  - (dict) --
    
    Information about a 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 (datetime) --
      
      The date and time the repository was last modified, in timestamp format.
    - creationDate (datetime) --
      
      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.
- repositoriesNotFound (list) --
  
  Returns a list of repository names for which information could not be found.
  - (string) -- Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9), ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository name.

UpdateDefaultBranch (new)

Link ¶

Sets or changes the default branch name for the specified repository.

Note

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

Request Syntax

client.update_default_branch(
    repositoryName='string',
    defaultBranchName='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository to set or change the default branch for.

type defaultBranchName

string

param defaultBranchName

[REQUIRED]

The name of the branch to set as the default.

returns

None

GetRepository (new)

Link ¶

Gets information about a repository.

Note

Request Syntax

client.get_repository(
    repositoryName='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository to get information about.

rtype

dict

returns

Response Syntax

{
    'repositoryMetadata': {
        'accountId': 'string',
        'repositoryId': 'string',
        'repositoryName': 'string',
        'repositoryDescription': 'string',
        'defaultBranch': 'string',
        'lastModifiedDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'cloneUrlHttp': 'string',
        'cloneUrlSsh': 'string',
        'Arn': 'string'
    }
}

Response Structure

(dict) --

Represents the output of a get repository operation.
- repositoryMetadata (dict) --
  
  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 (datetime) --
    
    The date and time the repository was last modified, in timestamp format.
  - creationDate (datetime) --
    
    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.

UpdateRepositoryName (new)

Link ¶

Renames a repository.

Request Syntax

client.update_repository_name(
    oldName='string',
    newName='string'
)

type oldName: string
param oldName: [REQUIRED] Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9), ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository name.
type newName: string
param newName: [REQUIRED] Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9), ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository name.
returns: None

ListBranches (new)

Link ¶

Gets information about one or more branches in a repository.

Request Syntax

client.list_branches(
    repositoryName='string',
    nextToken='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository that contains the branches.

type nextToken

string

param nextToken

An enumeration token that allows the operation to batch the results.

rtype

dict

returns

Response Syntax

{
    'branches': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

Represents the output of a list branches operation.
- branches (list) --
  
  The list of branch names.
  - (string) --
- nextToken (string) --
  
  An enumeration token that returns the batch of the results.

GetBranch (new)

Link ¶

Retrieves information about a repository branch, including its name and the last commit ID.

Request Syntax

client.get_branch(
    repositoryName='string',
    branchName='string'
)

type repositoryName

string

param repositoryName

Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9), ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository name.

type branchName

string

param branchName

The name of the branch for which you want to retrieve information.

rtype

dict

returns

Response Syntax

{
    'branch': {
        'branchName': 'string',
        'commitId': 'string'
    }
}

Response Structure

(dict) --

Represents the output of a get branch operation.
- branch (dict) --
  
  The name of the branch.
  - branchName (string) --
    
    The name of the branch.
  - commitId (string) --
    
    The ID of the last commit made to the branch.

UpdateRepositoryDescription (new)

Link ¶

Sets or changes the comment or description for a repository.

Note

Request Syntax

client.update_repository_description(
    repositoryName='string',
    repositoryDescription='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository to set or change the comment or description for.

type repositoryDescription

string

param repositoryDescription

The new comment or description for the specified repository.

returns

None

DeleteRepository (new)

Link ¶

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.

Warning

Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

Request Syntax

client.delete_repository(
    repositoryName='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository to delete.

rtype

dict

returns

Response Syntax

{
    'repositoryId': 'string'
}

Response Structure

(dict) --

Represents the output of a delete repository operation.
- repositoryId (string) --
  
  The ID of the repository that was deleted.