/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace QuickSight { namespace Model { /** */ class AWS_QUICKSIGHT_API GetDashboardEmbedUrlRequest : public QuickSightRequest { public: GetDashboardEmbedUrlRequest(); // 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 "GetDashboardEmbedUrl"; } Aws::String SerializePayload() const override; void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The ID for the AWS account that contains the dashboard that you're * embedding.

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

The ID for the AWS account that contains the dashboard that you're * embedding.

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

The ID for the AWS 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 AWS 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 AWS 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 AWS account that contains the dashboard that you're * embedding.

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

The ID for the AWS account that contains the dashboard that you're * embedding.

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

The ID for the AWS account that contains the dashboard that you're * embedding.

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

The ID for the dashboard, also added to the IAM policy.

*/ inline const Aws::String& GetDashboardId() const{ return m_dashboardId; } /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline bool DashboardIdHasBeenSet() const { return m_dashboardIdHasBeenSet; } /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline void SetDashboardId(const Aws::String& value) { m_dashboardIdHasBeenSet = true; m_dashboardId = value; } /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline void SetDashboardId(Aws::String&& value) { m_dashboardIdHasBeenSet = true; m_dashboardId = std::move(value); } /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline void SetDashboardId(const char* value) { m_dashboardIdHasBeenSet = true; m_dashboardId.assign(value); } /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline GetDashboardEmbedUrlRequest& WithDashboardId(const Aws::String& value) { SetDashboardId(value); return *this;} /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline GetDashboardEmbedUrlRequest& WithDashboardId(Aws::String&& value) { SetDashboardId(std::move(value)); return *this;} /** *

The ID for the dashboard, also added to the IAM policy.

*/ inline GetDashboardEmbedUrlRequest& WithDashboardId(const char* value) { SetDashboardId(value); return *this;} /** *

The authentication method that the user uses to sign in.

*/ inline const IdentityType& GetIdentityType() const{ return m_identityType; } /** *

The authentication method that the user uses to sign in.

*/ inline bool IdentityTypeHasBeenSet() const { return m_identityTypeHasBeenSet; } /** *

The authentication method that the user uses to sign in.

*/ inline void SetIdentityType(const IdentityType& value) { m_identityTypeHasBeenSet = true; m_identityType = value; } /** *

The authentication method that the user uses to sign in.

*/ inline void SetIdentityType(IdentityType&& value) { m_identityTypeHasBeenSet = true; m_identityType = std::move(value); } /** *

The authentication method that the user uses to sign in.

*/ inline GetDashboardEmbedUrlRequest& WithIdentityType(const IdentityType& value) { SetIdentityType(value); return *this;} /** *

The authentication method that the user uses to sign in.

*/ inline GetDashboardEmbedUrlRequest& WithIdentityType(IdentityType&& value) { SetIdentityType(std::move(value)); return *this;} /** *

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

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

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

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

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

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

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

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

Remove the undo/redo button on the embedded dashboard. The default is FALSE, * which enables the undo/redo button.

*/ inline bool GetUndoRedoDisabled() const{ return m_undoRedoDisabled; } /** *

Remove the undo/redo button on the embedded dashboard. The default is FALSE, * which enables the undo/redo button.

*/ inline bool UndoRedoDisabledHasBeenSet() const { return m_undoRedoDisabledHasBeenSet; } /** *

Remove the undo/redo button on the embedded dashboard. The default is FALSE, * which enables the undo/redo button.

*/ inline void SetUndoRedoDisabled(bool value) { m_undoRedoDisabledHasBeenSet = true; m_undoRedoDisabled = value; } /** *

Remove the undo/redo button on the embedded dashboard. The default is FALSE, * which enables the undo/redo button.

*/ inline GetDashboardEmbedUrlRequest& WithUndoRedoDisabled(bool value) { SetUndoRedoDisabled(value); return *this;} /** *

Remove the reset button on the embedded dashboard. The default is FALSE, * which enables the reset button.

*/ inline bool GetResetDisabled() const{ return m_resetDisabled; } /** *

Remove the reset button on the embedded dashboard. The default is FALSE, * which enables the reset button.

*/ inline bool ResetDisabledHasBeenSet() const { return m_resetDisabledHasBeenSet; } /** *

Remove the reset button on the embedded dashboard. The default is FALSE, * which enables the reset button.

*/ inline void SetResetDisabled(bool value) { m_resetDisabledHasBeenSet = true; m_resetDisabled = value; } /** *

Remove the reset button on the embedded dashboard. The default is FALSE, * which enables the reset button.

*/ inline GetDashboardEmbedUrlRequest& WithResetDisabled(bool value) { SetResetDisabled(value); return *this;} /** *

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with * QUICKSIGHT identity type. You can use this for any Amazon * QuickSight users in your account (readers, authors, or admins) authenticated as * one of the following:

  • Active Directory (AD) users or group * members

  • Invited nonfederated users

  • IAM users * and IAM role-based sessions authenticated through Federated Single Sign-On using * SAML, OpenID Connect, or IAM federation.

Omit this parameter * for users in the third group – IAM users and IAM role-based sessions.

*/ inline GetDashboardEmbedUrlRequest& WithUserArn(const char* value) { SetUserArn(value); return *this;} private: Aws::String m_awsAccountId; bool m_awsAccountIdHasBeenSet; Aws::String m_dashboardId; bool m_dashboardIdHasBeenSet; IdentityType m_identityType; bool m_identityTypeHasBeenSet; long long m_sessionLifetimeInMinutes; bool m_sessionLifetimeInMinutesHasBeenSet; bool m_undoRedoDisabled; bool m_undoRedoDisabledHasBeenSet; bool m_resetDisabled; bool m_resetDisabledHasBeenSet; Aws::String m_userArn; bool m_userArnHasBeenSet; }; } // namespace Model } // namespace QuickSight } // namespace Aws