EVS / Client / create_entitlement

create_entitlement

EVS.Client.create_entitlement(**kwargs)

Creates a Windows Server License entitlement for virtual machines in an Amazon EVS environment using the provided vCenter Server connector. This is an asynchronous operation. Amazon EVS validates the specified virtual machines before starting usage tracking.

See also: AWS API Documentation

Request Syntax

response = client.create_entitlement(
    clientToken='string',
    environmentId='string',
    connectorId='string',
    entitlementType='WINDOWS_SERVER',
    vmIds=[
        'string',
    ]
)
Parameters:

  • clientToken (string) –

    Note

    This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

    This field is autopopulated if not provided.

  • environmentId (string) –

    [REQUIRED]

    A unique ID for the environment to create the entitlement in.

  • connectorId (string) –

    [REQUIRED]

    A unique ID for the connector associated with the entitlement.

  • entitlementType (string) –

    [REQUIRED]

    The type of entitlement to create.

  • vmIds (list) –

    [REQUIRED]

    The list of VMware vSphere virtual machine managed object IDs to create entitlements for.

    • (string) –

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'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • entitlements (list) –

      A list of the created entitlements.

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