// Code generated by smithy-go-codegen DO NOT EDIT. package simspaceweaver import ( "context" 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/simspaceweaver/types" "github.com/aws/smithy-go/middleware" smithyhttp "github.com/aws/smithy-go/transport/http" ) // Creates a snapshot of the specified simulation. A snapshot is a file that // contains simulation state data at a specific time. The state data saved in a // snapshot includes entity data from the State Fabric, the simulation // configuration specified in the schema, and the clock tick number. You can use // the snapshot to initialize a new simulation. For more information about // snapshots, see Snapshots (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html) // in the SimSpace Weaver User Guide. You specify a Destination when you create a // snapshot. The Destination is the name of an Amazon S3 bucket and an optional // ObjectKeyPrefix . The ObjectKeyPrefix is usually the name of a folder in the // bucket. SimSpace Weaver creates a snapshot folder inside the Destination and // places the snapshot file there. The snapshot file is an Amazon S3 object. It has // an object key with the form: // object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip , where: // - YY is the 2-digit year // - MM is the 2-digit month // - dd is the 2-digit day of the month // - HH is the 2-digit hour (24-hour clock) // - mm is the 2-digit minutes // - ss is the 2-digit seconds func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} } result, metadata, err := c.invokeOperation(ctx, "CreateSnapshot", params, optFns, c.addOperationCreateSnapshotMiddlewares) if err != nil { return nil, err } out := result.(*CreateSnapshotOutput) out.ResultMetadata = metadata return out, nil } type CreateSnapshotInput struct { // The Amazon S3 bucket and optional folder (object key prefix) where SimSpace // Weaver creates the snapshot file. The Amazon S3 bucket must be in the same // Amazon Web Services Region as the simulation. // // This member is required. Destination *types.S3Destination // The name of the simulation. // // This member is required. Simulation *string noSmithyDocumentSerde } type CreateSnapshotOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationCreateSnapshotMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateSnapshot{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateSnapshot{}, middleware.After) if 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 = addHTTPSignerV4Middleware(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 = addOpCreateSnapshotValidationMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateSnapshot(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 } return nil } func newServiceMetadataMiddleware_opCreateSnapshot(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "simspaceweaver", OperationName: "CreateSnapshot", } }