/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace QuickSight { namespace Model { /** */ class GenerateEmbedUrlForRegisteredUserRequest : public QuickSightRequest { public: AWS_QUICKSIGHT_API GenerateEmbedUrlForRegisteredUserRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GenerateEmbedUrlForRegisteredUser"; } AWS_QUICKSIGHT_API Aws::String SerializePayload() const override; /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline const Aws::String& GetAwsAccountId() const{ return m_awsAccountId; } /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline bool AwsAccountIdHasBeenSet() const { return m_awsAccountIdHasBeenSet; } /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline void SetAwsAccountId(const Aws::String& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = value; } /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline void SetAwsAccountId(Aws::String&& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = std::move(value); } /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline void SetAwsAccountId(const char* value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId.assign(value); } /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithAwsAccountId(const Aws::String& value) { SetAwsAccountId(value); return *this;} /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithAwsAccountId(Aws::String&& value) { SetAwsAccountId(std::move(value)); return *this;} /** *

The ID for the Amazon Web Services account that contains the dashboard that * you're embedding.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithAwsAccountId(const char* value) { SetAwsAccountId(value); return *this;} /** *

How many minutes the session is valid. The session lifetime must be in * [15-600] minutes range.

*/ inline long long GetSessionLifetimeInMinutes() const{ return m_sessionLifetimeInMinutes; } /** *

How many minutes the session is valid. The session lifetime must be in * [15-600] minutes range.

*/ inline bool SessionLifetimeInMinutesHasBeenSet() const { return m_sessionLifetimeInMinutesHasBeenSet; } /** *

How many minutes the session is valid. The session lifetime must be in * [15-600] minutes range.

*/ inline void SetSessionLifetimeInMinutes(long long value) { m_sessionLifetimeInMinutesHasBeenSet = true; m_sessionLifetimeInMinutes = value; } /** *

How many minutes the session is valid. The session lifetime must be in * [15-600] minutes range.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithSessionLifetimeInMinutes(long long value) { SetSessionLifetimeInMinutes(value); return *this;} /** *

The Amazon Resource Name for the registered user.

*/ inline const Aws::String& GetUserArn() const{ return m_userArn; } /** *

The Amazon Resource Name for the registered user.

*/ inline bool UserArnHasBeenSet() const { return m_userArnHasBeenSet; } /** *

The Amazon Resource Name for the registered user.

*/ inline void SetUserArn(const Aws::String& value) { m_userArnHasBeenSet = true; m_userArn = value; } /** *

The Amazon Resource Name for the registered user.

*/ inline void SetUserArn(Aws::String&& value) { m_userArnHasBeenSet = true; m_userArn = std::move(value); } /** *

The Amazon Resource Name for the registered user.

*/ inline void SetUserArn(const char* value) { m_userArnHasBeenSet = true; m_userArn.assign(value); } /** *

The Amazon Resource Name for the registered user.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithUserArn(const Aws::String& value) { SetUserArn(value); return *this;} /** *

The Amazon Resource Name for the registered user.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithUserArn(Aws::String&& value) { SetUserArn(std::move(value)); return *this;} /** *

The Amazon Resource Name for the registered user.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithUserArn(const char* value) { SetUserArn(value); return *this;} /** *

The experience you are embedding. For registered users, you can embed Amazon * QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search * bar, or the entire Amazon QuickSight console.

*/ inline const RegisteredUserEmbeddingExperienceConfiguration& GetExperienceConfiguration() const{ return m_experienceConfiguration; } /** *

The experience you are embedding. For registered users, you can embed Amazon * QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search * bar, or the entire Amazon QuickSight console.

*/ inline bool ExperienceConfigurationHasBeenSet() const { return m_experienceConfigurationHasBeenSet; } /** *

The experience you are embedding. For registered users, you can embed Amazon * QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search * bar, or the entire Amazon QuickSight console.

*/ inline void SetExperienceConfiguration(const RegisteredUserEmbeddingExperienceConfiguration& value) { m_experienceConfigurationHasBeenSet = true; m_experienceConfiguration = value; } /** *

The experience you are embedding. For registered users, you can embed Amazon * QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search * bar, or the entire Amazon QuickSight console.

*/ inline void SetExperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration&& value) { m_experienceConfigurationHasBeenSet = true; m_experienceConfiguration = std::move(value); } /** *

The experience you are embedding. For registered users, you can embed Amazon * QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search * bar, or the entire Amazon QuickSight console.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithExperienceConfiguration(const RegisteredUserEmbeddingExperienceConfiguration& value) { SetExperienceConfiguration(value); return *this;} /** *

The experience you are embedding. For registered users, you can embed Amazon * QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search * bar, or the entire Amazon QuickSight console.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithExperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration&& value) { SetExperienceConfiguration(std::move(value)); return *this;} /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline const Aws::Vector& GetAllowedDomains() const{ return m_allowedDomains; } /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline bool AllowedDomainsHasBeenSet() const { return m_allowedDomainsHasBeenSet; } /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline void SetAllowedDomains(const Aws::Vector& value) { m_allowedDomainsHasBeenSet = true; m_allowedDomains = value; } /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline void SetAllowedDomains(Aws::Vector&& value) { m_allowedDomainsHasBeenSet = true; m_allowedDomains = std::move(value); } /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithAllowedDomains(const Aws::Vector& value) { SetAllowedDomains(value); return *this;} /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& WithAllowedDomains(Aws::Vector&& value) { SetAllowedDomains(std::move(value)); return *this;} /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& AddAllowedDomains(const Aws::String& value) { m_allowedDomainsHasBeenSet = true; m_allowedDomains.push_back(value); return *this; } /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& AddAllowedDomains(Aws::String&& value) { m_allowedDomainsHasBeenSet = true; m_allowedDomains.push_back(std::move(value)); return *this; } /** *

The domains that you want to add to the allow list for access to the * generated URL that is then embedded. This optional parameter overrides the * static domains that are configured in the Manage QuickSight menu in the Amazon * QuickSight console. Instead, it allows only the domains that you include in this * parameter. You can list up to three domains or subdomains in each API call.

*

To include all subdomains under a specific domain to the allow list, use * *. For example, https:// *.sapp.amazon.com includes all * subdomains under https://sapp.amazon.com.

*/ inline GenerateEmbedUrlForRegisteredUserRequest& AddAllowedDomains(const char* value) { m_allowedDomainsHasBeenSet = true; m_allowedDomains.push_back(value); return *this; } private: Aws::String m_awsAccountId; bool m_awsAccountIdHasBeenSet = false; long long m_sessionLifetimeInMinutes; bool m_sessionLifetimeInMinutesHasBeenSet = false; Aws::String m_userArn; bool m_userArnHasBeenSet = false; RegisteredUserEmbeddingExperienceConfiguration m_experienceConfiguration; bool m_experienceConfigurationHasBeenSet = false; Aws::Vector m_allowedDomains; bool m_allowedDomainsHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws