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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package simspaceweaver
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/simspaceweaver/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Starts a simulation with the given name. You must choose to start your
// simulation from a schema or from a snapshot. For more information about the
// schema, see the [schema reference]in the SimSpace Weaver User Guide. For more information about
// snapshots, see [Snapshots]in the SimSpace Weaver User Guide.
//
// [schema reference]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html
// [Snapshots]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html
func (c *Client) StartSimulation(ctx context.Context, params *StartSimulationInput, optFns ...func(*Options)) (*StartSimulationOutput, error) {
if params == nil {
params = &StartSimulationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartSimulation", params, optFns, c.addOperationStartSimulationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartSimulationOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartSimulationInput struct {
// The name of the simulation.
//
// This member is required.
Name *string
// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
// that the simulation assumes to perform actions. For more information about ARNs,
// see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference. For more information about
// IAM roles, see [IAM roles]in the Identity and Access Management User Guide.
//
// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
RoleArn *string
// A value that you provide to ensure that repeated calls to this API operation
// using the same parameters complete only once. A ClientToken is also known as an
// idempotency token. A ClientToken expires after 24 hours.
ClientToken *string
// The description of the simulation.
Description *string
// The maximum running time of the simulation, specified as a number of minutes (m
// or M), hours (h or H), or days (d or D). The simulation stops when it reaches
// this limit. The maximum value is 14D , or its equivalent in the other units. The
// default value is 14D . A value equivalent to 0 makes the simulation immediately
// transition to Stopping as soon as it reaches Started .
MaximumDuration *string
// The location of the simulation schema in Amazon Simple Storage Service (Amazon
// S3). For more information about Amazon S3, see the [Amazon Simple Storage Service User Guide].
//
// Provide a SchemaS3Location to start your simulation from a schema.
//
// If you provide a SchemaS3Location then you can't provide a SnapshotS3Location .
//
// [Amazon Simple Storage Service User Guide]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
SchemaS3Location *types.S3Location
// The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon
// S3). For more information about Amazon S3, see the [Amazon Simple Storage Service User Guide].
//
// Provide a SnapshotS3Location to start your simulation from a snapshot.
//
// The Amazon S3 bucket must be in the same Amazon Web Services Region as the
// simulation.
//
// If you provide a SnapshotS3Location then you can't provide a SchemaS3Location .
//
// [Amazon Simple Storage Service User Guide]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
SnapshotS3Location *types.S3Location
// A list of tags for the simulation. For more information about tags, see [Tagging Amazon Web Services resources] in the
// Amazon Web Services General Reference.
//
// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
Tags map[string]string
noSmithyDocumentSerde
}
type StartSimulationOutput struct {
// The Amazon Resource Name (ARN) of the simulation. For more information about
// ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference.
//
// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
Arn *string
// The time when the simulation was created, expressed as the number of seconds
// and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
CreationTime *time.Time
// A universally unique identifier (UUID) for this simulation.
ExecutionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartSimulationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartSimulation{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartSimulation{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartSimulation"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addIdempotencyToken_opStartSimulationMiddleware(stack, options); err != nil {
return err
}
if err = addOpStartSimulationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartSimulation(options.Region), middleware.Before); err != nil {
return err
}
if err = 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
}
type idempotencyToken_initializeOpStartSimulation struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpStartSimulation) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpStartSimulation) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*StartSimulationInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *StartSimulationInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opStartSimulationMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpStartSimulation{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opStartSimulation(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartSimulation",
}
}
|