simspaceweaver

package
v1.44.188 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 26, 2023 License: Apache-2.0 Imports: 10 Imported by: 8

Documentation

Overview

Package simspaceweaver provides the client and types for making API requests to AWS SimSpace Weaver.

Amazon Web Services SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city, crowd simulations with millions of people and objects, and massilvely-multiplayer games with hundreds of thousands of connected players. For more information about SimSpace Weaver, see the Amazon Web Services SimSpace Weaver User Guide (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/) .

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

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

See https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28 for more information on this service.

See simspaceweaver package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/simspaceweaver/

Using the Client

To contact AWS SimSpace Weaver with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS SimSpace Weaver client SimSpaceWeaver for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/simspaceweaver/#New

Index

Constants

View Source 
const (
	// ClockStatusUnknown is a ClockStatus enum value
	ClockStatusUnknown = "UNKNOWN"

	// ClockStatusStarting is a ClockStatus enum value
	ClockStatusStarting = "STARTING"

	// ClockStatusStarted is a ClockStatus enum value
	ClockStatusStarted = "STARTED"

	// ClockStatusStopping is a ClockStatus enum value
	ClockStatusStopping = "STOPPING"

	// ClockStatusStopped is a ClockStatus enum value
	ClockStatusStopped = "STOPPED"
)
View Source 
const (
	// ClockTargetStatusUnknown is a ClockTargetStatus enum value
	ClockTargetStatusUnknown = "UNKNOWN"

	// ClockTargetStatusStarted is a ClockTargetStatus enum value
	ClockTargetStatusStarted = "STARTED"

	// ClockTargetStatusStopped is a ClockTargetStatus enum value
	ClockTargetStatusStopped = "STOPPED"
)
View Source 
const (
	// LifecycleManagementStrategyUnknown is a LifecycleManagementStrategy enum value
	LifecycleManagementStrategyUnknown = "Unknown"

	// LifecycleManagementStrategyPerWorker is a LifecycleManagementStrategy enum value
	LifecycleManagementStrategyPerWorker = "PerWorker"

	// LifecycleManagementStrategyBySpatialSubdivision is a LifecycleManagementStrategy enum value
	LifecycleManagementStrategyBySpatialSubdivision = "BySpatialSubdivision"

	// LifecycleManagementStrategyByRequest is a LifecycleManagementStrategy enum value
	LifecycleManagementStrategyByRequest = "ByRequest"
)
View Source 
const (
	// SimulationAppStatusStarting is a SimulationAppStatus enum value
	SimulationAppStatusStarting = "STARTING"

	// SimulationAppStatusStarted is a SimulationAppStatus enum value
	SimulationAppStatusStarted = "STARTED"

	// SimulationAppStatusStopping is a SimulationAppStatus enum value
	SimulationAppStatusStopping = "STOPPING"

	// SimulationAppStatusStopped is a SimulationAppStatus enum value
	SimulationAppStatusStopped = "STOPPED"

	// SimulationAppStatusError is a SimulationAppStatus enum value
	SimulationAppStatusError = "ERROR"

	// SimulationAppStatusUnknown is a SimulationAppStatus enum value
	SimulationAppStatusUnknown = "UNKNOWN"
)
View Source 
const (
	// SimulationAppTargetStatusUnknown is a SimulationAppTargetStatus enum value
	SimulationAppTargetStatusUnknown = "UNKNOWN"

	// SimulationAppTargetStatusStarted is a SimulationAppTargetStatus enum value
	SimulationAppTargetStatusStarted = "STARTED"

	// SimulationAppTargetStatusStopped is a SimulationAppTargetStatus enum value
	SimulationAppTargetStatusStopped = "STOPPED"
)
View Source 
const (
	// SimulationStatusUnknown is a SimulationStatus enum value
	SimulationStatusUnknown = "UNKNOWN"

	// SimulationStatusStarting is a SimulationStatus enum value
	SimulationStatusStarting = "STARTING"

	// SimulationStatusStarted is a SimulationStatus enum value
	SimulationStatusStarted = "STARTED"

	// SimulationStatusStopping is a SimulationStatus enum value
	SimulationStatusStopping = "STOPPING"

	// SimulationStatusStopped is a SimulationStatus enum value
	SimulationStatusStopped = "STOPPED"

	// SimulationStatusFailed is a SimulationStatus enum value
	SimulationStatusFailed = "FAILED"

	// SimulationStatusDeleting is a SimulationStatus enum value
	SimulationStatusDeleting = "DELETING"

	// SimulationStatusDeleted is a SimulationStatus enum value
	SimulationStatusDeleted = "DELETED"
)
View Source 
const (
	// SimulationTargetStatusUnknown is a SimulationTargetStatus enum value
	SimulationTargetStatusUnknown = "UNKNOWN"

	// SimulationTargetStatusStarted is a SimulationTargetStatus enum value
	SimulationTargetStatusStarted = "STARTED"

	// SimulationTargetStatusStopped is a SimulationTargetStatus enum value
	SimulationTargetStatusStopped = "STOPPED"

	// SimulationTargetStatusDeleted is a SimulationTargetStatus enum value
	SimulationTargetStatusDeleted = "DELETED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "SimSpaceWeaver" // Name of service.
	EndpointsID = "simspaceweaver" // ID to lookup a service endpoint with.
	ServiceID   = "SimSpaceWeaver" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ClockStatus_Values 

func ClockStatus_Values() []string

ClockStatus_Values returns all elements of the ClockStatus enum

func ClockTargetStatus_Values 

func ClockTargetStatus_Values() []string

ClockTargetStatus_Values returns all elements of the ClockTargetStatus enum

func LifecycleManagementStrategy_Values 

func LifecycleManagementStrategy_Values() []string

LifecycleManagementStrategy_Values returns all elements of the LifecycleManagementStrategy enum

func SimulationAppStatus_Values 

func SimulationAppStatus_Values() []string

SimulationAppStatus_Values returns all elements of the SimulationAppStatus enum

func SimulationAppTargetStatus_Values 

func SimulationAppTargetStatus_Values() []string

SimulationAppTargetStatus_Values returns all elements of the SimulationAppTargetStatus enum

func SimulationStatus_Values 

func SimulationStatus_Values() []string

SimulationStatus_Values returns all elements of the SimulationStatus enum

func SimulationTargetStatus_Values 

func SimulationTargetStatus_Values() []string

SimulationTargetStatus_Values returns all elements of the SimulationTargetStatus enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchLogsLogGroup 

type CloudWatchLogsLogGroup struct {

	// The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for
	// the simulation. For more information about ARNs, see Amazon Resource Names
	// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference. For more information about
	// log groups, see Working with log groups and log streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html)
	// in the Amazon CloudWatch Logs User Guide.
	LogGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log groups and log streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) in the Amazon CloudWatch Logs User Guide.

func (CloudWatchLogsLogGroup) GoString 

func (s CloudWatchLogsLogGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchLogsLogGroup) SetLogGroupArn 

func (s *CloudWatchLogsLogGroup) SetLogGroupArn(v string) *CloudWatchLogsLogGroup

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudWatchLogsLogGroup) String 

