334 lines
17 KiB
C++
334 lines
17 KiB
C++
/**
|
||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||
* SPDX-License-Identifier: Apache-2.0.
|
||
*/
|
||
|
||
#pragma once
|
||
#include <aws/quicksight/QuickSight_EXPORTS.h>
|
||
#include <aws/quicksight/QuickSightRequest.h>
|
||
#include <aws/core/utils/memory/stl/AWSString.h>
|
||
#include <utility>
|
||
|
||
namespace Aws
|
||
{
|
||
namespace Http
|
||
{
|
||
class URI;
|
||
} //namespace Http
|
||
namespace QuickSight
|
||
{
|
||
namespace Model
|
||
{
|
||
|
||
/**
|
||
*/
|
||
class AWS_QUICKSIGHT_API GetSessionEmbedUrlRequest : public QuickSightRequest
|
||
{
|
||
public:
|
||
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::String SerializePayload() const override;
|
||
|
||
void AddQueryStringParameters(Aws::Http::URI& uri) const override;
|
||
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline const Aws::String& GetAwsAccountId() const{ return m_awsAccountId; }
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline bool AwsAccountIdHasBeenSet() const { return m_awsAccountIdHasBeenSet; }
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline void SetAwsAccountId(const Aws::String& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = value; }
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline void SetAwsAccountId(Aws::String&& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = std::move(value); }
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline void SetAwsAccountId(const char* value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId.assign(value); }
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithAwsAccountId(const Aws::String& value) { SetAwsAccountId(value); return *this;}
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithAwsAccountId(Aws::String&& value) { SetAwsAccountId(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>The ID for the AWS account associated with your QuickSight subscription.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithAwsAccountId(const char* value) { SetAwsAccountId(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline const Aws::String& GetEntryPoint() const{ return m_entryPoint; }
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline bool EntryPointHasBeenSet() const { return m_entryPointHasBeenSet; }
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline void SetEntryPoint(const Aws::String& value) { m_entryPointHasBeenSet = true; m_entryPoint = value; }
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline void SetEntryPoint(Aws::String&& value) { m_entryPointHasBeenSet = true; m_entryPoint = std::move(value); }
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline void SetEntryPoint(const char* value) { m_entryPointHasBeenSet = true; m_entryPoint.assign(value); }
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithEntryPoint(const Aws::String& value) { SetEntryPoint(value); return *this;}
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithEntryPoint(Aws::String&& value) { SetEntryPoint(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>The URL you use to access the embedded session. The entry point URL is
|
||
* constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p>
|
||
* </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p>
|
||
* <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code>
|
||
* </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where
|
||
* <code>DashboardId</code> is the actual ID key from the QuickSight console URL of
|
||
* the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> -
|
||
* where <code>AnalysisId</code> is the actual ID key from the QuickSight console
|
||
* URL of the analysis</p> </li> </ul>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithEntryPoint(const char* value) { SetEntryPoint(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>How many minutes the session is valid. The session lifetime must be 15-600
|
||
* minutes.</p>
|
||
*/
|
||
inline long long GetSessionLifetimeInMinutes() const{ return m_sessionLifetimeInMinutes; }
|
||
|
||
/**
|
||
* <p>How many minutes the session is valid. The session lifetime must be 15-600
|
||
* minutes.</p>
|
||
*/
|
||
inline bool SessionLifetimeInMinutesHasBeenSet() const { return m_sessionLifetimeInMinutesHasBeenSet; }
|
||
|
||
/**
|
||
* <p>How many minutes the session is valid. The session lifetime must be 15-600
|
||
* minutes.</p>
|
||
*/
|
||
inline void SetSessionLifetimeInMinutes(long long value) { m_sessionLifetimeInMinutesHasBeenSet = true; m_sessionLifetimeInMinutes = value; }
|
||
|
||
/**
|
||
* <p>How many minutes the session is valid. The session lifetime must be 15-600
|
||
* minutes.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithSessionLifetimeInMinutes(long long value) { SetSessionLifetimeInMinutes(value); return *this;}
|
||
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline const Aws::String& GetUserArn() const{ return m_userArn; }
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline bool UserArnHasBeenSet() const { return m_userArnHasBeenSet; }
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline void SetUserArn(const Aws::String& value) { m_userArnHasBeenSet = true; m_userArn = value; }
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline void SetUserArn(Aws::String&& value) { m_userArnHasBeenSet = true; m_userArn = std::move(value); }
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline void SetUserArn(const char* value) { m_userArnHasBeenSet = true; m_userArn.assign(value); }
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithUserArn(const Aws::String& value) { SetUserArn(value); return *this;}
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithUserArn(Aws::String&& value) { SetUserArn(std::move(value)); return *this;}
|
||
|
||
/**
|
||
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
||
* <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD)
|
||
* users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li>
|
||
* <li> <p>IAM users and IAM role-based sessions authenticated through Federated
|
||
* Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol>
|
||
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
||
* role-based sessions.</p>
|
||
*/
|
||
inline GetSessionEmbedUrlRequest& WithUserArn(const char* value) { SetUserArn(value); return *this;}
|
||
|
||
private:
|
||
|
||
Aws::String m_awsAccountId;
|
||
bool m_awsAccountIdHasBeenSet;
|
||
|
||
Aws::String m_entryPoint;
|
||
bool m_entryPointHasBeenSet;
|
||
|
||
long long m_sessionLifetimeInMinutes;
|
||
bool m_sessionLifetimeInMinutesHasBeenSet;
|
||
|
||
Aws::String m_userArn;
|
||
bool m_userArnHasBeenSet;
|
||
};
|
||
|
||
} // namespace Model
|
||
} // namespace QuickSight
|
||
} // namespace Aws
|