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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The ID for the Amazon Web Services account associated with your Amazon * QuickSight subscription.

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

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline const Aws::String& GetEntryPoint() const{ return m_entryPoint; } /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline bool EntryPointHasBeenSet() const { return m_entryPointHasBeenSet; } /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline void SetEntryPoint(const Aws::String& value) { m_entryPointHasBeenSet = true; m_entryPoint = value; } /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline void SetEntryPoint(Aws::String&& value) { m_entryPointHasBeenSet = true; m_entryPoint = std::move(value); } /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline void SetEntryPoint(const char* value) { m_entryPointHasBeenSet = true; m_entryPoint.assign(value); } /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline GetSessionEmbedUrlRequest& WithEntryPoint(const Aws::String& value) { SetEntryPoint(value); return *this;} /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline GetSessionEmbedUrlRequest& WithEntryPoint(Aws::String&& value) { SetEntryPoint(std::move(value)); return *this;} /** *

The URL you use to access the embedded session. The entry point URL is * constrained to the following paths:

  • /start

    *
  • /start/analyses

  • * /start/dashboards

  • /start/favorites *

  • /dashboards/DashboardId - where * DashboardId is the actual ID key from the Amazon QuickSight console * URL of the dashboard

  • /analyses/AnalysisId * - where AnalysisId is the actual ID key from the Amazon * QuickSight console URL of the analysis

*/ inline GetSessionEmbedUrlRequest& WithEntryPoint(const char* value) { SetEntryPoint(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 GetSessionEmbedUrlRequest& WithSessionLifetimeInMinutes(long long value) { SetSessionLifetimeInMinutes(value); return *this;} /** *

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

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 GetSessionEmbedUrlRequest& 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 GetSessionEmbedUrlRequest& 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 type of Amazon * QuickSight users in your account (readers, authors, or admins). They need to be * authenticated as one of the following:

  1. Active Directory (AD) * users or group members

  2. Invited nonfederated users

  3. *
  4. 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 GetSessionEmbedUrlRequest& WithUserArn(const char* value) { SetUserArn(value); return *this;} private: Aws::String m_awsAccountId; bool m_awsAccountIdHasBeenSet = false; Aws::String m_entryPoint; bool m_entryPointHasBeenSet = false; long long m_sessionLifetimeInMinutes; bool m_sessionLifetimeInMinutesHasBeenSet = false; Aws::String m_userArn; bool m_userArnHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws