309 lines
12 KiB
C++
309 lines
12 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/appstream/AppStream_EXPORTS.h>
|
|
#include <aws/appstream/AppStreamRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/appstream/model/AuthenticationType.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace AppStream
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_APPSTREAM_API DescribeSessionsRequest : public AppStreamRequest
|
|
{
|
|
public:
|
|
DescribeSessionsRequest();
|
|
|
|
// 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 "DescribeSessions"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline const Aws::String& GetStackName() const{ return m_stackName; }
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline bool StackNameHasBeenSet() const { return m_stackNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline void SetStackName(const Aws::String& value) { m_stackNameHasBeenSet = true; m_stackName = value; }
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline void SetStackName(Aws::String&& value) { m_stackNameHasBeenSet = true; m_stackName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline void SetStackName(const char* value) { m_stackNameHasBeenSet = true; m_stackName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithStackName(const Aws::String& value) { SetStackName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithStackName(Aws::String&& value) { SetStackName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the stack. This value is case-sensitive.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithStackName(const char* value) { SetStackName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline const Aws::String& GetFleetName() const{ return m_fleetName; }
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline bool FleetNameHasBeenSet() const { return m_fleetNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline void SetFleetName(const Aws::String& value) { m_fleetNameHasBeenSet = true; m_fleetName = value; }
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline void SetFleetName(Aws::String&& value) { m_fleetNameHasBeenSet = true; m_fleetName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline void SetFleetName(const char* value) { m_fleetNameHasBeenSet = true; m_fleetName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithFleetName(const Aws::String& value) { SetFleetName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithFleetName(Aws::String&& value) { SetFleetName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the fleet. This value is case-sensitive.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithFleetName(const char* value) { SetFleetName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline const Aws::String& GetUserId() const{ return m_userId; }
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline bool UserIdHasBeenSet() const { return m_userIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline void SetUserId(const Aws::String& value) { m_userIdHasBeenSet = true; m_userId = value; }
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline void SetUserId(Aws::String&& value) { m_userIdHasBeenSet = true; m_userId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline void SetUserId(const char* value) { m_userIdHasBeenSet = true; m_userId.assign(value); }
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithUserId(const Aws::String& value) { SetUserId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithUserId(Aws::String&& value) { SetUserId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The user identifier (ID). If you specify a user ID, you must also specify the
|
|
* authentication type.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithUserId(const char* value) { SetUserId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The pagination token to use to retrieve the next page of results for this
|
|
* operation. If this value is null, it retrieves the first page.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The size of each page of results. The default value is 20 and the maximum
|
|
* value is 50.</p>
|
|
*/
|
|
inline int GetLimit() const{ return m_limit; }
|
|
|
|
/**
|
|
* <p>The size of each page of results. The default value is 20 and the maximum
|
|
* value is 50.</p>
|
|
*/
|
|
inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The size of each page of results. The default value is 20 and the maximum
|
|
* value is 50.</p>
|
|
*/
|
|
inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
|
|
|
|
/**
|
|
* <p>The size of each page of results. The default value is 20 and the maximum
|
|
* value is 50.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithLimit(int value) { SetLimit(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The authentication method. Specify <code>API</code> for a user authenticated
|
|
* using a streaming URL or <code>SAML</code> for a SAML federated user. The
|
|
* default is to authenticate users using a streaming URL.</p>
|
|
*/
|
|
inline const AuthenticationType& GetAuthenticationType() const{ return m_authenticationType; }
|
|
|
|
/**
|
|
* <p>The authentication method. Specify <code>API</code> for a user authenticated
|
|
* using a streaming URL or <code>SAML</code> for a SAML federated user. The
|
|
* default is to authenticate users using a streaming URL.</p>
|
|
*/
|
|
inline bool AuthenticationTypeHasBeenSet() const { return m_authenticationTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The authentication method. Specify <code>API</code> for a user authenticated
|
|
* using a streaming URL or <code>SAML</code> for a SAML federated user. The
|
|
* default is to authenticate users using a streaming URL.</p>
|
|
*/
|
|
inline void SetAuthenticationType(const AuthenticationType& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = value; }
|
|
|
|
/**
|
|
* <p>The authentication method. Specify <code>API</code> for a user authenticated
|
|
* using a streaming URL or <code>SAML</code> for a SAML federated user. The
|
|
* default is to authenticate users using a streaming URL.</p>
|
|
*/
|
|
inline void SetAuthenticationType(AuthenticationType&& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = std::move(value); }
|
|
|
|
/**
|
|
* <p>The authentication method. Specify <code>API</code> for a user authenticated
|
|
* using a streaming URL or <code>SAML</code> for a SAML federated user. The
|
|
* default is to authenticate users using a streaming URL.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithAuthenticationType(const AuthenticationType& value) { SetAuthenticationType(value); return *this;}
|
|
|
|
/**
|
|
* <p>The authentication method. Specify <code>API</code> for a user authenticated
|
|
* using a streaming URL or <code>SAML</code> for a SAML federated user. The
|
|
* default is to authenticate users using a streaming URL.</p>
|
|
*/
|
|
inline DescribeSessionsRequest& WithAuthenticationType(AuthenticationType&& value) { SetAuthenticationType(std::move(value)); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_stackName;
|
|
bool m_stackNameHasBeenSet;
|
|
|
|
Aws::String m_fleetName;
|
|
bool m_fleetNameHasBeenSet;
|
|
|
|
Aws::String m_userId;
|
|
bool m_userIdHasBeenSet;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet;
|
|
|
|
int m_limit;
|
|
bool m_limitHasBeenSet;
|
|
|
|
AuthenticationType m_authenticationType;
|
|
bool m_authenticationTypeHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace AppStream
|
|
} // namespace Aws
|