Skip to content

CodeCatalystClient#

Index > CodeCatalyst > CodeCatalystClient

Auto-generated documentation for CodeCatalyst type annotations stubs module mypy-boto3-codecatalyst.

CodeCatalystClient#

Type annotations and code completion for boto3.client("codecatalyst"). boto3 documentation

# CodeCatalystClient usage example

from boto3.session import Session
from mypy_boto3_codecatalyst.client import CodeCatalystClient

def get_codecatalyst_client() -> CodeCatalystClient:
    return Session().client("codecatalyst")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("codecatalyst").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("codecatalyst")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_codecatalyst.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("codecatalyst").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("codecatalyst").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_access_token#

Creates a personal access token (PAT) for the current user.

Type annotations and code completion for boto3.client("codecatalyst").create_access_token method. boto3 documentation

# create_access_token method definition

def create_access_token(
    self,
    *,
    name: str,
    expiresTime: Union[datetime, str] = ...,
) -> CreateAccessTokenResponseTypeDef:  # (1)
    ...
  1. See CreateAccessTokenResponseTypeDef
# create_access_token method usage example with argument unpacking

kwargs: CreateAccessTokenRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_access_token(**kwargs)
  1. See CreateAccessTokenRequestRequestTypeDef

create_dev_environment#

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.

Type annotations and code completion for boto3.client("codecatalyst").create_dev_environment method. boto3 documentation

# create_dev_environment method definition

def create_dev_environment(
    self,
    *,
    spaceName: str,
    projectName: str,
    instanceType: InstanceTypeType,  # (1)
    persistentStorage: PersistentStorageConfigurationTypeDef,  # (2)
    repositories: Sequence[RepositoryInputTypeDef] = ...,  # (3)
    clientToken: str = ...,
    alias: str = ...,
    ides: Sequence[IdeConfigurationTypeDef] = ...,  # (4)
    inactivityTimeoutMinutes: int = ...,
    vpcConnectionName: str = ...,
) -> CreateDevEnvironmentResponseTypeDef:  # (5)
    ...
  1. See InstanceTypeType
  2. See PersistentStorageConfigurationTypeDef
  3. See RepositoryInputTypeDef
  4. See IdeConfigurationTypeDef
  5. See CreateDevEnvironmentResponseTypeDef
# create_dev_environment method usage example with argument unpacking

kwargs: CreateDevEnvironmentRequestRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "instanceType": ...,
    "persistentStorage": ...,
}

parent.create_dev_environment(**kwargs)
  1. See CreateDevEnvironmentRequestRequestTypeDef

create_project#

Creates a project in a specified space.

Type annotations and code completion for boto3.client("codecatalyst").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    spaceName: str,
    displayName: str,
    description: str = ...,
) -> CreateProjectResponseTypeDef:  # (1)
    ...
  1. See CreateProjectResponseTypeDef
# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "spaceName": ...,
    "displayName": ...,
}

parent.create_project(**kwargs)
  1. See CreateProjectRequestRequestTypeDef

create_source_repository#

Creates an empty Git-based source repository in a specified project.

Type annotations and code completion for boto3.client("codecatalyst").create_source_repository method. boto3 documentation

# create_source_repository method definition

def create_source_repository(
    self,
    *,
    spaceName: str,
    projectName: str,
    name: str,
    description: str = ...,
) -> CreateSourceRepositoryResponseTypeDef:  # (1)
    ...
  1. See CreateSourceRepositoryResponseTypeDef
# create_source_repository method usage example with argument unpacking

kwargs: CreateSourceRepositoryRequestRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "name": ...,
}

parent.create_source_repository(**kwargs)
  1. See CreateSourceRepositoryRequestRequestTypeDef

create_source_repository_branch#

Creates a branch in a specified source repository in Amazon CodeCatalyst.

Type annotations and code completion for boto3.client("codecatalyst").create_source_repository_branch method. boto3 documentation

# create_source_repository_branch method definition

def create_source_repository_branch(
    self,
    *,
    spaceName: str,
    projectName: str,
    sourceRepositoryName: str,
    name: str,
    headCommitId: str = ...,
) -> CreateSourceRepositoryBranchResponseTypeDef:  # (1)
    ...
  1. See CreateSourceRepositoryBranchResponseTypeDef
# create_source_repository_branch method usage example with argument unpacking

kwargs: CreateSourceRepositoryBranchRequestRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "sourceRepositoryName": ...,
    "name": ...,
}

parent.create_source_repository_branch(**kwargs)
  1. See CreateSourceRepositoryBranchRequestRequestTypeDef

delete_access_token#

Deletes a specified personal access token (PAT).

Type annotations and code completion for boto3.client("codecatalyst").delete_access_token method. boto3 documentation

# delete_access_token method definition

def delete_access_token(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...
# delete_access_token method usage example with argument unpacking

kwargs: DeleteAccessTokenRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_access_token(**kwargs)
  1. See DeleteAccessTokenRequestRequestTypeDef

delete_dev_environment#

Deletes a Dev Environment.

Type annotations and code completion for boto3.client("codecatalyst").delete_dev_environment method. boto3 documentation

# delete_dev_environment method definition

def delete_dev_environment(
    self,
    *,
    spaceName: str,
    projectName: str,
    id: str,
) -> DeleteDevEnvironmentResponseTypeDef:  # (1)
    ...
  1. See DeleteDevEnvironmentResponseTypeDef
# delete_dev_environment method usage example with argument unpacking

kwargs: DeleteDevEnvironmentRequestRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "id": ...,
}

parent.delete_dev_environment(**kwargs)
  1. See DeleteDevEnvironmentRequestRequestTypeDef

delete_project#

Deletes a project in a space.

Type annotations and code completion for boto3.client("codecatalyst").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    spaceName: str,
    name: str,
) -> DeleteProjectResponseTypeDef:  # (1)
    ...
  1. See DeleteProjectResponseTypeDef
# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "spaceName": ...,
    "name": ...,
}

parent.delete_project(**kwargs)
  1. See DeleteProjectRequestRequestTypeDef

delete_source_repository#

Deletes a source repository in Amazon CodeCatalyst.

Type annotations and code completion for boto3.client("codecatalyst").delete_source_repository method.