1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package athena
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/athena/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a session for running calculations within a workgroup. The session is
// ready when it reaches an IDLE state.
func (c *Client) StartSession(ctx context.Context, params *StartSessionInput, optFns ...func(*Options)) (*StartSessionOutput, error) {
if params == nil {
params = &StartSessionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartSession", params, optFns, c.addOperationStartSessionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartSessionOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartSessionInput struct {
// Contains engine data processing unit (DPU) configuration settings and parameter
// mappings.
//
// This member is required.
EngineConfiguration *types.EngineConfiguration
// The workgroup to which the session belongs.
//
// This member is required.
WorkGroup *string
// 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.
ClientRequestToken *string
// The session description.
Description *string
// 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 .
NotebookVersion *string
// The idle timeout in minutes for the session.
SessionIdleTimeoutInMinutes *int32
noSmithyDocumentSerde
}
type StartSessionOutput struct {
// The session ID.
SessionId *string
// The state of the session. A description of each state follows. CREATING - The
// session is being started, including acquiring resources. CREATED - The session
// has been started. IDLE - The session is able to accept a calculation. BUSY -
// The session is processing another task and is unable to accept a calculation.
// TERMINATING - The session is in the process of shutting down. TERMINATED - The
// session and its resources are no longer running. DEGRADED - The session has no
// healthy coordinators. FAILED - Due to a failure, the session and its resources
// are no longer running.
State types.SessionState
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartSessionMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpStartSession{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStartSession{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartSession"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpStartSessionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartSession(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opStartSession(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartSession",
}
}
|