aws_sdk_marketplacereporting/client/
get_buyer_dashboard.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetBuyerDashboard`](crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dashboard_identifier(impl Into<String>)`](crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder::dashboard_identifier) / [`set_dashboard_identifier(Option<String>)`](crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder::set_dashboard_identifier):<br>required: **true**<br><p>The ARN of the requested dashboard.</p><br>
    ///   - [`embedding_domains(impl Into<String>)`](crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder::embedding_domains) / [`set_embedding_domains(Option<Vec::<String>>)`](crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder::set_embedding_domains):<br>required: **true**<br><p>Fully qualified domains that you add to the allow list for access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call. To include all subdomains under a specific domain, use <code>*</code>. For example, <code>https://*.amazon.com</code> includes all subdomains under <code>https://aws.amazon.com</code>.</p><br>
    /// - On success, responds with [`GetBuyerDashboardOutput`](crate::operation::get_buyer_dashboard::GetBuyerDashboardOutput) with field(s):
    ///   - [`embed_url(String)`](crate::operation::get_buyer_dashboard::GetBuyerDashboardOutput::embed_url): <p>The dashboard's embedding URL.</p>
    ///   - [`dashboard_identifier(String)`](crate::operation::get_buyer_dashboard::GetBuyerDashboardOutput::dashboard_identifier): <p>The ARN of the returned dashboard.</p>
    ///   - [`embedding_domains(Vec::<String>)`](crate::operation::get_buyer_dashboard::GetBuyerDashboardOutput::embedding_domains): <p>The fully qualified domains specified in the request. The domains enable access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call. To include all subdomains under a specific domain, use <code>*</code>. For example, <code>https://*.amazon.com</code> includes all subdomains under <code>https://aws.amazon.com</code>.</p>
    /// - On failure, responds with [`SdkError<GetBuyerDashboardError>`](crate::operation::get_buyer_dashboard::GetBuyerDashboardError)
    pub fn get_buyer_dashboard(&self) -> crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder {
        crate::operation::get_buyer_dashboard::builders::GetBuyerDashboardFluentBuilder::new(self.handle.clone())
    }
}