EVS / Paginator / ListVmEntitlements

ListVmEntitlements¶

class EVS.Paginator.ListVmEntitlements¶

paginator = client.get_paginator('list_vm_entitlements')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EVS.Client.list_vm_entitlements().

Request Syntax

response_iterator = paginator.paginate(
    environmentId='string',
    connectorId='string',
    entitlementType='WINDOWS_SERVER',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

environmentId (string) –
[REQUIRED]

A unique ID for the environment.
connectorId (string) –
[REQUIRED]

A unique ID for the connector.
entitlementType (string) –
[REQUIRED]

The type of entitlement to list.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'entitlements': [
        {
            'vmId': 'string',
            'environmentId': 'string',
            'connectorId': 'string',
            'vmName': 'string',
            'type': 'WINDOWS_SERVER',
            'status': 'CREATING'|'CREATED'|'DELETED'|'AT_RISK'|'ENTITLEMENT_REMOVED'|'CREATE_FAILED',
            'lastSyncedAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'errorDetail': {
                'errorCode': 'string',
                'errorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- entitlements (list) –
  
  A list of entitlements for virtual machines in the environment.
  - (dict) –
    
    An object that represents a Windows Server License entitlement for a virtual machine in an Amazon EVS environment.
    - vmId (string) –
      
      The unique ID of the virtual machine.
    - environmentId (string) –
      
      The unique ID of the environment.
    - connectorId (string) –
      
      The unique ID of the connector associated with the entitlement.
    - vmName (string) –
      
      The name of the virtual machine.
    - type (string) –
      
      The type of entitlement.
    - status (string) –
      
      The status of the entitlement.
    - lastSyncedAt (datetime) –
      
      The date and time that the entitlement was last synced.
    - startedAt (datetime) –
      
      The date and time that the entitlement started.
    - stoppedAt (datetime) –
      
      The date and time that the entitlement stopped.
    - errorDetail (dict) –
      
      The error details associated with the entitlement, if applicable.
      - errorCode (string) –
        
        The error code.
      - errorMessage (string) –
        
        The error message.
- NextToken (string) –
  
  A token to resume pagination.