WickrAdminAPI / Client / list_networks

list_networks

WickrAdminAPI.Client.list_networks(**kwargs)

Retrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.

See also: AWS API Documentation

Request Syntax

response = client.list_networks(
    maxResults=123,
    sortFields='string',
    sortDirection='ASC'|'DESC',
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of networks to return in a single page. Valid range is 1-100. Default is 10.

  • sortFields (string) – The field to sort networks by. Accepted values are ‘networkId’ and ‘networkName’. Default is ‘networkId’.

  • sortDirection (string) – The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

  • nextToken (string) – The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

Return type:

dict

Returns:

Response Syntax

{
    'networks': [
        {
            'networkId': 'string',
            'networkName': 'string',
            'accessLevel': 'STANDARD'|'PREMIUM',
            'awsAccountId': 'string',
            'networkArn': 'string',
            'standing': 123,
            'freeTrialExpiration': 'string',
            'migrationState': 123,
            'encryptionKeyArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • networks (list) –

      A list of network objects for the Amazon Web Services account.

      • (dict) –

        Represents a Wickr network with all its configuration and status information.

        • networkId (string) –

          The unique identifier of the network.

        • networkName (string) –

          The name of the network.

        • accessLevel (string) –

          The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.

        • awsAccountId (string) –

          The Amazon Web Services account ID that owns the network.

        • networkArn (string) –

          The Amazon Resource Name (ARN) of the network.

        • standing (integer) –

          The current standing or status of the network.

        • freeTrialExpiration (string) –

          The expiration date and time for the network’s free trial period, if applicable.

        • migrationState (integer) –

          The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).

        • encryptionKeyArn (string) –

          The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.

    • nextToken (string) –

      The token to use for retrieving the next page of results. If this is not present, there are no more results.

Exceptions