aws-sdk-opsworks

Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for OpsWorks Stacks actions and data types, including common parameters and error codes.

OpsWorks Stacks is an application management service that provides an integrated experience for managing the complete application lifecycle. For information about OpsWorks, see the OpsWorks information page.

SDKs and CLI

Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:

• CLI
• SDK for Java
• SDK for .NET
• SDK for PHP
• SDK for Ruby
• Amazon Web Services SDK for Node.js
• SDK for Python (Boto)

Endpoints

OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

• opsworks.us-east-1.amazonaws.com
• opsworks.us-east-2.amazonaws.com
• opsworks.us-west-1.amazonaws.com
• opsworks.us-west-2.amazonaws.com
• opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)
• opsworks.eu-west-1.amazonaws.com
• opsworks.eu-west-2.amazonaws.com
• opsworks.eu-west-3.amazonaws.com
• opsworks.eu-central-1.amazonaws.com
• opsworks.ap-northeast-1.amazonaws.com
• opsworks.ap-northeast-2.amazonaws.com
• opsworks.ap-south-1.amazonaws.com
• opsworks.ap-southeast-1.amazonaws.com
• opsworks.ap-southeast-2.amazonaws.com
• opsworks.sa-east-1.amazonaws.com

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

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

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

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

use aws_sdk_opsworks as opsworks;

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

License

This project is licensed under the Apache-2.0 License.