Crate aws_sdk_codestar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

• DeleteProject, which deletes a project.
• DescribeProject, which lists the attributes of a project.
• ListProjects, which lists all projects associated with your AWS account.
• ListResources, which lists the resources associated with a project.
• ListTagsForProject, which lists the tags associated with a project.
• TagProject, which adds tags to a project.
• UntagProject, which removes tags from a project.
• UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

• AssociateTeamMember, which adds an IAM user to the team for a project.
• DisassociateTeamMember, which removes an IAM user from the team for a project.
• ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.
• UpdateTeamMember, which updates a team member’s attributes in a project.

Users, by calling the following:

• CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.
• DeleteUserProfile, which deletes all user profile information across all projects.
• DescribeUserProfile, which describes the profile of a user.
• ListUserProfiles, which lists all user profiles.
• UpdateUserProfile, which updates the profile for a user.

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-codestar to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-codestar = "1.21.0"
tokio = { version = "1", features = ["full"] }

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

use aws_sdk_codestar as codestar;

#[::tokio::main]
async fn main() -> Result<(), codestar::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_codestar::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

• GitHub discussions - For ideas, RFCs & general questions
• GitHub issues - For bug reports & feature requests
• Generated Docs (latest version)
• Usage examples

Crate Organization

The entry point for most customers will be Client, which exposes one method for each API offered by AWS CodeStar. 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 AWS CodeStar.
• config
  Configuration for AWS CodeStar.
• error
  Common errors and error handling utilities.
• meta
  Information about this crate.
• 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

• Client
  Client for AWS CodeStar
• Config
  Configuration for a aws_sdk_codestar service client.

Enums

• Error
  All possible error types for this service.