SimSpaceWeaver / Client / list_apps

list_apps#

SimSpaceWeaver.Client.list_apps(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_apps(
    Domain='string',
    MaxResults=123,
    NextToken='string',
    Simulation='string'
)
Parameters:

  • Domain (string) – The name of the domain that you want to list apps for.

  • MaxResults (integer) – The maximum number of apps to list.

  • NextToken (string) – If SimSpace Weaver returns nextToken, then 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, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

  • Simulation (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Apps': [
        {
            'Domain': 'string',
            'Name': 'string',
            'Simulation': 'string',
            'Status': 'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'ERROR'|'UNKNOWN',
            'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Apps (list) –

      The list of apps for the given simulation and domain.

      • (dict) –

        A collection of metadata about the app.

        • Domain (string) –

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

        • Name (string) –

          The name of the app.

        • Simulation (string) –

          The name of the simulation of the app.

        • Status (string) –

          The current status of the app.

        • TargetStatus (string) –

          The desired status of the app.

    • NextToken (string) –

      If SimSpace Weaver returns nextToken, then 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, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions