/** * 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 AppStream { namespace Model { /** */ class DescribeSessionsRequest : public AppStreamRequest { public: AWS_APPSTREAM_API 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_APPSTREAM_API Aws::String SerializePayload() const override; AWS_APPSTREAM_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the stack. This value is case-sensitive.

*/ inline const Aws::String& GetStackName() const{ return m_stackName; } /** *

The name of the stack. This value is case-sensitive.

*/ inline bool StackNameHasBeenSet() const { return m_stackNameHasBeenSet; } /** *

The name of the stack. This value is case-sensitive.

*/ inline void SetStackName(const Aws::String& value) { m_stackNameHasBeenSet = true; m_stackName = value; } /** *

The name of the stack. This value is case-sensitive.

*/ inline void SetStackName(Aws::String&& value) { m_stackNameHasBeenSet = true; m_stackName = std::move(value); } /** *

The name of the stack. This value is case-sensitive.

*/ inline void SetStackName(const char* value) { m_stackNameHasBeenSet = true; m_stackName.assign(value); } /** *

The name of the stack. This value is case-sensitive.

*/ inline DescribeSessionsRequest& WithStackName(const Aws::String& value) { SetStackName(value); return *this;} /** *

The name of the stack. This value is case-sensitive.

*/ inline DescribeSessionsRequest& WithStackName(Aws::String&& value) { SetStackName(std::move(value)); return *this;} /** *

The name of the stack. This value is case-sensitive.

*/ inline DescribeSessionsRequest& WithStackName(const char* value) { SetStackName(value); return *this;} /** *

The name of the fleet. This value is case-sensitive.

*/ inline const Aws::String& GetFleetName() const{ return m_fleetName; } /** *

The name of the fleet. This value is case-sensitive.

*/ inline bool FleetNameHasBeenSet() const { return m_fleetNameHasBeenSet; } /** *

The name of the fleet. This value is case-sensitive.

*/ inline void SetFleetName(const Aws::String& value) { m_fleetNameHasBeenSet = true; m_fleetName = value; } /** *

The name of the fleet. This value is case-sensitive.

*/ inline void SetFleetName(Aws::String&& value) { m_fleetNameHasBeenSet = true; m_fleetName = std::move(value); } /** *

The name of the fleet. This value is case-sensitive.

*/ inline void SetFleetName(const char* value) { m_fleetNameHasBeenSet = true; m_fleetName.assign(value); } /** *

The name of the fleet. This value is case-sensitive.

*/ inline DescribeSessionsRequest& WithFleetName(const Aws::String& value) { SetFleetName(value); return *this;} /** *

The name of the fleet. This value is case-sensitive.

*/ inline DescribeSessionsRequest& WithFleetName(Aws::String&& value) { SetFleetName(std::move(value)); return *this;} /** *

The name of the fleet. This value is case-sensitive.

*/ inline DescribeSessionsRequest& WithFleetName(const char* value) { SetFleetName(value); return *this;} /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline const Aws::String& GetUserId() const{ return m_userId; } /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline bool UserIdHasBeenSet() const { return m_userIdHasBeenSet; } /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline void SetUserId(const Aws::String& value) { m_userIdHasBeenSet = true; m_userId = value; } /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline void SetUserId(Aws::String&& value) { m_userIdHasBeenSet = true; m_userId = std::move(value); } /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline void SetUserId(const char* value) { m_userIdHasBeenSet = true; m_userId.assign(value); } /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline DescribeSessionsRequest& WithUserId(const Aws::String& value) { SetUserId(value); return *this;} /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline DescribeSessionsRequest& WithUserId(Aws::String&& value) { SetUserId(std::move(value)); return *this;} /** *

The user identifier (ID). If you specify a user ID, you must also specify the * authentication type.

*/ inline DescribeSessionsRequest& WithUserId(const char* value) { SetUserId(value); return *this;} /** *

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.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

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.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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.

*/ inline DescribeSessionsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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.

*/ inline DescribeSessionsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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.

*/ inline DescribeSessionsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The size of each page of results. The default value is 20 and the maximum * value is 50.

*/ inline int GetLimit() const{ return m_limit; } /** *

The size of each page of results. The default value is 20 and the maximum * value is 50.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

The size of each page of results. The default value is 20 and the maximum * value is 50.

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

The size of each page of results. The default value is 20 and the maximum * value is 50.

*/ inline DescribeSessionsRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

The authentication method. Specify API for a user authenticated * using a streaming URL or SAML for a SAML federated user. The * default is to authenticate users using a streaming URL.

*/ inline const AuthenticationType& GetAuthenticationType() const{ return m_authenticationType; } /** *

The authentication method. Specify API for a user authenticated * using a streaming URL or SAML for a SAML federated user. The * default is to authenticate users using a streaming URL.

*/ inline bool AuthenticationTypeHasBeenSet() const { return m_authenticationTypeHasBeenSet; } /** *

The authentication method. Specify API for a user authenticated * using a streaming URL or SAML for a SAML federated user. The * default is to authenticate users using a streaming URL.

*/ inline void SetAuthenticationType(const AuthenticationType& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = value; } /** *

The authentication method. Specify API for a user authenticated * using a streaming URL or SAML for a SAML federated user. The * default is to authenticate users using a streaming URL.

*/ inline void SetAuthenticationType(AuthenticationType&& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = std::move(value); } /** *

The authentication method. Specify API for a user authenticated * using a streaming URL or SAML for a SAML federated user. The * default is to authenticate users using a streaming URL.

*/ inline DescribeSessionsRequest& WithAuthenticationType(const AuthenticationType& value) { SetAuthenticationType(value); return *this;} /** *

The authentication method. Specify API for a user authenticated * using a streaming URL or SAML for a SAML federated user. The * default is to authenticate users using a streaming URL.

*/ inline DescribeSessionsRequest& WithAuthenticationType(AuthenticationType&& value) { SetAuthenticationType(std::move(value)); return *this;} private: Aws::String m_stackName; bool m_stackNameHasBeenSet = false; Aws::String m_fleetName; bool m_fleetNameHasBeenSet = false; Aws::String m_userId; bool m_userIdHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; AuthenticationType m_authenticationType; bool m_authenticationTypeHasBeenSet = false; }; } // namespace Model } // namespace AppStream } // namespace Aws