SimSpaceWeaver / Client / list_simulations

list_simulations#

SimSpaceWeaver.Client.list_simulations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_simulations(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of simulations 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Simulations': [
        {
            'Arn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Name': 'string',
            'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'|'SNAPSHOT_IN_PROGRESS',
            'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'|'DELETED'
        },
    ]
}

Response Structure

  • (dict) –

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

    • Simulations (list) –

      The list of simulations.

      • (dict) –

        A collection of data about the simulation.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • CreationTime (datetime) –

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

        • Name (string) –

          The name of the simulation.

        • Status (string) –

          The current status of the simulation.

        • TargetStatus (string) –

          The desired status of the simulation.

Exceptions