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#

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:
    ...

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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: TimestampTypeDef = ...,
) -> CreateAccessTokenResponseTypeDef:  # (1)
    ...
  1. See CreateAccessTokenResponseTypeDef
# create_access_token method usage example with argument unpacking

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

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

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 Sequence[RepositoryInputTypeDef]
  4. See Sequence[IdeConfigurationTypeDef]
  5. See CreateDevEnvironmentResponseTypeDef
# create_dev_environment method usage example with argument unpacking

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

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

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: CreateProjectRequestTypeDef = {  # (1)
    "spaceName": ...,
    "displayName": ...,
}

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

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: CreateSourceRepositoryRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "name": ...,
}

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

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: CreateSourceRepositoryBranchRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "sourceRepositoryName": ...,
    "name": ...,
}

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

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: DeleteAccessTokenRequestTypeDef = {  # (1)
    "id": ...,
}

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

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: DeleteDevEnvironmentRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "id": ...,
}

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

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: DeleteProjectRequestTypeDef = {  # (1)
    "spaceName": ...,
    "name": ...,
}

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

delete_source_repository#

Deletes a source repository in Amazon CodeCatalyst.

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

# delete_source_repository method definition

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

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

parent.delete_source_repository(**kwargs)
  1. See DeleteSourceRepositoryRequestTypeDef

delete_space#

Deletes a space.

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

# delete_space method definition

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

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

parent.delete_space(**kwargs)
  1. See DeleteSpaceRequestTypeDef

get_dev_environment#

Returns information about a Dev Environment for a source repository in a project.

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

# get_dev_environment method definition

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

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

parent.get_dev_environment(**kwargs)
  1. See GetDevEnvironmentRequestTypeDef

get_project#

Returns information about a project.

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

# get_project method definition

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

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

parent.get_project(**kwargs)
  1. See GetProjectRequestTypeDef

get_source_repository#

Returns information about a source repository.

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

# get_source_repository method definition

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

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

parent.get_source_repository(**kwargs)
  1. See GetSourceRepositoryRequestTypeDef

get_source_repository_clone_urls#

Returns information about the URLs that can be used with a Git client to clone a source repository.

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

# get_source_repository_clone_urls method definition

def get_source_repository_clone_urls(
    self,
    *,
    spaceName: str,
    projectName: str,
    sourceRepositoryName: str,
) -> GetSourceRepositoryCloneUrlsResponseTypeDef:  # (1)
    ...
  1. See GetSourceRepositoryCloneUrlsResponseTypeDef
# get_source_repository_clone_urls method usage example with argument unpacking

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

parent.get_source_repository_clone_urls(**kwargs)
  1. See GetSourceRepositoryCloneUrlsRequestTypeDef

get_space#

Returns information about an space.

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

# get_space method definition

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

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

parent.get_space(**kwargs)
  1. See GetSpaceRequestTypeDef

get_subscription#

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

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

# get_subscription method definition

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

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

parent.get_subscription(**kwargs)
  1. See GetSubscriptionRequestTypeDef

get_user_details#

Returns information about a user.

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

# get_user_details method definition

def get_user_details(
    self,
    *,
    id: str = ...,
    userName: str = ...,
) -> GetUserDetailsResponseTypeDef:  # (1)
    ...
  1. See GetUserDetailsResponseTypeDef
# get_user_details method usage example with argument unpacking

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

parent.get_user_details(**kwargs)
  1. See GetUserDetailsRequestTypeDef

get_workflow#

Returns information about a workflow.

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

# get_workflow method definition

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

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

parent.get_workflow(**kwargs)
  1. See GetWorkflowRequestTypeDef

get_workflow_run#

Returns information about a specified run of a workflow.

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

# get_workflow_run method definition

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

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

parent.get_workflow_run(**kwargs)
  1. See GetWorkflowRunRequestTypeDef

list_access_tokens#

Lists all personal access tokens (PATs) associated with the user who calls the API.

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

# list_access_tokens method definition