func (s CloudWatchLogsLogGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAppInput 

type DeleteAppInput struct {

	// The name of the app.
	//
	// App is a required field
	App *string `location:"querystring" locationName:"app" min:"1" type:"string" required:"true"`

	// The name of the domain of the app.
	//
	// Domain is a required field
	Domain *string `location:"querystring" locationName:"domain" min:"1" type:"string" required:"true"`

	// The name of the simulation of the app.
	//
	// Simulation is a required field
	Simulation *string `location:"querystring" locationName:"simulation" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAppInput) GoString 

func (s DeleteAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInput) SetApp 

func (s *DeleteAppInput) SetApp(v string) *DeleteAppInput

SetApp sets the App field's value.

func (*DeleteAppInput) SetDomain 

func (s *DeleteAppInput) SetDomain(v string) *DeleteAppInput

SetDomain sets the Domain field's value.

func (*DeleteAppInput) SetSimulation 

func (s *DeleteAppInput) SetSimulation(v string) *DeleteAppInput

SetSimulation sets the Simulation field's value.

func (DeleteAppInput) String 

func (s DeleteAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppInput) Validate 

func (s *DeleteAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAppOutput 

type DeleteAppOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAppOutput) GoString 

func (s DeleteAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAppOutput) String 

func (s DeleteAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSimulationInput 

type DeleteSimulationInput struct {

	// The name of the simulation.
	//
	// Simulation is a required field
	Simulation *string `location:"querystring" locationName:"simulation" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSimulationInput) GoString 

func (s DeleteSimulationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSimulationInput) SetSimulation 

func (s *DeleteSimulationInput) SetSimulation(v string) *DeleteSimulationInput

SetSimulation sets the Simulation field's value.

func (DeleteSimulationInput) String 

func (s DeleteSimulationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSimulationInput) Validate 

func (s *DeleteSimulationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSimulationOutput 

type DeleteSimulationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSimulationOutput) GoString 

func (s DeleteSimulationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSimulationOutput) String 

func (s DeleteSimulationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAppInput 

type DescribeAppInput struct {

	// The name of the app.
	//
	// App is a required field
	App *string `location:"querystring" locationName:"app" min:"1" type:"string" required:"true"`

	// The name of the domain of the app.
	//
	// Domain is a required field
	Domain *string `location:"querystring" locationName:"domain" min:"1" type:"string" required:"true"`

	// The name of the simulation of the app.
	//
	// Simulation is a required field
	Simulation *string `location:"querystring" locationName:"simulation" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAppInput) GoString 

func (s DescribeAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInput) SetApp 

func (s *DescribeAppInput) SetApp(v string) *DescribeAppInput

SetApp sets the App field's value.

func (*DescribeAppInput) SetDomain 

func (s *DescribeAppInput) SetDomain(v string) *DescribeAppInput

SetDomain sets the Domain field's value.

func (*DescribeAppInput) SetSimulation 

func (s *DescribeAppInput) SetSimulation(v string) *DescribeAppInput

SetSimulation sets the Simulation field's value.

func (DescribeAppInput) String 

func (s DescribeAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppInput) Validate 

func (s *DescribeAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAppOutput 

type DescribeAppOutput struct {

	// The description of the app.
	Description *string `type:"string"`

	// The name of the domain of the app.
	Domain *string `min:"1" type:"string"`

	// Information about the network endpoint for the custom app. You can use the
	// endpoint to connect to the custom app.
	EndpointInfo *SimulationAppEndpointInfo `type:"structure"`

	// Options that apply when the app starts. These optiAons override default behavior.
	LaunchOverrides *LaunchOverrides `type:"structure"`

	// The name of the app.
	Name *string `min:"1" type:"string"`

	// The name of the simulation of the app.
	Simulation *string `min:"1" type:"string"`

	// The current lifecycle state of the custom app.
	Status *string `type:"string" enum:"SimulationAppStatus"`

	// The desired lifecycle state of the custom app.
	TargetStatus *string `type:"string" enum:"SimulationAppTargetStatus"`
	// contains filtered or unexported fields
}

func (DescribeAppOutput) GoString 

func (s DescribeAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAppOutput) SetDescription 

func (s *DescribeAppOutput) SetDescription(v string) *DescribeAppOutput

SetDescription sets the Description field's value.

func (*DescribeAppOutput) SetDomain 

func (s *DescribeAppOutput) SetDomain(v string) *DescribeAppOutput

SetDomain sets the Domain field's value.

func (*DescribeAppOutput) SetEndpointInfo 

func (s *DescribeAppOutput) SetEndpointInfo(v *SimulationAppEndpointInfo) *DescribeAppOutput

SetEndpointInfo sets the EndpointInfo field's value.

func (*DescribeAppOutput) SetLaunchOverrides 

func (s *DescribeAppOutput) SetLaunchOverrides(v *LaunchOverrides) *DescribeAppOutput

SetLaunchOverrides sets the LaunchOverrides field's value.

func (*DescribeAppOutput) SetName 

func (s *DescribeAppOutput) SetName(v string) *DescribeAppOutput

SetName sets the Name field's value.

func (*DescribeAppOutput) SetSimulation 

func (s *DescribeAppOutput) SetSimulation(v string) *DescribeAppOutput

SetSimulation sets the Simulation field's value.

func (*DescribeAppOutput) SetStatus 

func (s *DescribeAppOutput) SetStatus(v string) *DescribeAppOutput

SetStatus sets the Status field's value.

func (*DescribeAppOutput) SetTargetStatus 

func (s *DescribeAppOutput) SetTargetStatus(v string) *DescribeAppOutput

SetTargetStatus sets the TargetStatus field's value.

func (DescribeAppOutput) String 

func (s DescribeAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSimulationInput 

type DescribeSimulationInput struct {

	// The name of the simulation.
	//
	// Simulation is a required field
	Simulation *string `location:"querystring" locationName:"simulation" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSimulationInput) GoString 

func (s DescribeSimulationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSimulationInput) SetSimulation 

func (s *DescribeSimulationInput) SetSimulation(v string) *DescribeSimulationInput

SetSimulation sets the Simulation field's value.

func (DescribeSimulationInput) String 

func (s DescribeSimulationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSimulationInput) Validate 

func (s *DescribeSimulationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSimulationOutput 

type DescribeSimulationOutput struct {

	// The Amazon Resource Name (ARN) of the simulation. For more information about
	// ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string `type:"string"`

	// The time when the simulation was created, expressed as the number of seconds
	// and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
	CreationTime *time.Time `type:"timestamp"`

	// The description of the simulation.
	Description *string `type:"string"`

	// A universally unique identifier (UUID) for this simulation.
	ExecutionId *string `min:"36" type:"string"`

	// A collection of additional state information, such as domain and clock configuration.
	LiveSimulationState *LiveSimulationState `type:"structure"`

	// Settings that control how SimSpace Weaver handles your simulation log data.
	LoggingConfiguration *LoggingConfiguration `type:"structure"`

	// The maximum running time of the simulation, specified as a number of months
	// (m or M), hours (h or H), or days (d or D). The simulation stops when it
	// reaches this limit.
	MaximumDuration *string `min:"2" type:"string"`

	// The name of the simulation.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role that the simulation assumes to perform actions. For more information
	// about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference. For more information about
	// IAM roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
	// in the Identity and Access Management User Guide.
	RoleArn *string `type:"string"`

	// An error message that SimSpace Weaver returns only if there is a problem
	// with the simulation schema.
	SchemaError *string `type:"string"`

	// The location of the simulation schema in Amazon Simple Storage Service (Amazon
	// S3). For more information about Amazon S3, see the Amazon Simple Storage
	// Service User Guide (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).
	SchemaS3Location *S3Location `type:"structure"`

	// The current lifecycle state of the simulation.
	Status *string `type:"string" enum:"SimulationStatus"`

	// The desired lifecycle state of the simulation.
	TargetStatus *string `type:"string" enum:"SimulationTargetStatus"`
	// contains filtered or unexported fields
}

func (DescribeSimulationOutput) GoString 

func (s DescribeSimulationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSimulationOutput) SetArn 

func (s *DescribeSimulationOutput) SetArn(v string) *DescribeSimulationOutput

SetArn sets the Arn field's value.

func (*DescribeSimulationOutput) SetCreationTime 

func (s *DescribeSimulationOutput) SetCreationTime(v time.Time) *DescribeSimulationOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeSimulationOutput) SetDescription 

func (s *DescribeSimulationOutput) SetDescription(v string) *DescribeSimulationOutput

SetDescription sets the Description field's value.

func (*DescribeSimulationOutput) SetExecutionId 

func (s *DescribeSimulationOutput) SetExecutionId(v string) *DescribeSimulationOutput

SetExecutionId sets the ExecutionId field's value.

func (*DescribeSimulationOutput) SetLiveSimulationState 

func (s *DescribeSimulationOutput) SetLiveSimulationState(v *LiveSimulationState) *DescribeSimulationOutput

SetLiveSimulationState sets the LiveSimulationState field's value.

func (*DescribeSimulationOutput) SetLoggingConfiguration 

func (s *DescribeSimulationOutput) SetLoggingConfiguration(v *LoggingConfiguration) *DescribeSimulationOutput

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*DescribeSimulationOutput) SetMaximumDuration 

func (s *DescribeSimulationOutput) SetMaximumDuration(v string) *DescribeSimulationOutput

SetMaximumDuration sets the MaximumDuration field's value.

func (*DescribeSimulationOutput) SetName 

func (s *DescribeSimulationOutput) SetName(v string) *DescribeSimulationOutput

SetName sets the Name field's value.

func (*DescribeSimulationOutput) SetRoleArn 

func (s *DescribeSimulationOutput) SetRoleArn(v string) *DescribeSimulationOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeSimulationOutput) SetSchemaError 

