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)
...
# create_access_token method usage example with argument unpacking
kwargs: CreateAccessTokenRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_access_token(**kwargs)
create_dev_environment
Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev 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 = ...,
) -> CreateDevEnvironmentResponseTypeDef: # (5)
...
- See InstanceTypeType
- See PersistentStorageConfigurationTypeDef
- See RepositoryInputTypeDef
- See IdeConfigurationTypeDef
- See CreateDevEnvironmentResponseTypeDef
# create_dev_environment method usage example with argument unpacking
kwargs: CreateDevEnvironmentRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"instanceType": ...,
"persistentStorage": ...,
}
parent.create_dev_environment(**kwargs)
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)
...
# create_project method usage example with argument unpacking
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"spaceName": ...,
"displayName": ...,
}
parent.create_project(**kwargs)
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)
...
# create_source_repository_branch method usage example with argument unpacking
kwargs: CreateSourceRepositoryBranchRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"sourceRepositoryName": ...,
"name": ...,
}
parent.create_source_repository_branch(**kwargs)
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)
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)
...
# delete_dev_environment method usage example with argument unpacking
kwargs: DeleteDevEnvironmentRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
}
parent.delete_dev_environment(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
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:
...
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)
...
# get_dev_environment method usage example with argument unpacking
kwargs: GetDevEnvironmentRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
}
parent.get_dev_environment(**kwargs)
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)
...
# get_project method usage example with argument unpacking
kwargs: GetProjectRequestRequestTypeDef = { # (1)
"spaceName": ...,
"name": ...,
}
parent.get_project(**kwargs)
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)
...
# get_source_repository_clone_urls method usage example with argument unpacking
kwargs: GetSourceRepositoryCloneUrlsRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"sourceRepositoryName": ...,
}
parent.get_source_repository_clone_urls(**kwargs)
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)
...
# get_space method usage example with argument unpacking
kwargs: GetSpaceRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_space(**kwargs)
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)
...
# get_subscription method usage example with argument unpacking
kwargs: GetSubscriptionRequestRequestTypeDef = { # (1)
"spaceName": ...,
}
parent.get_subscription(**kwargs)
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)
...
# get_user_details method usage example with argument unpacking
kwargs: GetUserDetailsRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_user_details(**kwargs)
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)
...
# list_access_tokens method usage example with argument unpacking
kwargs: ListAccessTokensRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_access_tokens(**kwargs)
list_dev_environments
Retrives 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)
...
# list_dev_environments method usage example with argument unpacking
kwargs: ListDevEnvironmentsRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
}
parent.list_dev_environments(**kwargs)
list_event_logs
Retrieves a list of events that occurred during a specified time period 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: Union[datetime, str],
endTime: Union[datetime, str],
eventName: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEventLogsResponseTypeDef: # (1)
...
# list_event_logs method usage example with argument unpacking
kwargs: ListEventLogsRequestRequestTypeDef = { # (1)
"spaceName": ...,
"startTime": ...,
"endTime": ...,
}
parent.list_event_logs(**kwargs)
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)
...
# list_projects method usage example with argument unpacking
kwargs: ListProjectsRequestRequestTypeDef = { # (1)
"spaceName": ...,
}
parent.list_projects(**kwargs)
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)
...
# list_source_repositories method usage example with argument unpacking
kwargs: ListSourceRepositoriesRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
}
parent.list_source_repositories(**kwargs)
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)
...
# list_source_repository_branches method usage example with argument unpacking
kwargs: ListSourceRepositoryBranchesRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"sourceRepositoryName": ...,
}
parent.list_source_repository_branches(**kwargs)
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)
...
# list_spaces method usage example with argument unpacking
kwargs: ListSpacesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_spaces(**kwargs)
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)
...
# start_dev_environment method usage example with argument unpacking
kwargs: StartDevEnvironmentRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
}
parent.start_dev_environment(**kwargs)
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)
...
# start_dev_environment_session method usage example with argument unpacking
kwargs: StartDevEnvironmentSessionRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
"sessionConfiguration": ...,
}
parent.start_dev_environment_session(**kwargs)
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)
...
# stop_dev_environment method usage example with argument unpacking
kwargs: StopDevEnvironmentRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
}
parent.stop_dev_environment(**kwargs)
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)
...
# stop_dev_environment_session method usage example with argument unpacking
kwargs: StopDevEnvironmentSessionRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
"sessionId": ...,
}
parent.stop_dev_environment_session(**kwargs)
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)
...
# update_dev_environment method usage example with argument unpacking
kwargs: UpdateDevEnvironmentRequestRequestTypeDef = { # (1)
"spaceName": ...,
"projectName": ...,
"id": ...,
}
parent.update_dev_environment(**kwargs)
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)
...
get_paginator
Type annotations and code completion for boto3.client("codecatalyst").get_paginator
method with overloads.
client.get_paginator("list_access_tokens")
-> ListAccessTokensPaginatorclient.get_paginator("list_dev_environments")
-> ListDevEnvironmentsPaginatorclient.get_paginator("list_event_logs")
-> ListEventLogsPaginatorclient.get_paginator("list_projects")
-> ListProjectsPaginatorclient.get_paginator("list_source_repositories")
-> ListSourceRepositoriesPaginatorclient.get_paginator("list_source_repository_branches")
-> ListSourceRepositoryBranchesPaginatorclient.get_paginator("list_spaces")
-> ListSpacesPaginator