Implementation for accessing 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.
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.
Inheritance Hierarchy
Namespace: Amazon.CodeCatalyst
Assembly: AWSSDK.CodeCatalyst.dll
Version: 3.x.y.z
Syntax
public class AmazonCodeCatalystClient : AmazonServiceClient IAmazonCodeCatalyst, IAmazonService, IDisposable
The AmazonCodeCatalystClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonCodeCatalystClient() |
Constructs AmazonCodeCatalystClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonCodeCatalystClient(RegionEndpoint) |
Constructs AmazonCodeCatalystClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonCodeCatalystClient(AmazonCodeCatalystConfig) |
Constructs AmazonCodeCatalystClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonCodeCatalystClient(AWSCredentials) |
Constructs AmazonCodeCatalystClient with AWS Credentials |
|
|
AmazonCodeCatalystClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonCodeCatalystClient with AWS Credentials |
|
|
AmazonCodeCatalystClient(AWSCredentials, AmazonCodeCatalystConfig) |
Constructs AmazonCodeCatalystClient with AWS Credentials and an AmazonCodeCatalystClient Configuration object. |
|
|
AmazonCodeCatalystClient(string, string) |
Constructs AmazonCodeCatalystClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeCatalystClient(string, string, RegionEndpoint) |
Constructs AmazonCodeCatalystClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeCatalystClient(string, string, AmazonCodeCatalystConfig) |
Constructs AmazonCodeCatalystClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCatalystClient Configuration object. |
|
|
AmazonCodeCatalystClient(string, string, string) |
Constructs AmazonCodeCatalystClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeCatalystClient(string, string, string, RegionEndpoint) |
Constructs AmazonCodeCatalystClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonCodeCatalystClient(string, string, string, AmazonCodeCatalystConfig) |
Constructs AmazonCodeCatalystClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCatalystClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
Paginators | Amazon.CodeCatalyst.Model.ICodeCatalystPaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
CreateAccessToken(CreateAccessTokenRequest) |
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. |
|
|
CreateAccessTokenAsync(CreateAccessTokenRequest, CancellationToken) |
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. |
|
|
CreateDevEnvironment(CreateDevEnvironmentRequest) |
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.
When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured
to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these
defaults apply to a Dev Environment created programmatically.
|
|
|
CreateDevEnvironmentAsync(CreateDevEnvironmentRequest, CancellationToken) |
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.
When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured
to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these
defaults apply to a Dev Environment created programmatically.
|
|
|
CreateProject(CreateProjectRequest) |
Creates a project in a specified space. |
|
|
CreateProjectAsync(CreateProjectRequest, CancellationToken) |
Creates a project in a specified space. |
|
|
CreateSourceRepository(CreateSourceRepositoryRequest) |
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 |
|
|
CreateSourceRepositoryAsync(CreateSourceRepositoryRequest, CancellationToken) |
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 |
|
|
CreateSourceRepositoryBranch(CreateSourceRepositoryBranchRequest) |
Creates a branch in a specified source repository in Amazon CodeCatalyst.
This API only creates a branch in a source repository hosted in Amazon CodeCatalyst.
You cannot use this API to create a branch in a linked repository.
|
|
|
CreateSourceRepositoryBranchAsync(CreateSourceRepositoryBranchRequest, CancellationToken) |
Creates a branch in a specified source repository in Amazon CodeCatalyst.
This API only creates a branch in a source repository hosted in Amazon CodeCatalyst.
You cannot use this API to create a branch in a linked repository.
|
|
|
DeleteAccessToken(DeleteAccessTokenRequest) |
Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it. |
|
|
DeleteAccessTokenAsync(DeleteAccessTokenRequest, CancellationToken) |
Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it. |
|
|
DeleteDevEnvironment(DeleteDevEnvironmentRequest) |
Deletes a Dev Environment. |
|
|
DeleteDevEnvironmentAsync(DeleteDevEnvironmentRequest, CancellationToken) |
Deletes a Dev Environment. |
|
|
DeleteProject(DeleteProjectRequest) |
Deletes a project in a space. |
|
|
DeleteProjectAsync(DeleteProjectRequest, CancellationToken) |
Deletes a project in a space. |
|
|
DeleteSourceRepository(DeleteSourceRepositoryRequest) |
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. |
|
|
DeleteSourceRepositoryAsync(DeleteSourceRepositoryRequest, CancellationToken) |
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. |
|
|
DeleteSpace(DeleteSpaceRequest) |
Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique
across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
|
|
|
DeleteSpaceAsync(DeleteSpaceRequest, CancellationToken) |
Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique
across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
|
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetDevEnvironment(GetDevEnvironmentRequest) |
Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them. |
|
|
GetDevEnvironmentAsync(GetDevEnvironmentRequest, CancellationToken) |
Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them. |
|
|
GetProject(GetProjectRequest) |
Returns information about a project. |
|
|
GetProjectAsync(GetProjectRequest, CancellationToken) |
Returns information about a project. |
|
|
GetSourceRepository(GetSourceRepositoryRequest) |
Returns information about a source repository. |
|
|
GetSourceRepositoryAsync(GetSourceRepositoryRequest, CancellationToken) |
Returns information about a source repository. |
|
|
GetSourceRepositoryCloneUrls(GetSourceRepositoryCloneUrlsRequest) |
Returns information about the URLs that can be used with a Git client to clone a source repository. |
|
|
GetSourceRepositoryCloneUrlsAsync(GetSourceRepositoryCloneUrlsRequest, CancellationToken) |
Returns information about the URLs that can be used with a Git client to clone a source repository. |
|
|
GetSpace(GetSpaceRequest) |
Returns information about an space. |
|
|
GetSpaceAsync(GetSpaceRequest, CancellationToken) |
Returns information about an space. |
|
|
GetSubscription(GetSubscriptionRequest) |
Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space. |
|
|
GetSubscriptionAsync(GetSubscriptionRequest, CancellationToken) |
Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space. |
|
|
GetUserDetails(GetUserDetailsRequest) |
Returns information about a user. |
|
|
GetUserDetailsAsync(GetUserDetailsRequest, CancellationToken) |
Returns information about a user. |
|
|
GetWorkflow(GetWorkflowRequest) |
Returns information about a workflow. |
|
|
GetWorkflowAsync(GetWorkflowRequest, CancellationToken) |
Returns information about a workflow. |
|
|
GetWorkflowRun(GetWorkflowRunRequest) |
Returns information about a specified run of a workflow. |
|
|
GetWorkflowRunAsync(GetWorkflowRunRequest, CancellationToken) |
Returns information about a specified run of a workflow. |
|
|
ListAccessTokens(ListAccessTokensRequest) |
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. |
|
|
ListAccessTokensAsync(ListAccessTokensRequest, CancellationToken) |
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. |
|
|
ListDevEnvironments(ListDevEnvironmentsRequest) |
Retrieves a list of Dev Environments in a project. |
|
|
ListDevEnvironmentsAsync(ListDevEnvironmentsRequest, CancellationToken) |
Retrieves a list of Dev Environments in a project. |
|
|
ListDevEnvironmentSessions(ListDevEnvironmentSessionsRequest) |
Retrieves a list of active sessions for a Dev Environment in a project. |
|
|
ListDevEnvironmentSessionsAsync(ListDevEnvironmentSessionsRequest, CancellationToken) |
Retrieves a list of active sessions for a Dev Environment in a project. |
|
|
ListEventLogs(ListEventLogsRequest) |
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.
ListEventLogs guarantees events for the last 30 days in a given space. You can also
view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst
in the CloudTrail console by viewing Event history, or by creating a trail to create
and maintain a record of events that extends past 90 days. For more information, see
Working
with CloudTrail Event History and Working
with CloudTrail trails.
|
|
|
ListEventLogsAsync(ListEventLogsRequest, CancellationToken) |
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.
ListEventLogs guarantees events for the last 30 days in a given space. You can also
view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst
in the CloudTrail console by viewing Event history, or by creating a trail to create
and maintain a record of events that extends past 90 days. For more information, see
Working
with CloudTrail Event History and Working
with CloudTrail trails.
|
|
|
ListProjects(ListProjectsRequest) |
Retrieves a list of projects. |
|
|
ListProjectsAsync(ListProjectsRequest, CancellationToken) |
Retrieves a list of projects. |
|
|
ListSourceRepositories(ListSourceRepositoriesRequest) |
Retrieves a list of source repositories in a project. |
|
|
ListSourceRepositoriesAsync(ListSourceRepositoriesRequest, CancellationToken) |
Retrieves a list of source repositories in a project. |
|
|
ListSourceRepositoryBranches(ListSourceRepositoryBranchesRequest) |
Retrieves a list of branches in a specified source repository. |
|
|
ListSourceRepositoryBranchesAsync(ListSourceRepositoryBranchesRequest, CancellationToken) |
Retrieves a list of branches in a specified source repository. |
|
|
ListSpaces(ListSpacesRequest) |
Retrieves a list of spaces. |
|
|
ListSpacesAsync(ListSpacesRequest, CancellationToken) |
Retrieves a list of spaces. |
|
|
ListWorkflowRuns(ListWorkflowRunsRequest) |
Retrieves a list of workflow runs of a specified workflow. |
|
|
ListWorkflowRunsAsync(ListWorkflowRunsRequest, CancellationToken) |
Retrieves a list of workflow runs of a specified workflow. |
|
|
ListWorkflows(ListWorkflowsRequest) |
Retrieves a list of workflows in a specified project. |
|
|
ListWorkflowsAsync(ListWorkflowsRequest, CancellationToken) |
Retrieves a list of workflows in a specified project. |
|
|
StartDevEnvironment(StartDevEnvironmentRequest) |
Starts a specified Dev Environment and puts it into an active state. |
|
|
StartDevEnvironmentAsync(StartDevEnvironmentRequest, CancellationToken) |
Starts a specified Dev Environment and puts it into an active state. |
|
|
StartDevEnvironmentSession(StartDevEnvironmentSessionRequest) |
Starts a session for a specified Dev Environment. |
|
|
StartDevEnvironmentSessionAsync(StartDevEnvironmentSessionRequest, CancellationToken) |
Starts a session for a specified Dev Environment. |
|
|
StartWorkflowRun(StartWorkflowRunRequest) |
Begins a run of a specified workflow. |
|
|
StartWorkflowRunAsync(StartWorkflowRunRequest, CancellationToken) |
Begins a run of a specified workflow. |
|
|
StopDevEnvironment(StopDevEnvironmentRequest) |
Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes. |
|
|
StopDevEnvironmentAsync(StopDevEnvironmentRequest, CancellationToken) |
Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes. |
|
|
StopDevEnvironmentSession(StopDevEnvironmentSessionRequest) |
Stops a session for a specified Dev Environment. |
|
|
StopDevEnvironmentSessionAsync(StopDevEnvironmentSessionRequest, CancellationToken) |
Stops a session for a specified Dev Environment. |
|
|
UpdateDevEnvironment(UpdateDevEnvironmentRequest) |
Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart. |
|
|
UpdateDevEnvironmentAsync(UpdateDevEnvironmentRequest, CancellationToken) |
Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart. |
|
|
UpdateProject(UpdateProjectRequest) |
Changes one or more values for a project. |
|
|
UpdateProjectAsync(UpdateProjectRequest, CancellationToken) |
Changes one or more values for a project. |
|
|
UpdateSpace(UpdateSpaceRequest) |
Changes one or more values for a space. |
|
|
UpdateSpaceAsync(UpdateSpaceRequest, CancellationToken) |
Changes one or more values for a space. |
|
|
VerifySession(VerifySessionRequest) |
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. |
|
|
VerifySessionAsync(VerifySessionRequest, CancellationToken) |
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. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5