def list_access_tokens(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAccessTokensResponseTypeDef:  # (1)
    ...
  1. See ListAccessTokensResponseTypeDef
# list_access_tokens method usage example with argument unpacking

kwargs: ListAccessTokensRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_access_tokens(**kwargs)
  1. See ListAccessTokensRequestTypeDef

list_dev_environment_sessions#

Retrieves a list of active sessions for a Dev Environment in a project.

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

# list_dev_environment_sessions method definition

def list_dev_environment_sessions(
    self,
    *,
    spaceName: str,
    projectName: str,
    devEnvironmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDevEnvironmentSessionsResponseTypeDef:  # (1)
    ...
  1. See ListDevEnvironmentSessionsResponseTypeDef
# list_dev_environment_sessions method usage example with argument unpacking

kwargs: ListDevEnvironmentSessionsRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "devEnvironmentId": ...,
}

parent.list_dev_environment_sessions(**kwargs)
  1. See ListDevEnvironmentSessionsRequestTypeDef

list_dev_environments#

Retrieves a list of Dev Environments in a project.

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

# list_dev_environments method definition

def list_dev_environments(
    self,
    *,
    spaceName: str,
    projectName: str = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDevEnvironmentsResponseTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See ListDevEnvironmentsResponseTypeDef
# list_dev_environments method usage example with argument unpacking

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

parent.list_dev_environments(**kwargs)
  1. See ListDevEnvironmentsRequestTypeDef

list_event_logs#

Retrieves a list of events that occurred during a specific time in a space.

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

# list_event_logs method definition

def list_event_logs(
    self,
    *,
    spaceName: str,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    eventName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEventLogsResponseTypeDef:  # (1)
    ...
  1. See ListEventLogsResponseTypeDef
# list_event_logs method usage example with argument unpacking

kwargs: ListEventLogsRequestTypeDef = {  # (1)
    "spaceName": ...,
    "startTime": ...,
    "endTime": ...,
}

parent.list_event_logs(**kwargs)
  1. See ListEventLogsRequestTypeDef

list_projects#

Retrieves a list of projects.

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

# list_projects method definition

def list_projects(
    self,
    *,
    spaceName: str,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[ProjectListFilterTypeDef] = ...,  # (1)
) -> ListProjectsResponseTypeDef:  # (2)
    ...
  1. See Sequence[ProjectListFilterTypeDef]
  2. See ListProjectsResponseTypeDef
# list_projects method usage example with argument unpacking

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

parent.list_projects(**kwargs)
  1. See ListProjectsRequestTypeDef

list_source_repositories#

Retrieves a list of source repositories in a project.

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

# list_source_repositories method definition

def list_source_repositories(
    self,
    *,
    spaceName: str,
    projectName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSourceRepositoriesResponseTypeDef:  # (1)
    ...
  1. See ListSourceRepositoriesResponseTypeDef
# list_source_repositories method usage example with argument unpacking

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

parent.list_source_repositories(**kwargs)
  1. See ListSourceRepositoriesRequestTypeDef

list_source_repository_branches#

Retrieves a list of branches in a specified source repository.

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

# list_source_repository_branches method definition

def list_source_repository_branches(
    self,
    *,
    spaceName: str,
    projectName: str,
    sourceRepositoryName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSourceRepositoryBranchesResponseTypeDef:  # (1)
    ...
  1. See ListSourceRepositoryBranchesResponseTypeDef
# list_source_repository_branches method usage example with argument unpacking

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

parent.list_source_repository_branches(**kwargs)
  1. See ListSourceRepositoryBranchesRequestTypeDef

list_spaces#

Retrieves a list of spaces.

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

# list_spaces method definition

def list_spaces(
    self,
    *,
    nextToken: str = ...,
) -> ListSpacesResponseTypeDef:  # (1)
    ...
  1. See ListSpacesResponseTypeDef
# list_spaces method usage example with argument unpacking

kwargs: ListSpacesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_spaces(**kwargs)
  1. See ListSpacesRequestTypeDef

list_workflow_runs#

Retrieves a list of workflow runs of a specified workflow.

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

# list_workflow_runs method definition

def list_workflow_runs(
    self,
    *,
    spaceName: str,
    projectName: str,
    workflowId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    sortBy: Sequence[Mapping[str, Any]] = ...,
) -> ListWorkflowRunsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowRunsResponseTypeDef
# list_workflow_runs method usage example with argument unpacking

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

parent.list_workflow_runs(**kwargs)
  1. See ListWorkflowRunsRequestTypeDef

list_workflows#

Retrieves a list of workflows in a specified project.

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

# list_workflows method definition

def list_workflows(
    self,
    *,
    spaceName: str,
    projectName: str,
    nextToken: str = ...,
    maxResults: int = ...,
    sortBy: Sequence[Mapping[str, Any]] = ...,
) -> ListWorkflowsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowsResponseTypeDef
# list_workflows method usage example with argument unpacking

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

parent.list_workflows(**kwargs)
  1. See ListWorkflowsRequestTypeDef

start_dev_environment#

Starts a specified Dev Environment and puts it into an active state.

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

# start_dev_environment method definition

def start_dev_environment(
    self,
    *,
    spaceName: str,
    projectName: str,
    id: str,
    ides: Sequence[IdeConfigurationTypeDef] = ...,  # (1)
    instanceType: InstanceTypeType = ...,  # (2)
    inactivityTimeoutMinutes: int = ...,
) -> StartDevEnvironmentResponseTypeDef:  # (3)
    ...
  1. See Sequence[IdeConfigurationTypeDef]
  2. See InstanceTypeType
  3. See StartDevEnvironmentResponseTypeDef
# start_dev_environment method usage example with argument unpacking

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

parent.start_dev_environment(**kwargs)
  1. See StartDevEnvironmentRequestTypeDef

start_dev_environment_session#

Starts a session for a specified Dev Environment.

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

# start_dev_environment_session method definition

def start_dev_environment_session(
    self,
    *,
    spaceName: str,
    projectName: str,
    id: str,
    sessionConfiguration: DevEnvironmentSessionConfigurationTypeDef,  # (1)
) -> StartDevEnvironmentSessionResponseTypeDef:  # (2)
    ...
  1. See DevEnvironmentSessionConfigurationTypeDef
  2. See StartDevEnvironmentSessionResponseTypeDef
# start_dev_environment_session method usage example with argument unpacking

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

parent.start_dev_environment_session(**kwargs)
  1. See StartDevEnvironmentSessionRequestTypeDef

start_workflow_run#

Begins a run of a specified workflow.

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

# start_workflow_run method definition

def start_workflow_run(
    self,
    *,
    spaceName: str,
    projectName: str,
    workflowId: str,
    clientToken: str = ...,
) -> StartWorkflowRunResponseTypeDef:  # (1)
    ...
  1. See StartWorkflowRunResponseTypeDef
# start_workflow_run method usage example with argument unpacking

kwargs: StartWorkflowRunRequestTypeDef = {  # (1)
    "spaceName": ...,
    "projectName": ...,
    "workflowId": ...,
}

parent.start_workflow_run(**kwargs)
  1. See StartWorkflowRunRequestTypeDef

stop_dev_environment#

Pauses a specified Dev Environment and places it in a non-running state.

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

# stop_dev_environment method definition

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

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

parent.stop_dev_environment(**kwargs)
  1. See StopDevEnvironmentRequestTypeDef

stop_dev_environment_session#

Stops a session for a specified Dev Environment.

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

# stop_dev_environment_session method definition

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

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

parent.stop_dev_environment_session(**kwargs)
  1. See StopDevEnvironmentSessionRequestTypeDef

update_dev_environment#

Changes one or more values for a Dev Environment.

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

# update_dev_environment method definition

def update_dev_environment(
    self,
    *,
    spaceName: str,
    projectName: str,
    id: str,
    alias: str = ...,
    ides: Sequence[IdeConfigurationTypeDef] = ...,  # (1)
    instanceType: InstanceTypeType = ...,  # (2)
    inactivityTimeoutMinutes: int = ...,
    clientToken: str = ...,
) -> UpdateDevEnvironmentResponseTypeDef:  # (3)
    ...
  1. See Sequence[IdeConfigurationTypeDef]
  2. See InstanceTypeType
  3. See UpdateDevEnvironmentResponseTypeDef
# update_dev_environment method usage example with argument unpacking

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

parent.update_dev_environment(**kwargs)
  1. See UpdateDevEnvironmentRequestTypeDef

update_project#

Changes one or more values for a project.

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

# update_project method definition

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

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

parent.update_project(**kwargs)
  1. See UpdateProjectRequestTypeDef

update_space#

Changes one or more values for a space.

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

# update_space method definition

def update_space(
    self,
    *,
    name: str,
    description: str = ...,
) -> UpdateSpaceResponseTypeDef:  # (1)
    ...
  1. See UpdateSpaceResponseTypeDef
# update_space method usage example with argument unpacking

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

parent.update_space(**kwargs)
  1. See UpdateSpaceRequestTypeDef

verify_session#

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

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

# verify_session method definition

def verify_session(
    self,
) -> VerifySessionResponseTypeDef:  # (1)
    ...
  1. See VerifySessionResponseTypeDef

get_paginator#

Type annotations and code completion for boto3.client("codecatalyst").get_paginator method with overloads.