Amazon CodeCatalyst

2023/07/20 - Amazon CodeCatalyst - 7 new api methods

Changes  This release adds support for updating and deleting spaces and projects in Amazon CodeCatalyst. It also adds support for creating, getting, and deleting source repositories in CodeCatalyst projects.

UpdateProject (new) Link ¶

Changes one or more values for a project.

See also: AWS API Documentation

Request Syntax

client.update_project(
    spaceName='string',
    name='string',
    description='string'
)
type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type name

string

param name

[REQUIRED]

The name of the project.

type description

string

param description

The description of the project.

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'name': 'string',
    'displayName': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • name (string) --

      The name of the project.

    • displayName (string) --

      The friendly name of the project displayed to users in Amazon CodeCatalyst.

    • description (string) --

      The description of the project.

DeleteSpace (new) Link ¶

Deletes a space.

Warning

Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

See also: AWS API Documentation

Request Syntax

client.delete_space(
    name='string'
)
type name

string

param name

[REQUIRED]

The name of the space. To retrieve a list of space names, use ListSpaces .

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'displayName': 'string'
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the space.

    • displayName (string) --

      The friendly name of the space displayed to users of the space in Amazon CodeCatalyst.

GetSourceRepository (new) Link ¶

Returns information about a source repository.

See also: AWS API Documentation

Request Syntax

client.get_source_repository(
    spaceName='string',
    projectName='string',
    name='string'
)
type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type projectName

string

param projectName

[REQUIRED]

The name of the project in the space.

type name

string

param name

[REQUIRED]

The name of the source repository.

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'name': 'string',
    'description': 'string',
    'lastUpdatedTime': datetime(2015, 1, 1),
    'createdTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • name (string) --

      The name of the source repository.

    • description (string) --

      The description of the source repository.

    • lastUpdatedTime (datetime) --

      The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 .

    • createdTime (datetime) --

      The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 .

CreateSourceRepository (new) Link ¶

Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main .

See also: AWS API Documentation

Request Syntax

client.create_source_repository(
    spaceName='string',
    projectName='string',
    name='string',
    description='string'
)
type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type projectName

string

param projectName

[REQUIRED]

The name of the project in the space.

type name

string

param name

[REQUIRED]

The name of the source repository. For more information about name requirements, see Quotas for source repositories .

type description

string

param description

The description of the source repository.

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'name': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • name (string) --

      The name of the source repository.

    • description (string) --

      The description of the source repository.

UpdateSpace (new) Link ¶

Changes one or more values for a space.

See also: AWS API Documentation

Request Syntax

client.update_space(
    name='string',
    description='string'
)
type name

string

param name

[REQUIRED]

The name of the space.

type description

string

param description

The description of the space.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'displayName': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the space.

    • displayName (string) --

      The friendly name of the space displayed to users in Amazon CodeCatalyst.

    • description (string) --

      The description of the space.

DeleteSourceRepository (new) Link ¶

Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.

See also: AWS API Documentation

Request Syntax

client.delete_source_repository(
    spaceName='string',
    projectName='string',
    name='string'
)
type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type projectName

string

param projectName

[REQUIRED]

The name of the project in the space.

type name

string

param name

[REQUIRED]

The name of the source repository.

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'name': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • name (string) --

      The name of the repository.

DeleteProject (new) Link ¶

Deletes a project in a space.

See also: AWS API Documentation

Request Syntax

client.delete_project(
    spaceName='string',
    name='string'
)
type spaceName

string

param spaceName

[REQUIRED]

The name of the space.

type name

string

param name

[REQUIRED]

The name of the project in the space. To retrieve a list of project names, use ListProjects .

rtype

dict

returns

Response Syntax

{
    'spaceName': 'string',
    'name': 'string',
    'displayName': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • name (string) --

      The name of the project in the space.

    • displayName (string) --

      The friendly name displayed to users of the project in Amazon CodeCatalyst.