EVS / Client / list_vm_entitlements

list_vm_entitlements¶

EVS.Client.list_vm_entitlements(**kwargs)¶

Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.

Request Syntax

response = client.list_vm_entitlements(
    nextToken='string',
    maxResults=123,
    environmentId='string',
    connectorId='string',
    entitlementType='WINDOWS_SERVER'
)

Parameters:

nextToken (string) – A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
maxResults (integer) – The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
            }
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
- 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.

Exceptions

EVS.Client.exceptions.ValidationException
EVS.Client.exceptions.ResourceNotFoundException