AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartSession operation. Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Athena.AmazonAthenaRequest
      Amazon.Athena.Model.StartSessionRequest

Namespace: Amazon.Athena.Model
Assembly: AWSSDK.Athena.dll
Version: 3.x.y.z

Syntax

C# 
public class StartSessionRequest : AmazonAthenaRequest
         IAmazonWebServiceRequest

The StartSessionRequest type exposes the following members

Constructors

NameDescription
Public Method StartSessionRequest()

Properties

NameTypeDescription
Public Property ClientRequestToken System.String

Gets and sets the property 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.

Public Property CopyWorkGroupTags System.Boolean

Gets and sets the property CopyWorkGroupTags.

Copies the tags from the Workgroup to the Session when.

Public Property Description System.String

Gets and sets the property Description.

The session description.

Public Property EngineConfiguration Amazon.Athena.Model.EngineConfiguration

Gets and sets the property EngineConfiguration.

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

Public Property ExecutionRole System.String

Gets and sets the property ExecutionRole.

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

Public Property MonitoringConfiguration Amazon.Athena.Model.MonitoringConfiguration

Gets and sets the property MonitoringConfiguration.

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Public Property NotebookVersion System.String

Gets and sets the property 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.

Public Property SessionIdleTimeoutInMinutes System.Int32

Gets and sets the property SessionIdleTimeoutInMinutes.

The idle timeout in minutes for the session.

Public Property Tags System.Collections.Generic.List<Amazon.Athena.Model.Tag>

Gets and sets the property Tags.

A list of comma separated tags to add to the session that is created.

Public Property WorkGroup System.String

Gets and sets the property WorkGroup.

The workgroup to which the session belongs.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5