aws-sdk-marketplacereporting

Crates.ioaws-sdk-marketplacereporting
lib.rsaws-sdk-marketplacereporting
version1.5.0
sourcesrc
created_at2024-10-03 19:07:37.752002
updated_at2024-11-06 21:47:07.333697
descriptionAWS SDK for AWS Marketplace Reporting Service
homepage
repositoryhttps://github.com/awslabs/aws-sdk-rust
max_upload_size
id1395581
size269,362
AWS SDK Rust Bot (aws-sdk-rust-ci)

documentation

README

aws-sdk-marketplacereporting

The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard programmatically. The API gets the agreement and cost analysis dashboards with data for all of the Amazon Web Services accounts in your Amazon Web Services Organization.

To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:

  • Enable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the Organizations User Guide.
  • Call the service as the Organizations management account or an account registered as a delegated administrator for the procurement insights service. For more information about management accounts, see Tutorial: Creating and configuring an organization and Managing the management account with Organizations, both in the Organizations User Guide. For more information about delegated administrators, see Using delegated administrators, in the Amazon Web Services Marketplace Buyer Guide.
  • Create an IAM policy that enables the aws-marketplace:GetBuyerDashboard and organizations:DescribeOrganization permissions. In addition, the management account requires the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create. For more information about creating the policy, see Policies and permissions in Identity and Access Management, in the IAM User Guide.
  • Use the Amazon Web Services Marketplace console to create the AWSServiceRoleForProcurementInsightsPolicy service-linked role. The role enables Amazon Web Services Marketplace procurement visibility integration. The management account requires an IAM policy with the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create the service-linked role and enable the service access. For more information, see Granting access to Organizations and Service-linked role to share procurement data in the Amazon Web Services Marketplace Buyer Guide.
  • After creating the service-linked role, you must enable trusted access that grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information, see Granting access to Organizations in the Amazon Web Services Marketplace Buyer Guide.

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

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

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

use aws_sdk_marketplacereporting as marketplacereporting;

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

License

This project is licensed under the Apache-2.0 License.

Commit count: 1103

cargo fmt