func (s *DescribeSimulationOutput) SetSchemaError(v string) *DescribeSimulationOutput

SetSchemaError sets the SchemaError field's value.

func (*DescribeSimulationOutput) SetSchemaS3Location 

func (s *DescribeSimulationOutput) SetSchemaS3Location(v *S3Location) *DescribeSimulationOutput

SetSchemaS3Location sets the SchemaS3Location field's value.

func (*DescribeSimulationOutput) SetStatus 

func (s *DescribeSimulationOutput) SetStatus(v string) *DescribeSimulationOutput

SetStatus sets the Status field's value.

func (*DescribeSimulationOutput) SetTargetStatus 

func (s *DescribeSimulationOutput) SetTargetStatus(v string) *DescribeSimulationOutput

SetTargetStatus sets the TargetStatus field's value.

func (DescribeSimulationOutput) String 

func (s DescribeSimulationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Domain 

type Domain struct {

	// The type of lifecycle management for apps in the domain. This value indicates
	// whether apps in this domain are managed (SimSpace Weaver starts and stops
	// the apps) or unmanaged (you must start and stop the apps).
	//
	// Lifecycle types
	//
	//    * PerWorker – Managed: SimSpace Weaver starts 1 app on each worker
	//
	//    * BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each
	//    spatial partition
	//
	//    * ByRequest – Unmanaged: You use the StartApp API to start the apps
	//    and use the StopApp API to stop the apps.
	//
	// The lifecycle types will change when the service is released for general
	// availability (GA).
	Lifecycle *string `type:"string" enum:"LifecycleManagementStrategy"`

	// The name of the domain.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

For more information about domains, see Key concepts (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) in the Amazon Web Services SimSpace Weaver User Guide.

func (Domain) GoString 

func (s Domain) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Domain) SetLifecycle 

func (s *Domain) SetLifecycle(v string) *Domain

SetLifecycle sets the Lifecycle field's value.

func (*Domain) SetName 

func (s *Domain) SetName(v string) *Domain

SetName sets the Name field's value.

func (Domain) String 

func (s Domain) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LaunchOverrides 

type LaunchOverrides struct {

	// App launch commands and command line parameters that override the launch
	// command configured in the simulation schema.
	LaunchCommands []*string `type:"list"`
	// contains filtered or unexported fields
}

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

func (LaunchOverrides) GoString 

func (s LaunchOverrides) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LaunchOverrides) SetLaunchCommands 

func (s *LaunchOverrides) SetLaunchCommands(v []*string) *LaunchOverrides

SetLaunchCommands sets the LaunchCommands field's value.

func (LaunchOverrides) String 

func (s LaunchOverrides) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppsInput 

type ListAppsInput struct {

	// The name of the domain that you want to list apps for.
	Domain *string `location:"querystring" locationName:"domain" min:"1" type:"string"`

	// The maximum number of apps to list.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

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

	// The name of the simulation that you want to list apps for.
	//
	// Simulation is a required field
	Simulation *string `location:"querystring" locationName:"simulation" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListAppsInput) GoString 

func (s ListAppsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppsInput) SetDomain 

func (s *ListAppsInput) SetDomain(v string) *ListAppsInput

SetDomain sets the Domain field's value.

func (*ListAppsInput) SetMaxResults 

func (s *ListAppsInput) SetMaxResults(v int64) *ListAppsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAppsInput) SetNextToken 

func (s *ListAppsInput) SetNextToken(v string) *ListAppsInput

SetNextToken sets the NextToken field's value.

func (*ListAppsInput) SetSimulation 

func (s *ListAppsInput) SetSimulation(v string) *ListAppsInput

SetSimulation sets the Simulation field's value.

func (ListAppsInput) String 

func (s ListAppsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppsInput) Validate 

func (s *ListAppsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAppsOutput 

type ListAppsOutput struct {

	// The list of apps for the given simulation and domain.
	Apps []*SimulationAppMetadata `type:"list"`

	// If SimSpace Weaver returns nextToken, there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve
	// the next page, call the operation again using the returned token. Keep all
	// other arguments unchanged. If no results remain, nextToken is set to null.
	// Each pagination token expires after 24 hours. If you provide a token that
	// isn't valid, you receive an HTTP 400 ValidationException error.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAppsOutput) GoString 

func (s ListAppsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppsOutput) SetApps 

func (s *ListAppsOutput) SetApps(v []*SimulationAppMetadata) *ListAppsOutput

SetApps sets the Apps field's value.

func (*ListAppsOutput) SetNextToken 

func (s *ListAppsOutput) SetNextToken(v string) *ListAppsOutput

SetNextToken sets the NextToken field's value.

func (ListAppsOutput) String 

func (s ListAppsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSimulationsInput 

type ListSimulationsInput struct {

	// The maximum number of simulations to list.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// If SimSpace Weaver returns nextToken, there are more results available. The
	// value of nextToken is a unique pagination token for each page. To retrieve
	// the next page, call the operation again using the returned token. Keep all
	// other arguments unchanged. If no results remain, nextToken is set to null.
	// Each pagination token expires after 24 hours. If you provide a token that
	// isn't valid, you receive an HTTP 400 ValidationException error.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListSimulationsInput) GoString 

func (s ListSimulationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSimulationsInput) SetMaxResults 

func (s *ListSimulationsInput) SetMaxResults(v int64) *ListSimulationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSimulationsInput) SetNextToken 

func (s *ListSimulationsInput) SetNextToken(v string) *ListSimulationsInput

SetNextToken sets the NextToken field's value.

func (ListSimulationsInput) String 

func (s ListSimulationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSimulationsInput) Validate 

func (s *ListSimulationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSimulationsOutput 

type ListSimulationsOutput struct {

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

	// The list of simulations.
	Simulations []*SimulationMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (ListSimulationsOutput) GoString 

func (s ListSimulationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSimulationsOutput) SetNextToken 

func (s *ListSimulationsOutput) SetNextToken(v string) *ListSimulationsOutput

SetNextToken sets the NextToken field's value.

func (*ListSimulationsOutput) SetSimulations 

func (s *ListSimulationsOutput) SetSimulations(v []*SimulationMetadata) *ListSimulationsOutput

SetSimulations sets the Simulations field's value.

func (ListSimulationsOutput) String 

func (s ListSimulationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. For more information about
	// ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags for the resource.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LiveSimulationState 

type LiveSimulationState struct {

	// A list of simulation clocks.
	//
	// At this time, a simulation has only one clock.
	Clocks []*SimulationClock `type:"list"`

	// A list of domains for the simulation. For more information about domains,
	// see Key concepts (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html)
	// in the Amazon Web Services SimSpace Weaver User Guide.
	Domains []*Domain `type:"list"`
	// contains filtered or unexported fields
}

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

func (LiveSimulationState) GoString 

func (s LiveSimulationState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveSimulationState) SetClocks 

func (s *LiveSimulationState) SetClocks(v []*SimulationClock) *LiveSimulationState

SetClocks sets the Clocks field's value.

func (*LiveSimulationState) SetDomains 

func (s *LiveSimulationState) SetDomains(v []*Domain) *LiveSimulationState

SetDomains sets the Domains field's value.

func (LiveSimulationState) String 

func (s LiveSimulationState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogDestination 

type LogDestination struct {

	// An Amazon CloudWatch Logs log group that stores simulation log data. For
	// more information about log groups, see Working with log groups and log streams
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html)
	// in the Amazon CloudWatch Logs User Guide.
	CloudWatchLogsLogGroup *CloudWatchLogsLogGroup `type:"structure"`
	// contains filtered or unexported fields
}

The location where SimSpace Weaver sends simulation log data.

func (LogDestination) GoString 

func (s LogDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDestination) SetCloudWatchLogsLogGroup 

func (s *LogDestination) SetCloudWatchLogsLogGroup(v *CloudWatchLogsLogGroup) *LogDestination

SetCloudWatchLogsLogGroup sets the CloudWatchLogsLogGroup field's value.

func (LogDestination) String 

func (s LogDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingConfiguration 

type LoggingConfiguration struct {

	// A list of the locations where SimSpace Weaver sends simulation log data.
	Destinations []*LogDestination `type:"list"`
	// contains filtered or unexported fields
}

The logging configuration for a simulation.

func (LoggingConfiguration) GoString 

func (s LoggingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfiguration) SetDestinations 

func (s *LoggingConfiguration) SetDestinations(v []*LogDestination) *LoggingConfiguration

SetDestinations sets the Destinations field's value.

func (LoggingConfiguration) String 

func (s LoggingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Location 

type S3Location struct {

	// The name of an Amazon S3 bucket. For more information about buckets, see
	// Creating, configuring, and working with Amazon S3 buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html)
	// in the Amazon Simple Storage Service User Guide.
	BucketName *string `min:"3" type:"string"`

	// The key name of an object in Amazon S3. For more information about Amazon
	// S3 objects and object keys, see Uploading, downloading, and working with
	// objects in Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html)
	// in the Amazon Simple Storage Service User Guide.
	ObjectKey *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).

func (S3Location) GoString 

func (s S3Location) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Location) SetBucketName 

func (s *S3Location) SetBucketName(v string) *S3Location

SetBucketName sets the BucketName field's value.

func (*S3Location) SetObjectKey 

func (s *S3Location) SetObjectKey(v string) *S3Location

SetObjectKey sets the ObjectKey field's value.

func (S3Location) String 

func (s S3Location) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Location) Validate 

func (s *S3Location) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SimSpaceWeaver 

type SimSpaceWeaver struct {
	*client.Client
}

SimSpaceWeaver provides the API operation methods for making requests to AWS SimSpace Weaver. See this package's package overview docs for details on the service.

SimSpaceWeaver methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SimSpaceWeaver

New creates a new instance of the SimSpaceWeaver client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a SimSpaceWeaver client from just a session.
svc := simspaceweaver.New(mySession)

// Create a SimSpaceWeaver client with additional configuration
svc := simspaceweaver.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SimSpaceWeaver) DeleteApp 

func (c *SimSpaceWeaver) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error)

DeleteApp API operation for AWS SimSpace Weaver.

Deletes the instance of the given custom app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation DeleteApp for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DeleteApp

func (*SimSpaceWeaver) DeleteAppRequest 

func (c *SimSpaceWeaver) DeleteAppRequest(input *DeleteAppInput) (req *request.Request, output *DeleteAppOutput)

DeleteAppRequest generates a "aws/request.Request" representing the client's request for the DeleteApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteApp for more information on using the DeleteApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAppRequest method.
req, resp := client.DeleteAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DeleteApp

func (*SimSpaceWeaver) DeleteAppWithContext 

func (c *SimSpaceWeaver) DeleteAppWithContext(ctx aws.Context, input *DeleteAppInput, opts ...request.Option) (*DeleteAppOutput, error)

DeleteAppWithContext is the same as DeleteApp with the addition of the ability to pass a context and additional request options.

See DeleteApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) DeleteSimulation 

func (c *SimSpaceWeaver) DeleteSimulation(input *DeleteSimulationInput) (*DeleteSimulationOutput, error)

DeleteSimulation API operation for AWS SimSpace Weaver.

Deletes all SimSpace Weaver resources assigned to the given simulation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation DeleteSimulation for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DeleteSimulation

func (*SimSpaceWeaver) DeleteSimulationRequest 

func (c *SimSpaceWeaver) DeleteSimulationRequest(input *DeleteSimulationInput) (req *request.Request, output *DeleteSimulationOutput)

DeleteSimulationRequest generates a "aws/request.Request" representing the client's request for the DeleteSimulation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSimulation for more information on using the DeleteSimulation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSimulationRequest method.
req, resp := client.DeleteSimulationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DeleteSimulation

func (*SimSpaceWeaver) DeleteSimulationWithContext 

func (c *SimSpaceWeaver) DeleteSimulationWithContext(ctx aws.Context, input *DeleteSimulationInput, opts ...request.Option) (*DeleteSimulationOutput, error)

DeleteSimulationWithContext is the same as DeleteSimulation with the addition of the ability to pass a context and additional request options.

See DeleteSimulation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) DescribeApp 

func (c *SimSpaceWeaver) DescribeApp(input *DescribeAppInput) (*DescribeAppOutput, error)

DescribeApp API operation for AWS SimSpace Weaver.

Returns the state of the given custom app.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation DescribeApp for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DescribeApp

func (*SimSpaceWeaver) DescribeAppRequest 

func (c *SimSpaceWeaver) DescribeAppRequest(input *DescribeAppInput) (req *request.Request, output *DescribeAppOutput)

DescribeAppRequest generates a "aws/request.Request" representing the client's request for the DescribeApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeApp for more information on using the DescribeApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAppRequest method.
req, resp := client.DescribeAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DescribeApp

func (*SimSpaceWeaver) DescribeAppWithContext 

func (c *SimSpaceWeaver) DescribeAppWithContext(ctx aws.Context, input *DescribeAppInput, opts ...request.Option) (*DescribeAppOutput, error)

DescribeAppWithContext is the same as DescribeApp with the addition of the ability to pass a context and additional request options.

See DescribeApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) DescribeSimulation 

func (c *SimSpaceWeaver) DescribeSimulation(input *DescribeSimulationInput) (*DescribeSimulationOutput, error)

DescribeSimulation API operation for AWS SimSpace Weaver.

Returns the current state of the given simulation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation DescribeSimulation for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DescribeSimulation

func (*SimSpaceWeaver) DescribeSimulationRequest 

func (c *SimSpaceWeaver) DescribeSimulationRequest(input *DescribeSimulationInput) (req *request.Request, output *DescribeSimulationOutput)

DescribeSimulationRequest generates a "aws/request.Request" representing the client's request for the DescribeSimulation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSimulation for more information on using the DescribeSimulation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSimulationRequest method.
req, resp := client.DescribeSimulationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DescribeSimulation

func (*SimSpaceWeaver) DescribeSimulationWithContext 

func (c *SimSpaceWeaver) DescribeSimulationWithContext(ctx aws.Context, input *DescribeSimulationInput, opts ...request.Option) (*DescribeSimulationOutput, error)

DescribeSimulationWithContext is the same as DescribeSimulation with the addition of the ability to pass a context and additional request options.

See DescribeSimulation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) ListApps 

func (c *SimSpaceWeaver) ListApps(input *ListAppsInput) (*ListAppsOutput, error)

ListApps API operation for AWS SimSpace Weaver.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation ListApps for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListApps

func (*SimSpaceWeaver) ListAppsPages 

func (c *SimSpaceWeaver) ListAppsPages(input *ListAppsInput, fn func(*ListAppsOutput, bool) bool) error

ListAppsPages iterates over the pages of a ListApps operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListApps method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListApps operation.
pageNum := 0
err := client.ListAppsPages(params,
    func(page *simspaceweaver.ListAppsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SimSpaceWeaver) ListAppsPagesWithContext 

func (c *SimSpaceWeaver) ListAppsPagesWithContext(ctx aws.Context, input *ListAppsInput, fn func(*ListAppsOutput, bool) bool, opts ...request.Option) error

ListAppsPagesWithContext same as ListAppsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) ListAppsRequest 

func (c *SimSpaceWeaver) ListAppsRequest(input *ListAppsInput) (req *request.Request, output *ListAppsOutput)

ListAppsRequest generates a "aws/request.Request" representing the client's request for the ListApps operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListApps for more information on using the ListApps API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAppsRequest method.
req, resp := client.ListAppsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListApps

func (*SimSpaceWeaver) ListAppsWithContext 

func (c *SimSpaceWeaver) ListAppsWithContext(ctx aws.Context, input *ListAppsInput, opts ...request.Option) (*ListAppsOutput, error)

ListAppsWithContext is the same as ListApps with the addition of the ability to pass a context and additional request options.

See ListApps for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) ListSimulations 

func (c *SimSpaceWeaver) ListSimulations(input *ListSimulationsInput) (*ListSimulationsOutput, error)

ListSimulations API operation for AWS SimSpace Weaver.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation ListSimulations for usage and error information.

Returned Error Types:

  • InternalServerException

  • AccessDeniedException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListSimulations

func (*SimSpaceWeaver) ListSimulationsPages 

func (c *SimSpaceWeaver) ListSimulationsPages(input *ListSimulationsInput, fn func(*ListSimulationsOutput, bool) bool) error

ListSimulationsPages iterates over the pages of a ListSimulations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSimulations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSimulations operation.
pageNum := 0
err := client.ListSimulationsPages(params,
    func(page *simspaceweaver.ListSimulationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SimSpaceWeaver) ListSimulationsPagesWithContext 

func (c *SimSpaceWeaver) ListSimulationsPagesWithContext(ctx aws.Context, input *ListSimulationsInput, fn func(*ListSimulationsOutput, bool) bool, opts ...request.Option) error

ListSimulationsPagesWithContext same as ListSimulationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) ListSimulationsRequest 

func (c *SimSpaceWeaver) ListSimulationsRequest(input *ListSimulationsInput) (req *request.Request, output *ListSimulationsOutput)

ListSimulationsRequest generates a "aws/request.Request" representing the client's request for the ListSimulations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSimulations for more information on using the ListSimulations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListSimulationsRequest method.
req, resp := client.ListSimulationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListSimulations

func (*SimSpaceWeaver) ListSimulationsWithContext 

func (c *SimSpaceWeaver) ListSimulationsWithContext(ctx aws.Context, input *ListSimulationsInput, opts ...request.Option) (*ListSimulationsOutput, error)

ListSimulationsWithContext is the same as ListSimulations with the addition of the ability to pass a context and additional request options.

See ListSimulations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) ListTagsForResource 

func (c *SimSpaceWeaver) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS SimSpace Weaver.

Lists all tags on a SimSpace Weaver resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListTagsForResource

func (*SimSpaceWeaver) ListTagsForResourceRequest 

func (c *SimSpaceWeaver) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListTagsForResource

func (*SimSpaceWeaver) ListTagsForResourceWithContext 

func (c *SimSpaceWeaver) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) StartApp 

func (c *SimSpaceWeaver) StartApp(input *StartAppInput) (*StartAppOutput, error)

StartApp API operation for AWS SimSpace Weaver.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation StartApp for usage and error information.

Returned Error Types:

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartApp

func (*SimSpaceWeaver) StartAppRequest 

func (c *SimSpaceWeaver) StartAppRequest(input *StartAppInput) (req *request.Request, output *StartAppOutput)

StartAppRequest generates a "aws/request.Request" representing the client's request for the StartApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartApp for more information on using the StartApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartAppRequest method.
req, resp := client.StartAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartApp

func (*SimSpaceWeaver) StartAppWithContext 

func (c *SimSpaceWeaver) StartAppWithContext(ctx aws.Context, input *StartAppInput, opts ...request.Option) (*StartAppOutput, error)

StartAppWithContext is the same as StartApp with the addition of the ability to pass a context and additional request options.

See StartApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) StartClock 

func (c *SimSpaceWeaver) StartClock(input *StartClockInput) (*StartClockOutput, error)

StartClock API operation for AWS SimSpace Weaver.

Starts the simulation clock.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation StartClock for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartClock

func (*SimSpaceWeaver) StartClockRequest 

func (c *SimSpaceWeaver) StartClockRequest(input *StartClockInput) (req *request.Request, output *StartClockOutput)

StartClockRequest generates a "aws/request.Request" representing the client's request for the StartClock operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartClock for more information on using the StartClock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartClockRequest method.
req, resp := client.StartClockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartClock

func (*SimSpaceWeaver) StartClockWithContext 

func (c *SimSpaceWeaver) StartClockWithContext(ctx aws.Context, input *StartClockInput, opts ...request.Option) (*StartClockOutput, error)

StartClockWithContext is the same as StartClock with the addition of the ability to pass a context and additional request options.

See StartClock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) StartSimulation 

func (c *SimSpaceWeaver) StartSimulation(input *StartSimulationInput) (*StartSimulationOutput, error)

StartSimulation API operation for AWS SimSpace Weaver.

Starts a simulation with the given name and schema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation StartSimulation for usage and error information.

Returned Error Types:

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ServiceQuotaExceededException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartSimulation

func (*SimSpaceWeaver) StartSimulationRequest 

func (c *SimSpaceWeaver) StartSimulationRequest(input *StartSimulationInput) (req *request.Request, output *StartSimulationOutput)

StartSimulationRequest generates a "aws/request.Request" representing the client's request for the StartSimulation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSimulation for more information on using the StartSimulation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartSimulationRequest method.
req, resp := client.StartSimulationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartSimulation

func (*SimSpaceWeaver) StartSimulationWithContext 

func (c *SimSpaceWeaver) StartSimulationWithContext(ctx aws.Context, input *StartSimulationInput, opts ...request.Option) (*StartSimulationOutput, error)

StartSimulationWithContext is the same as StartSimulation with the addition of the ability to pass a context and additional request options.

See StartSimulation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) StopApp 

func (c *SimSpaceWeaver) StopApp(input *StopAppInput) (*StopAppOutput, error)

StopApp API operation for AWS SimSpace Weaver.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation StopApp for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopApp

func (*SimSpaceWeaver) StopAppRequest 

func (c *SimSpaceWeaver) StopAppRequest(input *StopAppInput) (req *request.Request, output *StopAppOutput)

StopAppRequest generates a "aws/request.Request" representing the client's request for the StopApp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopApp for more information on using the StopApp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopAppRequest method.
req, resp := client.StopAppRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopApp

func (*SimSpaceWeaver) StopAppWithContext 

func (c *SimSpaceWeaver) StopAppWithContext(ctx aws.Context, input *StopAppInput, opts ...request.Option) (*StopAppOutput, error)

StopAppWithContext is the same as StopApp with the addition of the ability to pass a context and additional request options.

See StopApp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) StopClock 

func (c *SimSpaceWeaver) StopClock(input *StopClockInput) (*StopClockOutput, error)

StopClock API operation for AWS SimSpace Weaver.

Stops the simulation clock.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation StopClock for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopClock

func (*SimSpaceWeaver) StopClockRequest 

func (c *SimSpaceWeaver) StopClockRequest(input *StopClockInput) (req *request.Request, output *StopClockOutput)

StopClockRequest generates a "aws/request.Request" representing the client's request for the StopClock operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopClock for more information on using the StopClock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopClockRequest method.
req, resp := client.StopClockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopClock

func (*SimSpaceWeaver) StopClockWithContext 

func (c *SimSpaceWeaver) StopClockWithContext(ctx aws.Context, input *StopClockInput, opts ...request.Option) (*StopClockOutput, error)

StopClockWithContext is the same as StopClock with the addition of the ability to pass a context and additional request options.

See StopClock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) StopSimulation 

func (c *SimSpaceWeaver) StopSimulation(input *StopSimulationInput) (*StopSimulationOutput, error)

StopSimulation API operation for AWS SimSpace Weaver.

Stops the given simulation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation StopSimulation for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalServerException

  • AccessDeniedException

  • ValidationException

  • ConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopSimulation

func (*SimSpaceWeaver) StopSimulationRequest 

func (c *SimSpaceWeaver) StopSimulationRequest(input *StopSimulationInput) (req *request.Request, output *StopSimulationOutput)

StopSimulationRequest generates a "aws/request.Request" representing the client's request for the StopSimulation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopSimulation for more information on using the StopSimulation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopSimulationRequest method.
req, resp := client.StopSimulationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopSimulation

func (*SimSpaceWeaver) StopSimulationWithContext 

func (c *SimSpaceWeaver) StopSimulationWithContext(ctx aws.Context, input *StopSimulationInput, opts ...request.Option) (*StopSimulationOutput, error)

StopSimulationWithContext is the same as StopSimulation with the addition of the ability to pass a context and additional request options.

See StopSimulation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) TagResource 

func (c *SimSpaceWeaver) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS SimSpace Weaver.

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation TagResource for usage and error information.

Returned Error Types:

  • TooManyTagsException

  • ResourceNotFoundException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/TagResource

func (*SimSpaceWeaver) TagResourceRequest 

func (c *SimSpaceWeaver) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/TagResource

func (*SimSpaceWeaver) TagResourceWithContext 

func (c *SimSpaceWeaver) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SimSpaceWeaver) UntagResource 

func (c *SimSpaceWeaver) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS SimSpace Weaver.

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SimSpace Weaver's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • ValidationException

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/UntagResource

func (*SimSpaceWeaver) UntagResourceRequest 

func (c *SimSpaceWeaver) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/UntagResource

func (*SimSpaceWeaver) UntagResourceWithContext 

func (c *SimSpaceWeaver) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SimulationAppEndpointInfo 

type SimulationAppEndpointInfo struct {

	// The IP address of the app. SimSpace Weaver dynamically assigns this IP address
	// when the app starts.
	Address *string `min:"1" type:"string"`

	// The inbound TCP/UDP port numbers of the app. The combination of an IP address
	// and a port number form a network endpoint.
	IngressPortMappings []*SimulationAppPortMapping `type:"list"`
	// contains filtered or unexported fields
}

Information about the network endpoint that you can use to connect to your custom or service app.

func (SimulationAppEndpointInfo) GoString 

func (s SimulationAppEndpointInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimulationAppEndpointInfo) SetAddress 

func (s *SimulationAppEndpointInfo) SetAddress(v string) *SimulationAppEndpointInfo

SetAddress sets the Address field's value.

func (*SimulationAppEndpointInfo) SetIngressPortMappings 

func (s *SimulationAppEndpointInfo) SetIngressPortMappings(v []*SimulationAppPortMapping) *SimulationAppEndpointInfo

SetIngressPortMappings sets the IngressPortMappings field's value.

func (SimulationAppEndpointInfo) String 

func (s SimulationAppEndpointInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SimulationAppMetadata 

type SimulationAppMetadata struct {

	// The domain of the app. For more information about domains, see Key concepts
	// (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html)
	// in the Amazon Web Services SimSpace Weaver User Guide.
	Domain *string `min:"1" type:"string"`

	// The name of the app.
	Name *string `min:"1" type:"string"`

	// The name of the simulation of the app.
	Simulation *string `min:"1" type:"string"`

	// The current status of the app.
	Status *string `type:"string" enum:"SimulationAppStatus"`

	// The desired status of the app.
	TargetStatus *string `type:"string" enum:"SimulationAppTargetStatus"`
	// contains filtered or unexported fields
}

A collection of metadata about an app.

func (SimulationAppMetadata) GoString 

func (s SimulationAppMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimulationAppMetadata) SetDomain 

func (s *SimulationAppMetadata) SetDomain(v string) *SimulationAppMetadata

SetDomain sets the Domain field's value.

func (*SimulationAppMetadata) SetName 

func (s *SimulationAppMetadata) SetName(v string) *SimulationAppMetadata

SetName sets the Name field's value.

func (*SimulationAppMetadata) SetSimulation 

func (s *SimulationAppMetadata) SetSimulation(v string) *SimulationAppMetadata

SetSimulation sets the Simulation field's value.

func (*SimulationAppMetadata) SetStatus 

func (s *SimulationAppMetadata) SetStatus(v string) *SimulationAppMetadata

SetStatus sets the Status field's value.

func (*SimulationAppMetadata) SetTargetStatus 

func (s *SimulationAppMetadata) SetTargetStatus(v string) *SimulationAppMetadata

SetTargetStatus sets the TargetStatus field's value.

func (SimulationAppMetadata) String 

func (s SimulationAppMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SimulationAppPortMapping 

type SimulationAppPortMapping struct {

	// The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns
	// this port number when the app starts. SimSpace Weaver maps the Declared port
	// to the Actual port. Clients connect to the app using the app's IP address
	// and the Actual port number.
	Actual *int64 `type:"integer"`

	// The TCP/UDP port number of the app, declared in the simulation schema. SimSpace
	// Weaver maps the Declared port to the Actual port. The source code for the
	// app should bind to the Declared port.
	Declared *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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

func (SimulationAppPortMapping) GoString 

func (s SimulationAppPortMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimulationAppPortMapping) SetActual 

func (s *SimulationAppPortMapping) SetActual(v int64) *SimulationAppPortMapping

SetActual sets the Actual field's value.

func (*SimulationAppPortMapping) SetDeclared 

func (s *SimulationAppPortMapping) SetDeclared(v int64) *SimulationAppPortMapping

SetDeclared sets the Declared field's value.

func (SimulationAppPortMapping) String 

func (s SimulationAppPortMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SimulationClock 

type SimulationClock struct {

	// The current status of the simulation clock.
	Status *string `type:"string" enum:"ClockStatus"`

	// The desired status of the simulation clock.
	TargetStatus *string `type:"string" enum:"ClockTargetStatus"`
	// contains filtered or unexported fields
}

Status information about the simulation clock.

func (SimulationClock) GoString 

func (s SimulationClock) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimulationClock) SetStatus 

func (s *SimulationClock) SetStatus(v string) *SimulationClock

SetStatus sets the Status field's value.

func (*SimulationClock) SetTargetStatus 

func (s *SimulationClock) SetTargetStatus(v string) *SimulationClock

SetTargetStatus sets the TargetStatus field's value.

func (SimulationClock) String 

func (s SimulationClock) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SimulationMetadata 

type SimulationMetadata struct {

	// The Amazon Resource Name (ARN) of the simulation. For more information about
	// ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string `type:"string"`

	// The time when the simulation was created, expressed as the number of seconds
	// and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
	CreationTime *time.Time `type:"timestamp"`

	// The name of the simulation.
	Name *string `min:"1" type:"string"`

	// The current status of the simulation.
	Status *string `type:"string" enum:"SimulationStatus"`

	// The desired status of the simulation.
	TargetStatus *string `type:"string" enum:"SimulationTargetStatus"`
	// contains filtered or unexported fields
}

A collection of data about the simulation.

func (SimulationMetadata) GoString 

func (s SimulationMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimulationMetadata) SetArn 

func (s *SimulationMetadata) SetArn(v string) *SimulationMetadata

SetArn sets the Arn field's value.

func (*SimulationMetadata) SetCreationTime 

func (s *SimulationMetadata) SetCreationTime(v time.Time) *SimulationMetadata

SetCreationTime sets the CreationTime field's value.

func (*SimulationMetadata) SetName 

func (s *SimulationMetadata) SetName(v string) *SimulationMetadata

SetName sets the Name field's value.

func (*SimulationMetadata) SetStatus 

func (s *SimulationMetadata) SetStatus(v string) *SimulationMetadata

SetStatus sets the Status field's value.

func (*SimulationMetadata) SetTargetStatus 

func (s *SimulationMetadata) SetTargetStatus(v string) *SimulationMetadata

SetTargetStatus sets the TargetStatus field's value.

func (SimulationMetadata) String 

func (s SimulationMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartAppInput 

type StartAppInput struct {

	// A value that you provide to ensure that repeated calls to this API operation
	// using the same parameters complete only once. A ClientToken is also known
	// as an idempotency token. A ClientToken expires after 24 hours.
	//
	// ClientToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartAppInput's
	// String and GoString methods.
	ClientToken *string `min:"32" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The description of the app.
	Description *string `type:"string"`

	// The name of the domain of the app.
	//
	// Domain is a required field
	Domain *string `min:"1" type:"string" required:"true"`

	// Options that apply when the app starts. These optiAons override default behavior.
	LaunchOverrides *LaunchOverrides `type:"structure"`

	// The name of the app.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The name of the simulation of the app.
	//
	// Simulation is a required field
	Simulation *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartAppInput) GoString 

