Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SimSpaceWeaver.ListApps

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data ListApps = ListApps' {
- domain :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- simulation :: Text
}
newListApps :: Text -> ListApps
listApps_domain :: Lens' ListApps (Maybe Text)
listApps_maxResults :: Lens' ListApps (Maybe Natural)
listApps_nextToken :: Lens' ListApps (Maybe Text)
listApps_simulation :: Lens' ListApps Text
data ListAppsResponse = ListAppsResponse' {
- apps :: Maybe [SimulationAppMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAppsResponse :: Int -> ListAppsResponse
listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [SimulationAppMetadata])
listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text)
listAppsResponse_httpStatus :: Lens' ListAppsResponse Int

Creating a Request

data ListApps Source #

See: newListApps smart constructor.

Constructors

ListApps'

Fields

domain :: Maybe Text
The name of the domain that you want to list apps for.
maxResults :: Maybe Natural
The maximum number of apps to list.
nextToken :: Maybe Text
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.
simulation :: Text
The name of the simulation that you want to list apps for.

Instances

Instances details

ToHeaders ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods toHeaders :: ListApps -> [Header] #
ToPath ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods toPath :: ListApps -> ByteString #
ToQuery ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods toQuery :: ListApps -> QueryString #
AWSRequest ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Associated Types type AWSResponse ListApps # Methods request :: (Service -> Service) -> ListApps -> Request ListApps # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListApps -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListApps))) #
Generic ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Associated Types type Rep ListApps :: Type -> Type # Methods from :: ListApps -> Rep ListApps x # to :: Rep ListApps x -> ListApps #
Read ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods readsPrec :: Int -> ReadS ListApps # readList :: ReadS [ListApps] # readPrec :: ReadPrec ListApps # readListPrec :: ReadPrec [ListApps] #
Show ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods showsPrec :: Int -> ListApps -> ShowS # show :: ListApps -> String # showList :: [ListApps] -> ShowS #
NFData ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods rnf :: ListApps -> () #
Eq ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods (==) :: ListApps -> ListApps -> Bool # (/=) :: ListApps -> ListApps -> Bool #
Hashable ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods hashWithSalt :: Int -> ListApps -> Int # hash :: ListApps -> Int #
type AWSResponse ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps type AWSResponse ListApps = ListAppsResponse
type Rep ListApps Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps type Rep ListApps = D1 ('MetaData "ListApps" "Amazonka.SimSpaceWeaver.ListApps" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "ListApps'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "simulation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListApps Source #

Arguments

:: Text	`ListApps`
-> ListApps

Create a value of ListApps 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:

ListApps, listApps_domain - The name of the domain that you want to list apps for.

$sel:maxResults:ListApps', listApps_maxResults - The maximum number of apps to list.

ListApps, listApps_nextToken - 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.

ListApps, listApps_simulation - The name of the simulation that you want to list apps for.

Request Lenses

listApps_domain :: Lens' ListApps (Maybe Text) Source #

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

listApps_maxResults :: Lens' ListApps (Maybe Natural) Source #

The maximum number of apps to list.

listApps_nextToken :: Lens' ListApps (Maybe Text) Source #

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.

listApps_simulation :: Lens' ListApps Text Source #

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

Destructuring the Response

data ListAppsResponse Source #

See: newListAppsResponse smart constructor.

Constructors

ListAppsResponse'

Fields

apps :: Maybe [SimulationAppMetadata]
The list of apps for the given simulation and domain.
nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListAppsResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Associated Types type Rep ListAppsResponse :: Type -> Type # Methods from :: ListAppsResponse -> Rep ListAppsResponse x # to :: Rep ListAppsResponse x -> ListAppsResponse #
Read ListAppsResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods readsPrec :: Int -> ReadS ListAppsResponse # readList :: ReadS [ListAppsResponse] # readPrec :: ReadPrec ListAppsResponse # readListPrec :: ReadPrec [ListAppsResponse] #
Show ListAppsResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods showsPrec :: Int -> ListAppsResponse -> ShowS # show :: ListAppsResponse -> String # showList :: [ListAppsResponse] -> ShowS #
NFData ListAppsResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods rnf :: ListAppsResponse -> () #
Eq ListAppsResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps Methods (==) :: ListAppsResponse -> ListAppsResponse -> Bool # (/=) :: ListAppsResponse -> ListAppsResponse -> Bool #
type Rep ListAppsResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.ListApps type Rep ListAppsResponse = D1 ('MetaData "ListAppsResponse" "Amazonka.SimSpaceWeaver.ListApps" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "ListAppsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SimulationAppMetadata])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAppsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAppsResponse'`
-> ListAppsResponse

Create a value of ListAppsResponse 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:apps:ListAppsResponse', listAppsResponse_apps - The list of apps for the given simulation and domain.

ListApps, listAppsResponse_nextToken - 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.

$sel:httpStatus:ListAppsResponse', listAppsResponse_httpStatus - The response's http status code.

Response Lenses

listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [SimulationAppMetadata]) Source #

The list of apps for the given simulation and domain.

listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text) Source #

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.

listAppsResponse_httpStatus :: Lens' ListAppsResponse Int Source #

The response's http status code.