Amazonka.SimSpaceWeaver.StartApp

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

Creating a Request

data StartApp

See: newStartApp smart constructor.

Constructors

StartApp'

Fields

• clientToken :: Maybe (Sensitive Text)

  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.

• description :: Maybe Text

  The description of the app.

• launchOverrides :: Maybe LaunchOverrides
• domain :: Text

  The name of the domain of the app.

• name :: Text

  The name of the app.

• simulation :: Text

  The name of the simulation of the app.

Instances

ToJSON StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

toJSON :: StartApp -> Value

toEncoding :: StartApp -> Encoding

toJSONList :: [StartApp] -> Value

toEncodingList :: [StartApp] -> Encoding

ToHeaders StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

toHeaders :: StartApp -> [Header]

ToPath StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

toPath :: StartApp -> ByteString

ToQuery StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

toQuery :: StartApp -> QueryString

AWSRequest StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Associated Types

type AWSResponse StartApp

Methods

request :: (Service -> Service) -> StartApp -> Request StartApp

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartApp)))

Generic StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Associated Types

type Rep StartApp :: Type -> Type

Methods

from :: StartApp -> Rep StartApp x

to :: Rep StartApp x -> StartApp

Show StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

showsPrec :: Int -> StartApp -> ShowS

show :: StartApp -> String

showList :: [StartApp] -> ShowS

NFData StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

rnf :: StartApp -> ()

Eq StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

(==) :: StartApp -> StartApp -> Bool

(/=) :: StartApp -> StartApp -> Bool

Hashable StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

hashWithSalt :: Int -> StartApp -> Int

hash :: StartApp -> Int

type AWSResponse StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

type AWSResponse StartApp = StartAppResponse

type Rep StartApp

Defined in Amazonka.SimSpaceWeaver.StartApp

type Rep StartApp = D1 ('MetaData "StartApp" "Amazonka.SimSpaceWeaver.StartApp" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "StartApp'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchOverrides)))) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "simulation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartApp

Arguments

:: Text

StartApp

-> Text

StartApp

-> Text

StartApp

-> StartApp

Create a value of StartApp with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:StartApp', startApp_clientToken - 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.

$sel:description:StartApp', startApp_description - The description of the app.

$sel:launchOverrides:StartApp', startApp_launchOverrides - Undocumented member.

StartApp, startApp_domain - The name of the domain of the app.

StartApp, startApp_name - The name of the app.

StartApp, startApp_simulation - The name of the simulation of the app.

Request Lenses

startApp_clientToken :: Lens' StartApp (Maybe Text)

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.

startApp_description :: Lens' StartApp (Maybe Text)

The description of the app.

startApp_launchOverrides :: Lens' StartApp (Maybe LaunchOverrides)

Undocumented member.

startApp_domain :: Lens' StartApp Text

The name of the domain of the app.

startApp_name :: Lens' StartApp Text

The name of the app.

startApp_simulation :: Lens' StartApp Text

The name of the simulation of the app.

Destructuring the Response

data StartAppResponse

See: newStartAppResponse smart constructor.

Constructors

StartAppResponse'

Fields

• domain :: Maybe Text

  The name of the domain of the app.

• name :: Maybe Text

  The name of the app.

• simulation :: Maybe Text

  The name of the simulation of the app.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartAppResponse

Defined in Amazonka.SimSpaceWeaver.StartApp

Associated Types

type Rep StartAppResponse :: Type -> Type

Methods

from :: StartAppResponse -> Rep StartAppResponse x

to :: Rep StartAppResponse x -> StartAppResponse

Read StartAppResponse

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

readsPrec :: Int -> ReadS StartAppResponse

readList :: ReadS [StartAppResponse]

readPrec :: ReadPrec StartAppResponse

readListPrec :: ReadPrec [StartAppResponse]

Show StartAppResponse

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

showsPrec :: Int -> StartAppResponse -> ShowS

show :: StartAppResponse -> String

showList :: [StartAppResponse] -> ShowS

NFData StartAppResponse

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

rnf :: StartAppResponse -> ()

Eq StartAppResponse

Defined in Amazonka.SimSpaceWeaver.StartApp

Methods

(==) :: StartAppResponse -> StartAppResponse -> Bool

(/=) :: StartAppResponse -> StartAppResponse -> Bool

type Rep StartAppResponse

Defined in Amazonka.SimSpaceWeaver.StartApp

type Rep StartAppResponse = D1 ('MetaData "StartAppResponse" "Amazonka.SimSpaceWeaver.StartApp" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "StartAppResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "simulation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartAppResponse

Arguments

:: Int

$sel:httpStatus:StartAppResponse'

-> StartAppResponse

Create a value of StartAppResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartApp, startAppResponse_domain - The name of the domain of the app.

StartApp, startAppResponse_name - The name of the app.

StartApp, startAppResponse_simulation - The name of the simulation of the app.

$sel:httpStatus:StartAppResponse', startAppResponse_httpStatus - The response's http status code.

Response Lenses

startAppResponse_domain :: Lens' StartAppResponse (Maybe Text)

The name of the domain of the app.

startAppResponse_name :: Lens' StartAppResponse (Maybe Text)

The name of the app.

startAppResponse_simulation :: Lens' StartAppResponse (Maybe Text)

The name of the simulation of the app.

startAppResponse_httpStatus :: Lens' StartAppResponse Int

The response's http status code.