CodeCatalyst#
Client#
- class CodeCatalyst.Client#
A low-level client representing Amazon CodeCatalyst
Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects.
Spaces, by calling the following:
DeleteSpace, which deletes a space.
GetSpace, which returns information about a space.
GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
ListSpaces, which retrieves a list of spaces.
UpdateSpace, which changes one or more values for a space.
Projects, by calling the following:
CreateProject which creates a project in a specified space.
GetProject, which returns information about a project.
ListProjects, which retrieves a list of projects in a space.
Users, by calling the following:
GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
Source repositories, by calling the following:
CreateSourceRepository, which creates an empty Git-based source repository in a specified project.
CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
DeleteSourceRepository, which deletes a source repository.
GetSourceRepository, which returns information about a source repository.
GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
ListSourceRepositories, which retrieves a list of source repositories in a project.
ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
Dev Environments and the Amazon Web Services Toolkits, by calling the following:
CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
DeleteDevEnvironment, which deletes a Dev Environment.
GetDevEnvironment, which returns information about a Dev Environment.
ListDevEnvironments, which retrieves a list of Dev Environments in a project.
ListDevEnvironmentSessions, which retrieves a list of active Dev Environment sessions in a project.
StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
UpdateDevEnvironment, which changes one or more values for a Dev Environment.
Workflows, by calling the following:
GetWorkflow, which returns information about a workflow.
GetWorkflowRun, which returns information about a specified run of a workflow.
ListWorkflowRuns, which retrieves a list of runs of a specified workflow.
ListWorkflows, which retrieves a list of workflows in a specified project.
StartWorkflowRun, which starts a run of a specified workflow.
Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:
CreateAccessToken, which creates a personal access token (PAT) for the current user.
DeleteAccessToken, which deletes a specified personal access token (PAT).
ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.
Note
If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO). For more information, see Setting up to use the CLI with Amazon CodeCatalyst and the SSO documentation for your SDK.
client = session.create_client('codecatalyst')
These are the available methods:
- can_paginate
- close
- create_access_token
- create_dev_environment
- create_project
- create_source_repository
- create_source_repository_branch
- delete_access_token
- delete_dev_environment
- delete_project
- delete_source_repository
- delete_space
- get_dev_environment
- get_paginator
- get_project
- get_source_repository
- get_source_repository_clone_urls
- get_space
- get_subscription
- get_user_details
- get_waiter
- get_workflow
- get_workflow_run
- list_access_tokens
- list_dev_environment_sessions
- list_dev_environments
- list_event_logs
- list_projects
- list_source_repositories
- list_source_repository_branches
- list_spaces
- list_workflow_runs
- list_workflows
- start_dev_environment
- start_dev_environment_session
- start_workflow_run
- stop_dev_environment
- stop_dev_environment_session
- update_dev_environment
- update_project
- update_space
- verify_session
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: