get_depot_url `async` ¶

get_depot_url(
    environment_id: EnvironmentId,
    *,
    config_overrides: Optional[AsyncevsClientConfig] = None,
    rotate: Optional[bool] = None,
) -> GetDepotUrlResponse

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.

Parameters:

environment_id (EnvironmentId) –

The unique ID of the Amazon EVS environment to get the depot URL for.
rotate (Optional[bool], default: None ) –

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.

Raises:

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.
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.
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.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_evs/_services/async_evs.py

async def get_depot_url(
    self,
    environment_id: "capo_evs.types.environment_id.EnvironmentId",
    *,
    config_overrides: Optional[AsyncevsClientConfig] = None,
    rotate: Optional[bool] = None,
) -> "capo_evs.types.get_depot_url_response.GetDepotUrlResponse":
    """<p>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.</p> <p>The depot URL remains active until you rotate the authentication token by calling this action with <code>rotate</code> set to <code>true</code>.</p>

    Args:
        environment_id: <p>The unique ID of the Amazon EVS environment to get the depot URL for.</p>
        rotate: <p>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.</p>

    Raises:
        capo_evs.errors.resource_not_found_exception.ResourceNotFoundException: <p>A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a <code>state</code> of <code>DELETED</code>.</p>
        capo_evs.errors.throttling_exception.ThrottlingException: <p>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.</p>
        capo_evs.errors.validation_exception.ValidationException: <p>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.</p>
        capo_evs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_evs.types.get_depot_url_request.GetDepotUrlRequest]",
    ) -> AsyncOperationResponse[
        "capo_evs.types.get_depot_url_response.GetDepotUrlResponse"
    ]:
        import capo_evs._operations.amazon_elastic_v_mware_service.get_depot_url

        (
            output,
            http_response,
        ) = await capo_evs._operations.amazon_elastic_v_mware_service.get_depot_url.async_get_depot_url(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDepotUrl")
    )
    input_: capo_evs.types.get_depot_url_request.GetDepotUrlRequest = {
        "environment_id": environment_id
    }
    if rotate is not None:
        input_["rotate"] = rotate

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_depot_url async ¶

get_depot_url `async` ¶