Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDepotUrl

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.

Request Syntax


{
   "environmentId": "string",
   "rotate": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

environmentId

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

Type: String

Pattern: (env-[a-zA-Z0-9]{10})

Required: Yes

rotate

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.

Type: Boolean

Required: No

Response Syntax


{
   "depotUrl": "string",
   "token": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

depotUrl

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

Type: String

token

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceNotFoundException

A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.

message: Describes the error encountered.
resourceId: The ID of the resource that could not be found.
resourceType: The type of the resource that is associated with the error.

HTTP Status Code: 400

ThrottlingException

The operation could not be performed because the service is throttling requests. This exception is thrown when the service endpoint receives too many concurrent requests.

message: Describes the error encountered.
retryAfterSeconds: The seconds to wait to retry.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.

fieldList: A list of fields that didn't validate.
message: Describes the error encountered.
reason: The reason for the exception.

HTTP Status Code: 400