codecatalyst/aws.sdk.kotlin.services.codecatalyst

Package-level declarations

Types

Link copied to clipboard
interface CodeCatalystClient : SdkClient

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun CodeCatalystClient.createAccessToken(crossinline block: CreateAccessTokenRequest.Builder.() -> Unit): CreateAccessTokenResponse

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.

Link copied to clipboard
inline suspend fun CodeCatalystClient.createDevEnvironment(crossinline block: CreateDevEnvironmentRequest.Builder.() -> Unit): CreateDevEnvironmentResponse

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.

Link copied to clipboard
inline suspend fun CodeCatalystClient.createProject(crossinline block: CreateProjectRequest.Builder.() -> Unit): CreateProjectResponse

Creates a project in a specified space.

Link copied to clipboard
inline suspend fun CodeCatalystClient.createSourceRepository(crossinline block: CreateSourceRepositoryRequest.Builder.() -> Unit): CreateSourceRepositoryResponse

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.

Link copied to clipboard
inline suspend fun CodeCatalystClient.createSourceRepositoryBranch(crossinline block: CreateSourceRepositoryBranchRequest.Builder.() -> Unit): CreateSourceRepositoryBranchResponse

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

Link copied to clipboard
inline suspend fun CodeCatalystClient.deleteAccessToken(crossinline block: DeleteAccessTokenRequest.Builder.() -> Unit): DeleteAccessTokenResponse

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

Link copied to clipboard
inline suspend fun CodeCatalystClient.deleteDevEnvironment(crossinline block: DeleteDevEnvironmentRequest.Builder.() -> Unit): DeleteDevEnvironmentResponse

Deletes a Dev Environment.

Link copied to clipboard
inline suspend fun CodeCatalystClient.deleteProject(crossinline block: DeleteProjectRequest.Builder.() -> Unit): DeleteProjectResponse

Deletes a project in a space.

Link copied to clipboard
inline suspend fun CodeCatalystClient.deleteSourceRepository(crossinline block: DeleteSourceRepositoryRequest.Builder.() -> Unit): DeleteSourceRepositoryResponse

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.

Link copied to clipboard
inline suspend fun CodeCatalystClient.deleteSpace(crossinline block: DeleteSpaceRequest.Builder.() -> Unit): DeleteSpaceResponse

Deletes a space.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getDevEnvironment(crossinline block: GetDevEnvironmentRequest.Builder.() -> Unit): GetDevEnvironmentResponse

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getProject(crossinline block: GetProjectRequest.Builder.() -> Unit): GetProjectResponse

Returns information about a project.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getSourceRepository(crossinline block: GetSourceRepositoryRequest.Builder.() -> Unit): GetSourceRepositoryResponse

Returns information about a source repository.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getSourceRepositoryCloneUrls(crossinline block: GetSourceRepositoryCloneUrlsRequest.Builder.() -> Unit): GetSourceRepositoryCloneUrlsResponse

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

Link copied to clipboard
inline suspend fun CodeCatalystClient.getSpace(crossinline block: GetSpaceRequest.Builder.() -> Unit): GetSpaceResponse

Returns information about an space.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getSubscription(crossinline block: GetSubscriptionRequest.Builder.() -> Unit): GetSubscriptionResponse

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

Link copied to clipboard
inline suspend fun CodeCatalystClient.getUserDetails(crossinline block: GetUserDetailsRequest.Builder.() -> Unit): GetUserDetailsResponse

Returns information about a user.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getWorkflow(crossinline block: GetWorkflowRequest.Builder.() -> Unit): GetWorkflowResponse

Returns information about a workflow.

Link copied to clipboard
inline suspend fun CodeCatalystClient.getWorkflowRun(crossinline block: GetWorkflowRunRequest.Builder.() -> Unit): GetWorkflowRunResponse

