Crate aws_sdk_codecatalyst

source ·
Expand description

Please Note: The SDK is currently in Developer Preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.

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.

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

  • CreateAccessToken, which creates a personal access token (PAT) for the current user.
  • CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
  • CreateProject which creates a project in a specified space.
  • CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
  • DeleteDevEnvironment, which deletes a Dev Environment.
  • GetDevEnvironment, which returns information about a Dev Environment.
  • GetProject, which returns information about a project.
  • GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
  • GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
  • GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
  • ListDevEnvironments, which retrives a list of Dev Environments in a project.
  • ListProjects, which retrieves a list of projects in a space.
  • ListSourceRepositories, which retrieves a list of source repositories in a project.
  • ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
  • ListSpaces, which retrieves a list of spaces.
  • 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.
  • VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

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

Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-codecatalyst to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = "0.55.1"
aws-sdk-codecatalyst = "0.4.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_codecatalyst as codecatalyst;

#[tokio::main]
async fn main() -> Result<(), codecatalyst::Error> {
    let config = aws_config::load_from_env().await;
    let client = codecatalyst::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

Crate Organization

The entry point for most customers will be Client, which exposes one method for each API offered by Amazon CodeCatalyst. The return value of each of these methods is a “fluent builder”, where the different inputs for that API are added by builder-style function call chaining, followed by calling send() to get a Future that will result in either a successful output or a SdkError.

Some of these API inputs may be structs or enums to provide more complex structured information. These structs and enums live in types. There are some simpler types for representing data such as date times or binary blobs that live in primitives.

All types required to configure a client via the Config struct live in config.

The operation module has a submodule for every API, and in each submodule is the input, output, and error type for that API, as well as builders to construct each of those.

There is a top-level Error type that encompasses all the errors that the client can return. Any other error type can be converted to this Error type via the From trait.

The other modules within this crate are not required for normal usage.

Modules

  • client
    Client for calling Amazon CodeCatalyst.
  • config
    Configuration for Amazon CodeCatalyst.
  • endpoint
    Endpoint resolution functionality.
  • error
    Common errors and error handling utilities.
  • meta
    Information about this crate.
  • middleware
    Base Middleware Stack
  • operation
    All operations that this crate can perform.
  • primitives
    Primitives such as Blob or DateTime used by other types.
  • types
    Data structures used by operation inputs/outputs.

Structs

Enums

  • Error
    All possible error types for this service.