EVS / Client / get_depot_url

get_depot_url

EVS.Client.get_depot_url(**kwargs)

Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot. Configure the depot URL as a download source in vSphere Lifecycle Manager (vLCM) to sync and install the Amazon EVS Custom Addon.

The depot URL remains active until you rotate the authentication token by calling this action with rotate set to true.

See also: AWS API Documentation

Request Syntax

response = client.get_depot_url(
    environmentId='string',
    rotate=True|False
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    The unique ID of the Amazon EVS environment to get the depot URL for.

  • rotate (boolean) – Revokes the current authentication token and returns a new depot URL with a new token. Previously issued depot URLs will stop working within 5 minutes of rotation.

Return type:

dict

Returns:

Response Syntax

{
    'depotUrl': 'string',
    'token': 'string'
}

Response Structure

  • (dict) –

    • depotUrl (string) –

      The URL for accessing the Amazon EVS Custom Addon depot. This URL includes the authentication token as a path component.

    • token (string) –

      The authentication token for depot access. This token is included in the depot URL and is used to authenticate requests.

Exceptions

  • EVS.Client.exceptions.ThrottlingException

  • EVS.Client.exceptions.ValidationException

  • EVS.Client.exceptions.ResourceNotFoundException