func (s StartAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAppInput) SetClientToken 

func (s *StartAppInput) SetClientToken(v string) *StartAppInput

SetClientToken sets the ClientToken field's value.

func (*StartAppInput) SetDescription 

func (s *StartAppInput) SetDescription(v string) *StartAppInput

SetDescription sets the Description field's value.

func (*StartAppInput) SetDomain 

func (s *StartAppInput) SetDomain(v string) *StartAppInput

SetDomain sets the Domain field's value.

func (*StartAppInput) SetLaunchOverrides 

func (s *StartAppInput) SetLaunchOverrides(v *LaunchOverrides) *StartAppInput

SetLaunchOverrides sets the LaunchOverrides field's value.

func (*StartAppInput) SetName 

func (s *StartAppInput) SetName(v string) *StartAppInput

SetName sets the Name field's value.

func (*StartAppInput) SetSimulation 

func (s *StartAppInput) SetSimulation(v string) *StartAppInput

SetSimulation sets the Simulation field's value.

func (StartAppInput) String 

func (s StartAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAppInput) Validate 

func (s *StartAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartAppOutput 

type StartAppOutput struct {

	// The name of the domain of the app.
	Domain *string `min:"1" type:"string"`

	// The name of the app.
	Name *string `min:"1" type:"string"`

	// The name of the simulation of the app.
	Simulation *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartAppOutput) GoString 

func (s StartAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAppOutput) SetDomain 

func (s *StartAppOutput) SetDomain(v string) *StartAppOutput

SetDomain sets the Domain field's value.

func (*StartAppOutput) SetName 

func (s *StartAppOutput) SetName(v string) *StartAppOutput

SetName sets the Name field's value.

func (*StartAppOutput) SetSimulation 

func (s *StartAppOutput) SetSimulation(v string) *StartAppOutput

SetSimulation sets the Simulation field's value.

func (StartAppOutput) String 

func (s StartAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartClockInput 

type StartClockInput struct {

	// The name of the simulation.
	//
	// Simulation is a required field
	Simulation *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartClockInput) GoString 

func (s StartClockInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartClockInput) SetSimulation 

func (s *StartClockInput) SetSimulation(v string) *StartClockInput

SetSimulation sets the Simulation field's value.

func (StartClockInput) String 

func (s StartClockInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartClockInput) Validate 

func (s *StartClockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartClockOutput 

type StartClockOutput struct {
	// contains filtered or unexported fields
}

func (StartClockOutput) GoString 

func (s StartClockOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartClockOutput) String 

func (s StartClockOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSimulationInput 

type StartSimulationInput struct {

	// A value that you provide to ensure that repeated calls to this API operation
	// using the same parameters complete only once. A ClientToken is also known
	// as an idempotency token. A ClientToken expires after 24 hours.
	//
	// ClientToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSimulationInput's
	// String and GoString methods.
	ClientToken *string `min:"32" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The description of the simulation.
	Description *string `type:"string"`

	// The maximum running time of the simulation, specified as a number of months
	// (m or M), hours (h or H), or days (d or D). The simulation stops when it
	// reaches this limit.
	MaximumDuration *string `min:"2" type:"string"`

	// The name of the simulation.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role that the simulation assumes to perform actions. For more information
	// about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference. For more information about
	// IAM roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
	// in the Identity and Access Management User Guide.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The location of the simulation schema in Amazon Simple Storage Service (Amazon
	// S3). For more information about Amazon S3, see the Amazon Simple Storage
	// Service User Guide (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html).
	//
	// SchemaS3Location is a required field
	SchemaS3Location *S3Location `type:"structure" required:"true"`

	// A list of tags for the simulation. For more information about tags, see Tagging
	// Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (StartSimulationInput) GoString 

func (s StartSimulationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSimulationInput) SetClientToken 

func (s *StartSimulationInput) SetClientToken(v string) *StartSimulationInput

SetClientToken sets the ClientToken field's value.

func (*StartSimulationInput) SetDescription 

func (s *StartSimulationInput) SetDescription(v string) *StartSimulationInput

SetDescription sets the Description field's value.

func (*StartSimulationInput) SetMaximumDuration 

func (s *StartSimulationInput) SetMaximumDuration(v string) *StartSimulationInput

SetMaximumDuration sets the MaximumDuration field's value.

func (*StartSimulationInput) SetName 

func (s *StartSimulationInput) SetName(v string) *StartSimulationInput

SetName sets the Name field's value.

func (*StartSimulationInput) SetRoleArn 

func (s *StartSimulationInput) SetRoleArn(v string) *StartSimulationInput

SetRoleArn sets the RoleArn field's value.

func (*StartSimulationInput) SetSchemaS3Location 

func (s *StartSimulationInput) SetSchemaS3Location(v *S3Location) *StartSimulationInput

SetSchemaS3Location sets the SchemaS3Location field's value.

func (*StartSimulationInput) SetTags 

func (s *StartSimulationInput) SetTags(v map[string]*string) *StartSimulationInput

SetTags sets the Tags field's value.

func (StartSimulationInput) String 

func (s StartSimulationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSimulationInput) Validate 

func (s *StartSimulationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSimulationOutput 

type StartSimulationOutput struct {

	// The Amazon Resource Name (ARN) of the simulation. For more information about
	// ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	Arn *string `type:"string"`

	// The time when the simulation was created, expressed as the number of seconds
	// and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
	CreationTime *time.Time `type:"timestamp"`

	// A universally unique identifier (UUID) for this simulation.
	ExecutionId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (StartSimulationOutput) GoString 

func (s StartSimulationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSimulationOutput) SetArn 

func (s *StartSimulationOutput) SetArn(v string) *StartSimulationOutput

SetArn sets the Arn field's value.

func (*StartSimulationOutput) SetCreationTime 

func (s *StartSimulationOutput) SetCreationTime(v time.Time) *StartSimulationOutput

SetCreationTime sets the CreationTime field's value.

func (*StartSimulationOutput) SetExecutionId 

func (s *StartSimulationOutput) SetExecutionId(v string) *StartSimulationOutput

SetExecutionId sets the ExecutionId field's value.

func (StartSimulationOutput) String 

func (s StartSimulationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopAppInput 

type StopAppInput struct {

	// The name of the app.
	//
	// App is a required field
	App *string `min:"1" type:"string" required:"true"`

	// The name of the domain of the app.
	//
	// Domain is a required field
	Domain *string `min:"1" type:"string" required:"true"`

	// The name of the simulation of the app.
	//
	// Simulation is a required field
	Simulation *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopAppInput) GoString 

func (s StopAppInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopAppInput) SetApp 

func (s *StopAppInput) SetApp(v string) *StopAppInput

SetApp sets the App field's value.

func (*StopAppInput) SetDomain 

func (s *StopAppInput) SetDomain(v string) *StopAppInput

SetDomain sets the Domain field's value.

func (*StopAppInput) SetSimulation 

func (s *StopAppInput) SetSimulation(v string) *StopAppInput

SetSimulation sets the Simulation field's value.

func (StopAppInput) String 

func (s StopAppInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopAppInput) Validate 

func (s *StopAppInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopAppOutput 

type StopAppOutput struct {
	// contains filtered or unexported fields
}

func (StopAppOutput) GoString 

func (s StopAppOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopAppOutput) String 

func (s StopAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopClockInput 

type StopClockInput struct {

	// The name of the simulation.
	//
	// Simulation is a required field
	Simulation *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopClockInput) GoString 

func (s StopClockInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopClockInput) SetSimulation 

func (s *StopClockInput) SetSimulation(v string) *StopClockInput

SetSimulation sets the Simulation field's value.

func (StopClockInput) String 

func (s StopClockInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopClockInput) Validate 

func (s *StopClockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopClockOutput 

type StopClockOutput struct {
	// contains filtered or unexported fields
}

func (StopClockOutput) GoString 

func (s StopClockOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopClockOutput) String 

func (s StopClockOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopSimulationInput 

type StopSimulationInput struct {

	// The name of the simulation.
	//
	// Simulation is a required field
	Simulation *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopSimulationInput) GoString 

func (s StopSimulationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopSimulationInput) SetSimulation 

func (s *StopSimulationInput) SetSimulation(v string) *StopSimulationInput

SetSimulation sets the Simulation field's value.

func (StopSimulationInput) String 

func (s StopSimulationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopSimulationInput) Validate 

func (s *StopSimulationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopSimulationOutput 

type StopSimulationOutput struct {
	// contains filtered or unexported fields
}

func (StopSimulationOutput) GoString 

func (s StopSimulationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopSimulationOutput) String 

func (s StopSimulationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add tags
	// to. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// A list of tags to apply to the resource.
	//
	// Tags is a required field
	Tags map[string]*string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTagsException 

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*TooManyTagsException) Code 

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error 

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString 

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message 

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr 

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID 

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode 

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String 

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove tags
	// from. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the Amazon Web Services General Reference.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// A list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package simspaceweaveriface provides an interface to enable mocking the AWS SimSpace Weaver service client for testing your code.
 Package simspaceweaveriface provides an interface to enable mocking the AWS SimSpace Weaver service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.