aws-sdk-health

Health API 提供访问在 Health Dashboard 中显示的健康信息。您可以使用 API 操作获取可能影响您 Amazon Web Services 和资源的有关事件的信息。

您必须拥有来自 Amazon Web Services Support 的企业、企业入门或企业支持计划才能使用 Health API。如果您从没有企业、企业入门或企业支持计划的 Amazon Web Services 账户调用 Health API，您将收到 SubscriptionRequiredException 错误。

对于 API 访问，您需要一个访问密钥 ID 和一个秘密访问密钥。尽可能使用临时凭证代替长期访问密钥。临时凭证包括访问密钥 ID、秘密访问密钥和表示凭证何时过期的安全令牌。有关更多信息，请参阅 Amazon Web Services 通用参考 中的 管理 Amazon Web Services 访问密钥的最佳实践。

您可以使用 Health 端点 health.us-east-1.amazonaws.com (HTTPS) 来调用 Health API 操作。Health 支持多区域应用程序架构，并具有两个在活动-被动配置中的区域端点。您可以使用高可用性端点示例确定哪个 Amazon Web Services 区域是活动的，以便您可以从 API 获取最新信息。有关更多信息，请参阅 Health 用户指南 中的 访问 Health API。

对于请求的认证，Health 使用 签名版本 4 签名过程。

如果您的亚马逊网络服务账户属于组织，则可以使用“组织视图”功能。此功能提供对组织内所有账户中健康事件的集中视图。您可以在实时中聚合健康事件，以识别受运营事件影响的组织内账户或接收安全漏洞通知。使用组织视图API操作来启用此功能并返回事件信息。有关更多信息，请参阅《健康用户指南》中的聚合健康事件。

入门

许多服务和操作都有示例，请查看GitHub上的示例文件夹。

SDK为每个AWS服务提供一个新的crate。您必须在Rust项目中将Tokio添加为依赖项以执行异步代码。要将aws-sdk-health添加到您的项目中，请将以下内容添加到您的Cargo.toml文件中

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

然后，在代码中，可以使用以下方式创建一个客户端

use aws_sdk_health as health;

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

    // ... make some calls with the client

    Ok(())
}

有关可以调用的方法和每个调用的输入输出信息，请参阅客户端文档。

使用SDK

在SDK发布之前，我们将向开发者指南中添加有关使用SDK的信息。请随时通过创建一个问题并描述您正在尝试做什么来建议指南的额外部分。

获取帮助

• GitHub讨论 - 用于想法、RFC和一般问题
• GitHub问题 - 用于错误报告和功能请求
• 生成的文档（最新版本）
• 使用示例

许可证

本项目采用Apache-2.0许可证。