amazonka-simspaceweaver-2.0: Amazon SimSpace Weaver SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SimSpaceWeaver.ListSimulations

Description

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

Synopsis

Creating a Request

data ListSimulations Source #

See: newListSimulations smart constructor.

Constructors

ListSimulations' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of simulations 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.

Instances

Instances details
ToHeaders ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

toHeaders :: ListSimulations -> [Header] #

ToPath ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

toPath :: ListSimulations -> ByteString #

ToQuery ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

toQuery :: ListSimulations -> QueryString #

AWSRequest ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Associated Types

type AWSResponse ListSimulations #

Methods

request :: (Service -> Service) -> ListSimulations -> Request ListSimulations #

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

Generic ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Associated Types

type Rep ListSimulations :: Type -> Type #

Methods

from :: ListSimulations -> Rep ListSimulations x #

to :: Rep ListSimulations x -> ListSimulations #

Read ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

readsPrec :: Int -> ReadS ListSimulations #

readList :: ReadS [ListSimulations] #

readPrec :: ReadPrec ListSimulations #

readListPrec :: ReadPrec [ListSimulations] #

Show ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

showsPrec :: Int -> ListSimulations -> ShowS #

show :: ListSimulations -> String #

showList :: [ListSimulations] -> ShowS #

NFData ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

rnf :: ListSimulations -> () #

Eq ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

(==) :: ListSimulations -> ListSimulations -> Bool #

(/=) :: ListSimulations -> ListSimulations -> Bool #

Hashable ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

hashWithSalt :: Int -> ListSimulations -> Int #

hash :: ListSimulations -> Int #

type AWSResponse ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

type AWSResponse ListSimulations = ListSimulationsResponse
type Rep ListSimulations Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

type Rep ListSimulations = D1 ('MetaData "ListSimulations" "Amazonka.SimSpaceWeaver.ListSimulations" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "ListSimulations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListSimulations :: ListSimulations Source #

Create a value of ListSimulations 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:maxResults:ListSimulations', listSimulations_maxResults - The maximum number of simulations to list.

ListSimulations, listSimulations_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.

Request Lenses

listSimulations_maxResults :: Lens' ListSimulations (Maybe Natural) Source #

The maximum number of simulations to list.

listSimulations_nextToken :: Lens' ListSimulations (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.

Destructuring the Response

data ListSimulationsResponse Source #

See: newListSimulationsResponse smart constructor.

Constructors

ListSimulationsResponse' 

Fields

  • 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.

  • simulations :: Maybe [SimulationMetadata]

    The list of simulations.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSimulationsResponse Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Associated Types

type Rep ListSimulationsResponse :: Type -> Type #

Methods

from :: ListSimulationsResponse -> Rep ListSimulationsResponse x #

to :: Rep ListSimulationsResponse x -> ListSimulationsResponse #

Read ListSimulationsResponse Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

readsPrec :: Int -> ReadS ListSimulationsResponse #

readList :: ReadS [ListSimulationsResponse] #

readPrec :: ReadPrec ListSimulationsResponse #

readListPrec :: ReadPrec [ListSimulationsResponse] #

Show ListSimulationsResponse Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

showsPrec :: Int -> ListSimulationsResponse -> ShowS #

show :: ListSimulationsResponse -> String #

showList :: [ListSimulationsResponse] -> ShowS #

NFData ListSimulationsResponse Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

rnf :: ListSimulationsResponse -> () #

Eq ListSimulationsResponse Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

Methods

(==) :: ListSimulationsResponse -> ListSimulationsResponse -> Bool #

(/=) :: ListSimulationsResponse -> ListSimulationsResponse -> Bool #

type Rep ListSimulationsResponse Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.ListSimulations

type Rep ListSimulationsResponse = D1 ('MetaData "ListSimulationsResponse" "Amazonka.SimSpaceWeaver.ListSimulations" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "ListSimulationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "simulations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SimulationMetadata])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSimulationsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListSimulationsResponse'

-> ListSimulationsResponse 

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

ListSimulations, listSimulationsResponse_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:simulations:ListSimulationsResponse', listSimulationsResponse_simulations - The list of simulations.

$sel:httpStatus:ListSimulationsResponse', listSimulationsResponse_httpStatus - The response's http status code.

Response Lenses

listSimulationsResponse_nextToken :: Lens' ListSimulationsResponse (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.

listSimulationsResponse_simulations :: Lens' ListSimulationsResponse (Maybe [SimulationMetadata]) Source #

The list of simulations.

listSimulationsResponse_httpStatus :: Lens' ListSimulationsResponse Int Source #

The response's http status code.