CodeArtifact / Client / update_repository

update_repository#

CodeArtifact.Client.update_repository(**kwargs)#

Update the properties of a repository.

Request Syntax

response = client.update_repository(
    domain='string',
    domainOwner='string',
    repository='string',
    description='string',
    upstreams=[
        {
            'repositoryName': 'string'
        },
    ]
)

Parameters:

domain (string) –
[REQUIRED]

The name of the domain associated with the repository to update.
domainOwner (string) – The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository (string) –
[REQUIRED]

The name of the repository to update.
description (string) – An updated repository description.
upstreams (list) –
A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
- (dict) –
  
  Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.
  - repositoryName (string) – [REQUIRED]
    
    The name of an upstream repository.

Return type:

dict

Returns:

Response Syntax

{
    'repository': {
        'name': 'string',
        'administratorAccount': 'string',
        'domainName': 'string',
        'domainOwner': 'string',
        'arn': 'string',
        'description': 'string',
        'upstreams': [
            {
                'repositoryName': 'string'
            },
        ],
        'externalConnections': [
            {
                'externalConnectionName': 'string',
                'packageFormat': 'npm'|'pypi'|'maven'|'nuget'|'generic',
                'status': 'Available'
            },
        ],
        'createdTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- repository (dict) –
  
  The updated repository.
  - name (string) –
    
    The name of the repository.
  - administratorAccount (string) –
    
    The 12-digit account number of the Amazon Web Services account that manages the repository.
  - domainName (string) –
    
    The name of the domain that contains the repository.
  - domainOwner (string) –
    
    The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the repository.
  - description (string) –
    
    A text description of the repository.
  - upstreams (list) –
    
    A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
    - (dict) –
      
      Information about an upstream repository.
      - repositoryName (string) –
        
        The name of an upstream repository.
  - externalConnections (list) –
    
    An array of external connections associated with the repository.
    - (dict) –
      
      Contains information about the external connection of a repository.
      - externalConnectionName (string) –
        
        The name of the external connection associated with a repository.
      - packageFormat (string) –
        
        The package format associated with a repository’s external connection. The valid package formats are:
        
        npm: A Node Package Manager (npm) package.
        
        pypi: A Python Package Index (PyPI) package.
        
        maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
        
        nuget: A NuGet package.
      - status (string) –
        
        The status of the external connection of a repository. There is one valid value, Available.
  - createdTime (datetime) –
    
    A timestamp that represents the date and time the repository was created.

Exceptions

CodeArtifact.Client.exceptions.AccessDeniedException
CodeArtifact.Client.exceptions.ConflictException
CodeArtifact.Client.exceptions.InternalServerException
CodeArtifact.Client.exceptions.ResourceNotFoundException
CodeArtifact.Client.exceptions.ServiceQuotaExceededException
CodeArtifact.Client.exceptions.ThrottlingException
CodeArtifact.Client.exceptions.ValidationException