/** * 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 Athena { namespace Model { /** */ class StartSessionRequest : public AthenaRequest { public: AWS_ATHENA_API StartSessionRequest(); // 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 "StartSession"; } AWS_ATHENA_API Aws::String SerializePayload() const override; AWS_ATHENA_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The session description.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The session description.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The session description.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The session description.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The session description.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The session description.

*/ inline StartSessionRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The session description.

*/ inline StartSessionRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The session description.

*/ inline StartSessionRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The workgroup to which the session belongs.

*/ inline const Aws::String& GetWorkGroup() const{ return m_workGroup; } /** *

The workgroup to which the session belongs.

*/ inline bool WorkGroupHasBeenSet() const { return m_workGroupHasBeenSet; } /** *

The workgroup to which the session belongs.

*/ inline void SetWorkGroup(const Aws::String& value) { m_workGroupHasBeenSet = true; m_workGroup = value; } /** *

The workgroup to which the session belongs.

*/ inline void SetWorkGroup(Aws::String&& value) { m_workGroupHasBeenSet = true; m_workGroup = std::move(value); } /** *

The workgroup to which the session belongs.

*/ inline void SetWorkGroup(const char* value) { m_workGroupHasBeenSet = true; m_workGroup.assign(value); } /** *

The workgroup to which the session belongs.

*/ inline StartSessionRequest& WithWorkGroup(const Aws::String& value) { SetWorkGroup(value); return *this;} /** *

The workgroup to which the session belongs.

*/ inline StartSessionRequest& WithWorkGroup(Aws::String&& value) { SetWorkGroup(std::move(value)); return *this;} /** *

The workgroup to which the session belongs.

*/ inline StartSessionRequest& WithWorkGroup(const char* value) { SetWorkGroup(value); return *this;} /** *

Contains engine data processing unit (DPU) configuration settings and * parameter mappings.

*/ inline const EngineConfiguration& GetEngineConfiguration() const{ return m_engineConfiguration; } /** *

Contains engine data processing unit (DPU) configuration settings and * parameter mappings.

*/ inline bool EngineConfigurationHasBeenSet() const { return m_engineConfigurationHasBeenSet; } /** *

Contains engine data processing unit (DPU) configuration settings and * parameter mappings.

*/ inline void SetEngineConfiguration(const EngineConfiguration& value) { m_engineConfigurationHasBeenSet = true; m_engineConfiguration = value; } /** *

Contains engine data processing unit (DPU) configuration settings and * parameter mappings.

*/ inline void SetEngineConfiguration(EngineConfiguration&& value) { m_engineConfigurationHasBeenSet = true; m_engineConfiguration = std::move(value); } /** *

Contains engine data processing unit (DPU) configuration settings and * parameter mappings.

*/ inline StartSessionRequest& WithEngineConfiguration(const EngineConfiguration& value) { SetEngineConfiguration(value); return *this;} /** *

Contains engine data processing unit (DPU) configuration settings and * parameter mappings.

*/ inline StartSessionRequest& WithEngineConfiguration(EngineConfiguration&& value) { SetEngineConfiguration(std::move(value)); return *this;} /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline const Aws::String& GetNotebookVersion() const{ return m_notebookVersion; } /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline bool NotebookVersionHasBeenSet() const { return m_notebookVersionHasBeenSet; } /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline void SetNotebookVersion(const Aws::String& value) { m_notebookVersionHasBeenSet = true; m_notebookVersion = value; } /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline void SetNotebookVersion(Aws::String&& value) { m_notebookVersionHasBeenSet = true; m_notebookVersion = std::move(value); } /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline void SetNotebookVersion(const char* value) { m_notebookVersionHasBeenSet = true; m_notebookVersion.assign(value); } /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline StartSessionRequest& WithNotebookVersion(const Aws::String& value) { SetNotebookVersion(value); return *this;} /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline StartSessionRequest& WithNotebookVersion(Aws::String&& value) { SetNotebookVersion(std::move(value)); return *this;} /** *

The notebook version. This value is supplied automatically for notebook * sessions in the Athena console and is not required for programmatic session * access. The only valid notebook version is Athena notebook version * 1. If you specify a value for NotebookVersion, you must also * specify a value for NotebookId. See * EngineConfiguration$AdditionalConfigs.

*/ inline StartSessionRequest& WithNotebookVersion(const char* value) { SetNotebookVersion(value); return *this;} /** *

The idle timeout in minutes for the session.

*/ inline int GetSessionIdleTimeoutInMinutes() const{ return m_sessionIdleTimeoutInMinutes; } /** *

The idle timeout in minutes for the session.

*/ inline bool SessionIdleTimeoutInMinutesHasBeenSet() const { return m_sessionIdleTimeoutInMinutesHasBeenSet; } /** *

The idle timeout in minutes for the session.

*/ inline void SetSessionIdleTimeoutInMinutes(int value) { m_sessionIdleTimeoutInMinutesHasBeenSet = true; m_sessionIdleTimeoutInMinutes = value; } /** *

The idle timeout in minutes for the session.

*/ inline StartSessionRequest& WithSessionIdleTimeoutInMinutes(int value) { SetSessionIdleTimeoutInMinutes(value); return *this;} /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline StartSessionRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline StartSessionRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

A unique case-sensitive string used to ensure the request to create the * session is idempotent (executes only once). If another * StartSessionRequest is received, the same response is returned and * another session is not created. If a parameter has changed, an error is * returned.

This token is listed as not required because Amazon * Web Services SDKs (for example the Amazon Web Services SDK for Java) * auto-generate the token for users. If you are not using the Amazon Web Services * SDK or the Amazon Web Services CLI, you must provide this token or the action * will fail.

*/ inline StartSessionRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} private: Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_workGroup; bool m_workGroupHasBeenSet = false; EngineConfiguration m_engineConfiguration; bool m_engineConfigurationHasBeenSet = false; Aws::String m_notebookVersion; bool m_notebookVersionHasBeenSet = false; int m_sessionIdleTimeoutInMinutes; bool m_sessionIdleTimeoutInMinutesHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; }; } // namespace Model } // namespace Athena } // namespace Aws