diff --git a/clients/client-simspaceweaver/src/commands/CreateSnapshotCommand.ts b/clients/client-simspaceweaver/src/commands/CreateSnapshotCommand.ts index 6211f8ce29ce..b0ef0f0ae4e4 100644 --- a/clients/client-simspaceweaver/src/commands/CreateSnapshotCommand.ts +++ b/clients/client-simspaceweaver/src/commands/CreateSnapshotCommand.ts @@ -101,7 +101,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __Met * const input = { // CreateSnapshotInput * Simulation: "STRING_VALUE", // required * Destination: { // S3Destination - * BucketName: "STRING_VALUE", + * BucketName: "STRING_VALUE", // required * ObjectKeyPrefix: "STRING_VALUE", * }, * }; diff --git a/clients/client-simspaceweaver/src/commands/DescribeSimulationCommand.ts b/clients/client-simspaceweaver/src/commands/DescribeSimulationCommand.ts index eae801b36b0b..3277f238c1d5 100644 --- a/clients/client-simspaceweaver/src/commands/DescribeSimulationCommand.ts +++ b/clients/client-simspaceweaver/src/commands/DescribeSimulationCommand.ts @@ -58,8 +58,8 @@ export interface DescribeSimulationCommandOutput extends DescribeSimulationOutpu * // Status: "STRING_VALUE", * // TargetStatus: "STRING_VALUE", * // SchemaS3Location: { // S3Location - * // BucketName: "STRING_VALUE", - * // ObjectKey: "STRING_VALUE", + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required * // }, * // SchemaError: "STRING_VALUE", * // LoggingConfiguration: { // LoggingConfiguration @@ -87,8 +87,8 @@ export interface DescribeSimulationCommandOutput extends DescribeSimulationOutpu * // }, * // MaximumDuration: "STRING_VALUE", * // SnapshotS3Location: { - * // BucketName: "STRING_VALUE", - * // ObjectKey: "STRING_VALUE", + * // BucketName: "STRING_VALUE", // required + * // ObjectKey: "STRING_VALUE", // required * // }, * // StartError: "STRING_VALUE", * // }; diff --git a/clients/client-simspaceweaver/src/commands/StartSimulationCommand.ts b/clients/client-simspaceweaver/src/commands/StartSimulationCommand.ts index 95e94d8c714e..9d97d40fd1fe 100644 --- a/clients/client-simspaceweaver/src/commands/StartSimulationCommand.ts +++ b/clients/client-simspaceweaver/src/commands/StartSimulationCommand.ts @@ -58,16 +58,16 @@ export interface StartSimulationCommandOutput extends StartSimulationOutput, __M * Description: "STRING_VALUE", * RoleArn: "STRING_VALUE", // required * SchemaS3Location: { // S3Location - * BucketName: "STRING_VALUE", - * ObjectKey: "STRING_VALUE", + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required * }, * MaximumDuration: "STRING_VALUE", * Tags: { // TagMap * "": "STRING_VALUE", * }, * SnapshotS3Location: { - * BucketName: "STRING_VALUE", - * ObjectKey: "STRING_VALUE", + * BucketName: "STRING_VALUE", // required + * ObjectKey: "STRING_VALUE", // required * }, * }; * const command = new StartSimulationCommand(input); diff --git a/clients/client-simspaceweaver/src/models/models_0.ts b/clients/client-simspaceweaver/src/models/models_0.ts index d0b53ed16a34..a66eb3d8017c 100644 --- a/clients/client-simspaceweaver/src/models/models_0.ts +++ b/clients/client-simspaceweaver/src/models/models_0.ts @@ -129,7 +129,7 @@ export interface S3Destination { * configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User * Guide.

*/ - BucketName?: string; + BucketName: string | undefined; /** * @public @@ -568,7 +568,7 @@ export interface S3Location { * configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User * Guide.

*/ - BucketName?: string; + BucketName: string | undefined; /** * @public @@ -577,7 +577,7 @@ export interface S3Location { * downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User * Guide.

*/ - ObjectKey?: string; + ObjectKey: string | undefined; } /** diff --git a/codegen/sdk-codegen/aws-models/simspaceweaver.json b/codegen/sdk-codegen/aws-models/simspaceweaver.json index 3f8be46b5351..5efb55bc1750 100644 --- a/codegen/sdk-codegen/aws-models/simspaceweaver.json +++ b/codegen/sdk-codegen/aws-models/simspaceweaver.json @@ -1,2791 +1,2798 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.simspaceweaver#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.simspaceweaver#AppPortMappings": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationAppPortMapping" - } - }, - "com.amazonaws.simspaceweaver#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.simspaceweaver#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.simspaceweaver#ClockStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#ClockTargetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup": { - "type": "structure", - "members": { - "LogGroupArn": { - "target": "com.amazonaws.simspaceweaver#LogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" - } - }, - "com.amazonaws.simspaceweaver#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.simspaceweaver#CreateSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#CreateSnapshotInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#CreateSnapshotOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create a snapshot", - "smithy.api#documentation": "

Creates a snapshot of the specified simulation. \n A snapshot is a file that contains simulation state data at a specific time.\n The state data saved in a snapshot includes entity data from the State Fabric, \n the simulation configuration specified in the schema, and the clock tick number. \n You can use the snapshot to initialize a new simulation. \n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.\n

\n

You specify a Destination when you create a snapshot.\n The Destination is the name of an Amazon S3 bucket and an optional\n ObjectKeyPrefix. The ObjectKeyPrefix is\n usually the name of a folder in the bucket. SimSpace Weaver creates a \n snapshot folder inside the Destination and \n places the snapshot file there.

\n

The snapshot file is an Amazon S3 object. It has an object key with the\n form: \n object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where:\n

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/createsnapshot", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#CreateSnapshotInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Destination": { - "target": "com.amazonaws.simspaceweaver#S3Destination", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.

\n

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.simspaceweaver#CreateSnapshotOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.simspaceweaver#DeleteApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DeleteAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DeleteAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete an app", - "smithy.api#documentation": "

Deletes the instance of the given custom app.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/deleteapp", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.simspaceweaver#DeleteAppInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "DomainName" - } - }, - "App": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#httpQuery": "app", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AppName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DeleteAppOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#DeleteSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DeleteSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DeleteSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to delete a simulation", - "smithy.api#documentation": "

Deletes all SimSpace Weaver resources assigned to the given simulation.

\n \n

Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete\n resources in other Amazon Web Services.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/deletesimulation", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.simspaceweaver#DeleteSimulationInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DeleteSimulationOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#DescribeApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DescribeAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DescribeAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to describe an app", - "smithy.api#documentation": "

Returns the state of the given custom app.

", - "smithy.api#http": { - "method": "GET", - "uri": "/describeapp", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#DescribeAppInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "DomainName" - } - }, - "App": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#httpQuery": "app", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AppName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DescribeAppOutput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

" - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", - "traits": { - "smithy.api#documentation": "

The current lifecycle state of the custom app.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired lifecycle state of the custom app.

" - } - }, - "LaunchOverrides": { - "target": "com.amazonaws.simspaceweaver#LaunchOverrides" - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the app.

" - } - }, - "EndpointInfo": { - "target": "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo", - "traits": { - "smithy.api#documentation": "

Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#DescribeSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#DescribeSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#DescribeSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to describe a simulation", - "smithy.api#documentation": "

Returns the current state of the given simulation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/describesimulation", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#DescribeSimulationInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#DescribeSimulationOutput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

" - } - }, - "ExecutionId": { - "target": "com.amazonaws.simspaceweaver#UUID", - "traits": { - "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" - } - }, - "Arn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" - } - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the simulation.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.simspaceweaver#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.simspaceweaver#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationStatus", - "traits": { - "smithy.api#documentation": "

The current lifecycle state of the simulation.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired lifecycle state of the simulation.

" - } - }, - "SchemaS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" - } - }, - "SchemaError": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#deprecated": { - "message": "SchemaError is no longer used, check StartError instead." - }, - "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if there is a problem with the simulation\n schema.

" - } - }, - "LoggingConfiguration": { - "target": "com.amazonaws.simspaceweaver#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

Settings that control how SimSpace Weaver handles your simulation log data.

" - } - }, - "LiveSimulationState": { - "target": "com.amazonaws.simspaceweaver#LiveSimulationState", - "traits": { - "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" - } - }, - "MaximumDuration": { - "target": "com.amazonaws.simspaceweaver#TimeToLiveString", - "traits": { - "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" - } - }, - "SnapshotS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location" - }, - "StartError": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.simspaceweaver#Domain": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "Lifecycle": { - "target": "com.amazonaws.simspaceweaver#LifecycleManagementStrategy", - "traits": { - "smithy.api#documentation": "

The type of lifecycle management for apps in the domain. Indicates whether apps in this\n domain are managed (SimSpace Weaver starts and stops the apps) or\n unmanaged (you must start and stop the apps).

\n

\n Lifecycle types\n

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of app instances that run the same executable app code and have the same\n launch options and commands.

\n

For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" - } - }, - "com.amazonaws.simspaceweaver#DomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#Domain" - } - }, - "com.amazonaws.simspaceweaver#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.simspaceweaver#LaunchCommandList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "com.amazonaws.simspaceweaver#LaunchOverrides": { - "type": "structure", - "members": { - "LaunchCommands": { - "target": "com.amazonaws.simspaceweaver#LaunchCommandList", - "traits": { - "smithy.api#documentation": "

App launch commands and command line parameters that override the launch command\n configured in the simulation schema.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options that apply when the app starts. These options override default behavior.

" - } - }, - "com.amazonaws.simspaceweaver#LifecycleManagementStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Unknown", - "name": "Unknown" - }, - { - "value": "PerWorker", - "name": "PerWorker" - }, - { - "value": "BySpatialSubdivision", - "name": "BySpatialSubdivision" - }, - { - "value": "ByRequest", - "name": "ByRequest" - } - ] - } - }, - "com.amazonaws.simspaceweaver#ListApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#ListAppsInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#ListAppsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list apps", - "smithy.api#documentation": "

Lists all custom apps or service apps for the given simulation and domain.

", - "smithy.api#http": { - "method": "GET", - "uri": "/listapps", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#ListAppsInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation that you want to list apps for.

", - "smithy.api#httpQuery": "simulation", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain that you want to list apps for.

", - "smithy.api#httpQuery": "domain" - } - }, - "MaxResults": { - "target": "com.amazonaws.simspaceweaver#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of apps to list.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListAppsOutput": { - "type": "structure", - "members": { - "Apps": { - "target": "com.amazonaws.simspaceweaver#SimulationAppList", - "traits": { - "smithy.api#documentation": "

The list of apps for the given simulation and domain.

" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListSimulations": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#ListSimulationsInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#ListSimulationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list simulations", - "smithy.api#documentation": "

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

", - "smithy.api#http": { - "method": "GET", - "uri": "/listsimulations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#ListSimulationsInput": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.simspaceweaver#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of simulations to list.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListSimulationsOutput": { - "type": "structure", - "members": { - "Simulations": { - "target": "com.amazonaws.simspaceweaver#SimulationList", - "traits": { - "smithy.api#documentation": "

The list of simulations.

" - } - }, - "NextToken": { - "target": "com.amazonaws.simspaceweaver#OptionalString", - "traits": { - "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list the tags for a resource", - "smithy.api#documentation": "

Lists all tags on a SimSpace Weaver resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.simspaceweaver#ListTagsForResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.simspaceweaver#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.simspaceweaver#TagMap", - "traits": { - "smithy.api#documentation": "

The list of tags for the resource.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#LiveSimulationState": { - "type": "structure", - "members": { - "Domains": { - "target": "com.amazonaws.simspaceweaver#DomainList", - "traits": { - "smithy.api#documentation": "

A list of domains for the simulation. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" - } - }, - "Clocks": { - "target": "com.amazonaws.simspaceweaver#SimulationClockList", - "traits": { - "smithy.api#documentation": "

A list of simulation clocks.

\n \n

At this time, a simulation has only one clock.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" - } - }, - "com.amazonaws.simspaceweaver#LogDestination": { - "type": "structure", - "members": { - "CloudWatchLogsLogGroup": { - "target": "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup", - "traits": { - "smithy.api#documentation": "

An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The location where SimSpace Weaver sends simulation log data.

" - } - }, - "com.amazonaws.simspaceweaver#LogDestinations": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#LogDestination" - } - }, - "com.amazonaws.simspaceweaver#LogGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" - } - }, - "com.amazonaws.simspaceweaver#LoggingConfiguration": { - "type": "structure", - "members": { - "Destinations": { - "target": "com.amazonaws.simspaceweaver#LogDestinations", - "traits": { - "smithy.api#documentation": "

A list of the locations where SimSpace Weaver sends simulation log data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The logging configuration for a simulation.

" - } - }, - "com.amazonaws.simspaceweaver#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - } - } - }, - "com.amazonaws.simspaceweaver#ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.simspaceweaver#ObjectKeyPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.simspaceweaver#OptionalString": { - "type": "string" - }, - "com.amazonaws.simspaceweaver#PortNumber": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.simspaceweaver#PositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.simspaceweaver#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.simspaceweaver#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):iam::(\\d{12})?:role\\/(.+)$" - } - }, - "com.amazonaws.simspaceweaver#S3Destination": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.simspaceweaver#BucketName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

" - } - }, - "ObjectKeyPrefix": { - "target": "com.amazonaws.simspaceweaver#ObjectKeyPrefix", - "traits": { - "smithy.api#documentation": "

A string prefix for an Amazon S3 object key. It's usually a folder name.\n For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders\n in the Amazon Simple Storage Service User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.

" - } - }, - "com.amazonaws.simspaceweaver#S3Location": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.simspaceweaver#BucketName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

" - } - }, - "ObjectKey": { - "target": "com.amazonaws.simspaceweaver#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object\n keys, see Uploading,\n downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User\n Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip\n files and schema file. For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" - } - }, - "com.amazonaws.simspaceweaver#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaver": { - "type": "service", - "version": "2022-10-28", - "operations": [ - { - "target": "com.amazonaws.simspaceweaver#ListTagsForResource" - }, - { - "target": "com.amazonaws.simspaceweaver#TagResource" - }, - { - "target": "com.amazonaws.simspaceweaver#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.simspaceweaver#Simulation" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "SimSpaceWeaver", - "arnNamespace": "simspaceweaver", - "cloudFormationName": "SimSpaceWeaver", - "endpointPrefix": "simspaceweaver", - "cloudTrailEventSource": "simspaceweaver.amazonaws.com" - }, - "aws.auth#sigv4": { - "name": "simspaceweaver" - }, - "aws.iam#defineConditionKeys": { - "aws:ResourceTag/${TagKey}": { - "type": "String", - "documentation": "Filters access by tags associated with the resource", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" - }, - "aws:RequestTag/${TagKey}": { - "type": "String", - "documentation": "Filters access by tags that are passed in the request", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" - }, - "aws:TagKeys": { - "type": "ArrayOfString", - "documentation": "Filters access by tag keys that are passed in the request", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" - } - }, - "aws.iam#supportedPrincipalTypes": [ - "Root", - "IAMUser", - "IAMRole", - "FederatedUser" - ], - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" - ] - }, - "smithy.api#documentation": "

SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale \n spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,\n crowd simulations with millions of people and objects, and massively multiplayer games with\n hundreds of thousands of connected players.\n For more information about SimSpace Weaver, see the \n SimSpace Weaver User Guide\n .

\n

This API reference describes the API operations and data types that you can use to\n communicate directly with SimSpace Weaver.

\n

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The\n SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This\n documentation is part of the SimSpace Weaver app SDK distributable package.

", - "smithy.api#title": "AWS SimSpace Weaver", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-north-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://simspaceweaver.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaverArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" - } - }, - "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" - } - }, - "com.amazonaws.simspaceweaver#Simulation": { - "type": "resource", - "identifiers": { - "SimulationName": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName" - } - }, - "create": { - "target": "com.amazonaws.simspaceweaver#StartSimulation" - }, - "read": { - "target": "com.amazonaws.simspaceweaver#DescribeSimulation" - }, - "update": { - "target": "com.amazonaws.simspaceweaver#StopSimulation" - }, - "delete": { - "target": "com.amazonaws.simspaceweaver#DeleteSimulation" - }, - "list": { - "target": "com.amazonaws.simspaceweaver#ListSimulations" - }, - "operations": [ - { - "target": "com.amazonaws.simspaceweaver#CreateSnapshot" - }, - { - "target": "com.amazonaws.simspaceweaver#DeleteApp" - }, - { - "target": "com.amazonaws.simspaceweaver#DescribeApp" - }, - { - "target": "com.amazonaws.simspaceweaver#ListApps" - }, - { - "target": "com.amazonaws.simspaceweaver#StartApp" - }, - { - "target": "com.amazonaws.simspaceweaver#StartClock" - }, - { - "target": "com.amazonaws.simspaceweaver#StopApp" - }, - { - "target": "com.amazonaws.simspaceweaver#StopClock" - } - ], - "traits": { - "aws.api#arn": { - "template": "simulation/{SimulationName}" - }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], - "aws.iam#disableConditionKeyInference": {}, - "smithy.api#documentation": "Represents a simulation" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the\n app starts.

" - } - }, - "IngressPortMappings": { - "target": "com.amazonaws.simspaceweaver#AppPortMappings", - "traits": { - "smithy.api#documentation": "

The inbound TCP/UDP port numbers of the app. The combination of an IP address and\n a port number form a network endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the network endpoint that you can use to connect to your custom or \n service app. For more information about SimSpace Weaver apps, see Key concepts: Apps \n in the SimSpace Weaver User Guide..

" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationAppMetadata" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppMetadata": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

" - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The domain of the app. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", - "traits": { - "smithy.api#documentation": "

The current status of the app.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired status of the app.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of metadata about the app.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppPortMapping": { - "type": "structure", - "members": { - "Declared": { - "target": "com.amazonaws.simspaceweaver#PortNumber", - "traits": { - "smithy.api#documentation": "

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps\n the Declared port to the Actual port. The source code for the\n app should bind to the Declared port.

" - } - }, - "Actual": { - "target": "com.amazonaws.simspaceweaver#PortNumber", - "traits": { - "smithy.api#documentation": "

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port\n number when the app starts. SimSpace Weaver maps the Declared port to the\n Actual port. Clients connect to the app using the app's IP address\n and the Actual port number.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of TCP/UDP ports for a custom or service app.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationAppStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - } - ] - } - }, - "com.amazonaws.simspaceweaver#SimulationAppTargetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#SimulationClock": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.simspaceweaver#ClockStatus", - "traits": { - "smithy.api#documentation": "

The current status of the simulation clock.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#ClockTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired status of the simulation clock.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Status information about the simulation clock.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationClockList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationClock" - } - }, - "com.amazonaws.simspaceweaver#SimulationList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#SimulationMetadata" - } - }, - "com.amazonaws.simspaceweaver#SimulationMetadata": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

" - } - }, - "Arn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.simspaceweaver#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" - } - }, - "Status": { - "target": "com.amazonaws.simspaceweaver#SimulationStatus", - "traits": { - "smithy.api#documentation": "

The current status of the simulation.

" - } - }, - "TargetStatus": { - "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", - "traits": { - "smithy.api#documentation": "

The desired status of the simulation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of data about the simulation.

" - } - }, - "com.amazonaws.simspaceweaver#SimulationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "SNAPSHOT_IN_PROGRESS", - "name": "SNAPSHOT_IN_PROGRESS" - } - ] - } - }, - "com.amazonaws.simspaceweaver#SimulationTargetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] - } - }, - "com.amazonaws.simspaceweaver#StartApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StartAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StartAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to start an app", - "smithy.api#documentation": "

Starts a custom app with the configuration specified in the simulation schema.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startapp", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StartAppInput": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.simspaceweaver#ClientToken", - "traits": { - "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", - "smithy.api#idempotencyToken": {} - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the app.

" - } - }, - "LaunchOverrides": { - "target": "com.amazonaws.simspaceweaver#LaunchOverrides" - } - } - }, - "com.amazonaws.simspaceweaver#StartAppOutput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

" - } - }, - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#StartClock": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StartClockInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StartClockOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to start a simulation clock", - "smithy.api#documentation": "

Starts the simulation clock.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startclock", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StartClockInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - } - } - }, - "com.amazonaws.simspaceweaver#StartClockOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#StartSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StartSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StartSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to start a simulation", - "aws.iam#conditionKeys": [ - "aws:TagKeys", - "aws:RequestTag/${TagKey}" - ], - "smithy.api#documentation": "

Starts a simulation with the given name. You must choose to start your\n simulation from a schema or from a snapshot.\n For more information about the schema, see the schema reference \n in the SimSpace Weaver User Guide.\n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startsimulation", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StartSimulationInput": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.simspaceweaver#ClientToken", - "traits": { - "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", - "smithy.api#idempotencyToken": {} - } - }, - "Name": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.simspaceweaver#Description", - "traits": { - "smithy.api#documentation": "

The description of the simulation.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.simspaceweaver#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

", - "smithy.api#required": {} - } - }, - "SchemaS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SchemaS3Location to start your simulation from a schema.

\n

If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

" - } - }, - "MaximumDuration": { - "target": "com.amazonaws.simspaceweaver#TimeToLiveString", - "traits": { - "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" - } - }, - "Tags": { - "target": "com.amazonaws.simspaceweaver#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

" - } - }, - "SnapshotS3Location": { - "target": "com.amazonaws.simspaceweaver#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SnapshotS3Location to start your simulation from a snapshot.

\n

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

\n

If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

" - } - } - } - }, - "com.amazonaws.simspaceweaver#StartSimulationOutput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" - } - }, - "ExecutionId": { - "target": "com.amazonaws.simspaceweaver#UUID", - "traits": { - "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.simspaceweaver#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" - } - } - } - }, - "com.amazonaws.simspaceweaver#StopApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StopAppInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StopAppOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to stop an app", - "smithy.api#documentation": "

Stops the given custom app and shuts down all of its allocated compute resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/stopapp", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StopAppInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" - } - }, - "Domain": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "DomainName" - } - }, - "App": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AppName" - } - } - } - }, - "com.amazonaws.simspaceweaver#StopAppOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#StopClock": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StopClockInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StopClockOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation clock", - "smithy.api#documentation": "

Stops the simulation clock.

", - "smithy.api#http": { - "method": "POST", - "uri": "/stopclock", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StopClockInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" + "smithy": "2.0", + "shapes": { + "com.amazonaws.simspaceweaver#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.simspaceweaver#AppPortMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationAppPortMapping" + } + }, + "com.amazonaws.simspaceweaver#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.simspaceweaver#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.simspaceweaver#ClockStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#ClockTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.simspaceweaver#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" + } + }, + "com.amazonaws.simspaceweaver#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.simspaceweaver#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#CreateSnapshotInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#CreateSnapshotOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a snapshot", + "smithy.api#documentation": "

Creates a snapshot of the specified simulation. \n A snapshot is a file that contains simulation state data at a specific time.\n The state data saved in a snapshot includes entity data from the State Fabric, \n the simulation configuration specified in the schema, and the clock tick number. \n You can use the snapshot to initialize a new simulation. \n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.\n

\n

You specify a Destination when you create a snapshot.\n The Destination is the name of an Amazon S3 bucket and an optional\n ObjectKeyPrefix. The ObjectKeyPrefix is\n usually the name of a folder in the bucket. SimSpace Weaver creates a \n snapshot folder inside the Destination and \n places the snapshot file there.

\n

The snapshot file is an Amazon S3 object. It has an object key with the\n form: \n object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where:\n

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/createsnapshot", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#CreateSnapshotInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Destination": { + "target": "com.amazonaws.simspaceweaver#S3Destination", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.

\n

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.simspaceweaver#CreateSnapshotOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.simspaceweaver#DeleteApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DeleteAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DeleteAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete an app", + "smithy.api#documentation": "

Deletes the instance of the given custom app.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/deleteapp", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.simspaceweaver#DeleteAppInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "DomainName" + } + }, + "App": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#httpQuery": "app", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AppName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DeleteAppOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#DeleteSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DeleteSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DeleteSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a simulation", + "smithy.api#documentation": "

Deletes all SimSpace Weaver resources assigned to the given simulation.

\n \n

Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete\n resources in other Amazon Web Services.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/deletesimulation", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.simspaceweaver#DeleteSimulationInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DeleteSimulationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#DescribeApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DescribeAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DescribeAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to describe an app", + "smithy.api#documentation": "

Returns the state of the given custom app.

", + "smithy.api#http": { + "method": "GET", + "uri": "/describeapp", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#DescribeAppInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "DomainName" + } + }, + "App": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#httpQuery": "app", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AppName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DescribeAppOutput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", + "traits": { + "smithy.api#documentation": "

The current lifecycle state of the custom app.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired lifecycle state of the custom app.

" + } + }, + "LaunchOverrides": { + "target": "com.amazonaws.simspaceweaver#LaunchOverrides" + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the app.

" + } + }, + "EndpointInfo": { + "target": "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo", + "traits": { + "smithy.api#documentation": "

Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#DescribeSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#DescribeSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#DescribeSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to describe a simulation", + "smithy.api#documentation": "

Returns the current state of the given simulation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/describesimulation", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#DescribeSimulationInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#DescribeSimulationOutput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

" + } + }, + "ExecutionId": { + "target": "com.amazonaws.simspaceweaver#UUID", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" + } + }, + "Arn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" + } + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the simulation.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.simspaceweaver#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.simspaceweaver#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationStatus", + "traits": { + "smithy.api#documentation": "

The current lifecycle state of the simulation.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired lifecycle state of the simulation.

" + } + }, + "SchemaS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" + } + }, + "SchemaError": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#deprecated": { + "message": "SchemaError is no longer used, check StartError instead." + }, + "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if there is a problem with the simulation\n schema.

" + } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.simspaceweaver#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Settings that control how SimSpace Weaver handles your simulation log data.

" + } + }, + "LiveSimulationState": { + "target": "com.amazonaws.simspaceweaver#LiveSimulationState", + "traits": { + "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" + } + }, + "MaximumDuration": { + "target": "com.amazonaws.simspaceweaver#TimeToLiveString", + "traits": { + "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" + } + }, + "SnapshotS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location" + }, + "StartError": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.simspaceweaver#Domain": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.simspaceweaver#LifecycleManagementStrategy", + "traits": { + "smithy.api#documentation": "

The type of lifecycle management for apps in the domain. Indicates whether apps in this\n domain are managed (SimSpace Weaver starts and stops the apps) or\n unmanaged (you must start and stop the apps).

\n

\n Lifecycle types\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of app instances that run the same executable app code and have the same\n launch options and commands.

\n

For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" + } + }, + "com.amazonaws.simspaceweaver#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#Domain" + } + }, + "com.amazonaws.simspaceweaver#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.simspaceweaver#LaunchCommandList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "com.amazonaws.simspaceweaver#LaunchOverrides": { + "type": "structure", + "members": { + "LaunchCommands": { + "target": "com.amazonaws.simspaceweaver#LaunchCommandList", + "traits": { + "smithy.api#documentation": "

App launch commands and command line parameters that override the launch command\n configured in the simulation schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options that apply when the app starts. These options override default behavior.

" + } + }, + "com.amazonaws.simspaceweaver#LifecycleManagementStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Unknown", + "name": "Unknown" + }, + { + "value": "PerWorker", + "name": "PerWorker" + }, + { + "value": "BySpatialSubdivision", + "name": "BySpatialSubdivision" + }, + { + "value": "ByRequest", + "name": "ByRequest" + } + ] + } + }, + "com.amazonaws.simspaceweaver#ListApps": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#ListAppsInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#ListAppsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list apps", + "smithy.api#documentation": "

Lists all custom apps or service apps for the given simulation and domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/listapps", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#ListAppsInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation that you want to list apps for.

", + "smithy.api#httpQuery": "simulation", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain that you want to list apps for.

", + "smithy.api#httpQuery": "domain" + } + }, + "MaxResults": { + "target": "com.amazonaws.simspaceweaver#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of apps to list.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListAppsOutput": { + "type": "structure", + "members": { + "Apps": { + "target": "com.amazonaws.simspaceweaver#SimulationAppList", + "traits": { + "smithy.api#documentation": "

The list of apps for the given simulation and domain.

" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListSimulations": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#ListSimulationsInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#ListSimulationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list simulations", + "smithy.api#documentation": "

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

", + "smithy.api#http": { + "method": "GET", + "uri": "/listsimulations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#ListSimulationsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.simspaceweaver#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of simulations to list.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListSimulationsOutput": { + "type": "structure", + "members": { + "Simulations": { + "target": "com.amazonaws.simspaceweaver#SimulationList", + "traits": { + "smithy.api#documentation": "

The list of simulations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.simspaceweaver#OptionalString", + "traits": { + "smithy.api#documentation": "

If SimSpace Weaver returns nextToken, then there are more results available. \n The value of nextToken is a unique pagination token for each page. To retrieve the next page, \n call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, \n then nextToken is set to null. Each pagination token expires after 24 hours. \n If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list the tags for a resource", + "smithy.api#documentation": "

Lists all tags on a SimSpace Weaver resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.simspaceweaver#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.simspaceweaver#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.simspaceweaver#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tags for the resource.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#LiveSimulationState": { + "type": "structure", + "members": { + "Domains": { + "target": "com.amazonaws.simspaceweaver#DomainList", + "traits": { + "smithy.api#documentation": "

A list of domains for the simulation. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" + } + }, + "Clocks": { + "target": "com.amazonaws.simspaceweaver#SimulationClockList", + "traits": { + "smithy.api#documentation": "

A list of simulation clocks.

\n \n

At this time, a simulation has only one clock.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of additional state information, such as \ndomain and clock configuration.

" + } + }, + "com.amazonaws.simspaceweaver#LogDestination": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroup": { + "target": "com.amazonaws.simspaceweaver#CloudWatchLogsLogGroup", + "traits": { + "smithy.api#documentation": "

An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log\n groups and log streams in the Amazon CloudWatch Logs User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location where SimSpace Weaver sends simulation log data.

" + } + }, + "com.amazonaws.simspaceweaver#LogDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#LogDestination" + } + }, + "com.amazonaws.simspaceweaver#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" + } + }, + "com.amazonaws.simspaceweaver#LoggingConfiguration": { + "type": "structure", + "members": { + "Destinations": { + "target": "com.amazonaws.simspaceweaver#LogDestinations", + "traits": { + "smithy.api#documentation": "

A list of the locations where SimSpace Weaver sends simulation log data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration for a simulation.

" + } + }, + "com.amazonaws.simspaceweaver#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.simspaceweaver#ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.simspaceweaver#ObjectKeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.simspaceweaver#OptionalString": { + "type": "string" + }, + "com.amazonaws.simspaceweaver#PortNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.simspaceweaver#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.simspaceweaver#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.simspaceweaver#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):iam::(\\d{12})?:role\\/(.+)$" + } + }, + "com.amazonaws.simspaceweaver#S3Destination": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.simspaceweaver#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

", + "smithy.api#required": {} + } + }, + "ObjectKeyPrefix": { + "target": "com.amazonaws.simspaceweaver#ObjectKeyPrefix", + "traits": { + "smithy.api#documentation": "

A string prefix for an Amazon S3 object key. It's usually a folder name.\n For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders\n in the Amazon Simple Storage Service User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.

" + } + }, + "com.amazonaws.simspaceweaver#S3Location": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.simspaceweaver#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket. For more information about buckets, see Creating,\n configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User\n Guide.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.simspaceweaver#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object\n keys, see Uploading,\n downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User\n Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip\n files and schema file. For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

" + } + }, + "com.amazonaws.simspaceweaver#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaver": { + "type": "service", + "version": "2022-10-28", + "operations": [ + { + "target": "com.amazonaws.simspaceweaver#ListTagsForResource" + }, + { + "target": "com.amazonaws.simspaceweaver#TagResource" + }, + { + "target": "com.amazonaws.simspaceweaver#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.simspaceweaver#Simulation" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SimSpaceWeaver", + "arnNamespace": "simspaceweaver", + "cloudFormationName": "SimSpaceWeaver", + "endpointPrefix": "simspaceweaver", + "cloudTrailEventSource": "simspaceweaver.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "simspaceweaver" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" + ] + }, + "smithy.api#documentation": "

SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale \n spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,\n crowd simulations with millions of people and objects, and massively multiplayer games with\n hundreds of thousands of connected players.\n For more information about SimSpace Weaver, see the \n SimSpace Weaver User Guide\n .

\n

This API reference describes the API operations and data types that you can use to\n communicate directly with SimSpace Weaver.

\n

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The\n SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This\n documentation is part of the SimSpace Weaver app SDK distributable package.

", + "smithy.api#title": "AWS SimSpace Weaver", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" } + ] } - } - }, - "com.amazonaws.simspaceweaver#StopClockOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#StopSimulation": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#StopSimulationInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#StopSimulationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#AccessDeniedException" - }, - { - "target": "com.amazonaws.simspaceweaver#ConflictException" - }, - { - "target": "com.amazonaws.simspaceweaver#InternalServerException" - }, - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, + ], + "type": "tree", + "rules": [ { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation", - "smithy.api#documentation": "

Stops the given simulation.

\n \n

You can't restart a simulation after you stop it. If you want to restart a simulation, then\n you must stop it, delete it, and start a new instance of it.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/stopsimulation", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#StopSimulationInput": { - "type": "structure", - "members": { - "Simulation": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", - "traits": { - "smithy.api#documentation": "

The name of the simulation.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "SimulationName" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] } - } - } - }, - "com.amazonaws.simspaceweaver#StopSimulationOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.simspaceweaver#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.simspaceweaver#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.simspaceweaver#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.simspaceweaver#TagKey" - }, - "value": { - "target": "com.amazonaws.simspaceweaver#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.simspaceweaver#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.simspaceweaver#TooManyTagsException" + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to tag a resource", - "aws.iam#conditionKeys": [ - "aws:TagKeys", - "aws:RequestTag/${TagKey}" - ], - "smithy.api#documentation": "

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#TagResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to add tags to.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.simspaceweaver#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags to apply to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "aws.api#data": "tagging", - "smithy.api#references": [ + "conditions": [], + "type": "tree", + "rules": [ { - "resource": "com.amazonaws.simspaceweaver#Simulation", - "ids": { - "SimulationName": "ResourceArn" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - ] - } - }, - "com.amazonaws.simspaceweaver#TagResourceOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.simspaceweaver#TimeToLiveString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 6 - }, - "smithy.api#pattern": "^\\d{1,5}[mhdMHD]$" - } - }, - "com.amazonaws.simspaceweaver#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.simspaceweaver#TooManyTagsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" + ] } + ] }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.simspaceweaver#UUID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36 - }, - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.simspaceweaver#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.simspaceweaver#UntagResourceInput" - }, - "output": { - "target": "com.amazonaws.simspaceweaver#UntagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" - }, + { + "conditions": [], + "type": "tree", + "rules": [ { - "target": "com.amazonaws.simspaceweaver#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to untag a resource", - "aws.iam#conditionKeys": [ - "aws:TagKeys" - ], - "smithy.api#documentation": "

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.simspaceweaver#UntagResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.simspaceweaver#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "aws.api#data": "tagging", - "smithy.api#references": [ + "conditions": [ { - "resource": "com.amazonaws.simspaceweaver#Simulation", - "ids": { - "SimulationName": "ResourceArn" + "fn": "isSet", + "argv": [ + { + "ref": "Region" } + ] } - ] - } - }, - "com.amazonaws.simspaceweaver#UntagResourceOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.simspaceweaver#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.simspaceweaver#NonEmptyString" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://simspaceweaver.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://simspaceweaver.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaverArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1600 + }, + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.simspaceweaver#Simulation": { + "type": "resource", + "identifiers": { + "SimulationName": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName" + } + }, + "create": { + "target": "com.amazonaws.simspaceweaver#StartSimulation" + }, + "read": { + "target": "com.amazonaws.simspaceweaver#DescribeSimulation" + }, + "update": { + "target": "com.amazonaws.simspaceweaver#StopSimulation" + }, + "delete": { + "target": "com.amazonaws.simspaceweaver#DeleteSimulation" + }, + "list": { + "target": "com.amazonaws.simspaceweaver#ListSimulations" + }, + "operations": [ + { + "target": "com.amazonaws.simspaceweaver#CreateSnapshot" + }, + { + "target": "com.amazonaws.simspaceweaver#DeleteApp" + }, + { + "target": "com.amazonaws.simspaceweaver#DescribeApp" + }, + { + "target": "com.amazonaws.simspaceweaver#ListApps" + }, + { + "target": "com.amazonaws.simspaceweaver#StartApp" + }, + { + "target": "com.amazonaws.simspaceweaver#StartClock" + }, + { + "target": "com.amazonaws.simspaceweaver#StopApp" + }, + { + "target": "com.amazonaws.simspaceweaver#StopClock" + } + ], + "traits": { + "aws.api#arn": { + "template": "simulation/{SimulationName}" + }, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents a simulation" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppEndpointInfo": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the\n app starts.

" + } + }, + "IngressPortMappings": { + "target": "com.amazonaws.simspaceweaver#AppPortMappings", + "traits": { + "smithy.api#documentation": "

The inbound TCP/UDP port numbers of the app. The combination of an IP address and\n a port number form a network endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the network endpoint that you can use to connect to your custom or \n service app. For more information about SimSpace Weaver apps, see Key concepts: Apps \n in the SimSpace Weaver User Guide..

" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationAppMetadata" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppMetadata": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The domain of the app. For more information about domains, see Key concepts: Domains\n in the SimSpace Weaver User Guide.

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationAppStatus", + "traits": { + "smithy.api#documentation": "

The current status of the app.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationAppTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired status of the app.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of metadata about the app.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppPortMapping": { + "type": "structure", + "members": { + "Declared": { + "target": "com.amazonaws.simspaceweaver#PortNumber", + "traits": { + "smithy.api#documentation": "

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps\n the Declared port to the Actual port. The source code for the\n app should bind to the Declared port.

" + } + }, + "Actual": { + "target": "com.amazonaws.simspaceweaver#PortNumber", + "traits": { + "smithy.api#documentation": "

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port\n number when the app starts. SimSpace Weaver maps the Declared port to the\n Actual port. Clients connect to the app using the app's IP address\n and the Actual port number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of TCP/UDP ports for a custom or service app.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationAppStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.simspaceweaver#SimulationAppTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#SimulationClock": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.simspaceweaver#ClockStatus", + "traits": { + "smithy.api#documentation": "

The current status of the simulation clock.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#ClockTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired status of the simulation clock.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Status information about the simulation clock.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationClockList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationClock" + } + }, + "com.amazonaws.simspaceweaver#SimulationList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#SimulationMetadata" + } + }, + "com.amazonaws.simspaceweaver#SimulationMetadata": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

" + } + }, + "Arn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.simspaceweaver#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" + } + }, + "Status": { + "target": "com.amazonaws.simspaceweaver#SimulationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the simulation.

" + } + }, + "TargetStatus": { + "target": "com.amazonaws.simspaceweaver#SimulationTargetStatus", + "traits": { + "smithy.api#documentation": "

The desired status of the simulation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of data about the simulation.

" + } + }, + "com.amazonaws.simspaceweaver#SimulationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "SNAPSHOT_IN_PROGRESS", + "name": "SNAPSHOT_IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.simspaceweaver#SimulationTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.simspaceweaver#StartApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StartAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StartAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start an app", + "smithy.api#documentation": "

Starts a custom app with the configuration specified in the simulation schema.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startapp", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StartAppInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.simspaceweaver#ClientToken", + "traits": { + "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", + "smithy.api#idempotencyToken": {} + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the app.

" + } + }, + "LaunchOverrides": { + "target": "com.amazonaws.simspaceweaver#LaunchOverrides" + } + } + }, + "com.amazonaws.simspaceweaver#StartAppOutput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

" + } + }, + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#StartClock": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StartClockInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StartClockOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a simulation clock", + "smithy.api#documentation": "

Starts the simulation clock.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startclock", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StartClockInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StartClockOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#StartSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StartSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StartSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a simulation", + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

Starts a simulation with the given name. You must choose to start your\n simulation from a schema or from a snapshot.\n For more information about the schema, see the schema reference \n in the SimSpace Weaver User Guide.\n For more information about snapshots, see Snapshots\n in the SimSpace Weaver User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startsimulation", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StartSimulationInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.simspaceweaver#ClientToken", + "traits": { + "smithy.api#documentation": "

A value that you provide to ensure that repeated calls to this\n API operation using the same parameters complete only once. A ClientToken is also known as an\n idempotency token. A ClientToken expires after 24 hours.

", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.simspaceweaver#Description", + "traits": { + "smithy.api#documentation": "

The description of the simulation.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.simspaceweaver#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference. For more information about IAM roles,\n see IAM roles in the \n Identity and Access Management User Guide.

", + "smithy.api#required": {} + } + }, + "SchemaS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SchemaS3Location to start your simulation from a schema.

\n

If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

" + } + }, + "MaximumDuration": { + "target": "com.amazonaws.simspaceweaver#TimeToLiveString", + "traits": { + "smithy.api#documentation": "

The maximum running time of the simulation,\n specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation \n stops when it reaches this limit. The maximum value is 14D, or its equivalent in the \n other units. The default value is 14D. A value equivalent to 0 makes the\n simulation immediately transition to Stopping as soon as it reaches Started.

" + } + }, + "Tags": { + "target": "com.amazonaws.simspaceweaver#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

" + } + }, + "SnapshotS3Location": { + "target": "com.amazonaws.simspaceweaver#S3Location", + "traits": { + "smithy.api#documentation": "

The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .

\n

Provide a SnapshotS3Location to start your simulation from a snapshot.

\n

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

\n

If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

" + } + } + } + }, + "com.amazonaws.simspaceweaver#StartSimulationOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

" + } + }, + "ExecutionId": { + "target": "com.amazonaws.simspaceweaver#UUID", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) for this simulation.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.simspaceweaver#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the simulation was created, expressed as the \n number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

" + } + } + } + }, + "com.amazonaws.simspaceweaver#StopApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StopAppInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StopAppOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop an app", + "smithy.api#documentation": "

Stops the given custom app and shuts down all of its allocated compute resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/stopapp", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StopAppInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + }, + "Domain": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "DomainName" + } + }, + "App": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AppName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StopAppOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#StopClock": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StopClockInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StopClockOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation clock", + "smithy.api#documentation": "

Stops the simulation clock.

", + "smithy.api#http": { + "method": "POST", + "uri": "/stopclock", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StopClockInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StopClockOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#StopSimulation": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#StopSimulationInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#StopSimulationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#AccessDeniedException" + }, + { + "target": "com.amazonaws.simspaceweaver#ConflictException" + }, + { + "target": "com.amazonaws.simspaceweaver#InternalServerException" + }, + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to stop a simulation", + "smithy.api#documentation": "

Stops the given simulation.

\n \n

You can't restart a simulation after you stop it. If you want to restart a simulation, then\n you must stop it, delete it, and start a new instance of it.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/stopsimulation", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#StopSimulationInput": { + "type": "structure", + "members": { + "Simulation": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverResourceName", + "traits": { + "smithy.api#documentation": "

The name of the simulation.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "SimulationName" + } + } + } + }, + "com.amazonaws.simspaceweaver#StopSimulationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.simspaceweaver#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.simspaceweaver#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.simspaceweaver#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.simspaceweaver#TagKey" + }, + "value": { + "target": "com.amazonaws.simspaceweaver#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.simspaceweaver#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#TooManyTagsException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to tag a resource", + "aws.iam#conditionKeys": ["aws:TagKeys", "aws:RequestTag/${TagKey}"], + "smithy.api#documentation": "

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to add tags to.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.simspaceweaver#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.simspaceweaver#Simulation", + "ids": { + "SimulationName": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.simspaceweaver#TagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.simspaceweaver#TimeToLiveString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 6 + }, + "smithy.api#pattern": "^\\d{1,5}[mhdMHD]$" + } + }, + "com.amazonaws.simspaceweaver#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.simspaceweaver#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.simspaceweaver#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.simspaceweaver#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.simspaceweaver#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.simspaceweaver#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.simspaceweaver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.simspaceweaver#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to untag a resource", + "aws.iam#conditionKeys": ["aws:TagKeys"], + "smithy.api#documentation": "

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.simspaceweaver#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.simspaceweaver#SimSpaceWeaverArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.\n For more information about ARNs, see Amazon Resource Names (ARNs)\n in the Amazon Web Services General Reference.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.simspaceweaver#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.simspaceweaver#Simulation", + "ids": { + "SimulationName": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.simspaceweaver#UntagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.simspaceweaver#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.simspaceweaver#NonEmptyString" } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } } -} \ No newline at end of file + } +}