Returns information about a specified run of a workflow.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listAccessTokens(crossinline block: ListAccessTokensRequest.Builder.() -> Unit): ListAccessTokensResponse

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listDevEnvironments(crossinline block: ListDevEnvironmentsRequest.Builder.() -> Unit): ListDevEnvironmentsResponse

Retrieves a list of Dev Environments in a project.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listDevEnvironmentSessions(crossinline block: ListDevEnvironmentSessionsRequest.Builder.() -> Unit): ListDevEnvironmentSessionsResponse

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

Link copied to clipboard
inline suspend fun CodeCatalystClient.listEventLogs(crossinline block: ListEventLogsRequest.Builder.() -> Unit): ListEventLogsResponse

Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listProjects(crossinline block: ListProjectsRequest.Builder.() -> Unit): ListProjectsResponse

Retrieves a list of projects.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listSourceRepositories(crossinline block: ListSourceRepositoriesRequest.Builder.() -> Unit): ListSourceRepositoriesResponse

Retrieves a list of source repositories in a project.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listSourceRepositoryBranches(crossinline block: ListSourceRepositoryBranchesRequest.Builder.() -> Unit): ListSourceRepositoryBranchesResponse

Retrieves a list of branches in a specified source repository.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listSpaces(crossinline block: ListSpacesRequest.Builder.() -> Unit): ListSpacesResponse

Retrieves a list of spaces.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listWorkflowRuns(crossinline block: ListWorkflowRunsRequest.Builder.() -> Unit): ListWorkflowRunsResponse

Retrieves a list of workflow runs of a specified workflow.

Link copied to clipboard
inline suspend fun CodeCatalystClient.listWorkflows(crossinline block: ListWorkflowsRequest.Builder.() -> Unit): ListWorkflowsResponse

Retrieves a list of workflows in a specified project.

Link copied to clipboard
inline suspend fun CodeCatalystClient.startDevEnvironment(crossinline block: StartDevEnvironmentRequest.Builder.() -> Unit): StartDevEnvironmentResponse

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

Link copied to clipboard
inline suspend fun CodeCatalystClient.startDevEnvironmentSession(crossinline block: StartDevEnvironmentSessionRequest.Builder.() -> Unit): StartDevEnvironmentSessionResponse

Starts a session for a specified Dev Environment.

Link copied to clipboard
inline suspend fun CodeCatalystClient.startWorkflowRun(crossinline block: StartWorkflowRunRequest.Builder.() -> Unit): StartWorkflowRunResponse

Begins a run of a specified workflow.

Link copied to clipboard
inline suspend fun CodeCatalystClient.stopDevEnvironment(crossinline block: StopDevEnvironmentRequest.Builder.() -> Unit): StopDevEnvironmentResponse

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

Link copied to clipboard
inline suspend fun CodeCatalystClient.stopDevEnvironmentSession(crossinline block: StopDevEnvironmentSessionRequest.Builder.() -> Unit): StopDevEnvironmentSessionResponse

Stops a session for a specified Dev Environment.

Link copied to clipboard
inline suspend fun CodeCatalystClient.updateDevEnvironment(crossinline block: UpdateDevEnvironmentRequest.Builder.() -> Unit): UpdateDevEnvironmentResponse

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

Link copied to clipboard
inline suspend fun CodeCatalystClient.updateProject(crossinline block: UpdateProjectRequest.Builder.() -> Unit): UpdateProjectResponse

Changes one or more values for a project.

Link copied to clipboard
inline suspend fun CodeCatalystClient.updateSpace(crossinline block: UpdateSpaceRequest.Builder.() -> Unit): UpdateSpaceResponse

Changes one or more values for a space.

Link copied to clipboard
inline suspend fun CodeCatalystClient.verifySession(crossinline block: VerifySessionRequest.Builder.() -> Unit): VerifySessionResponse

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

Link copied to clipboard
fun CodeCatalystClient.withConfig(block: CodeCatalystClient.Config.Builder.() -> Unit): CodeCatalystClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.