Skip to content

modify_streaming_properties

modify_streaming_properties(
    resource_id: DirectoryId,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    streaming_properties: Optional[StreamingProperties] = None,
) -> ModifyStreamingPropertiesResult

Modifies the specified streaming properties.

Parameters:

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def modify_streaming_properties(
    self,
    resource_id: "capo_workspaces.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    streaming_properties: Optional[
        "capo_workspaces.types.streaming_properties.StreamingProperties"
    ] = None,
) -> "capo_workspaces.types.modify_streaming_properties_result.ModifyStreamingPropertiesResult":
    """<p>Modifies the specified streaming properties.</p>

    Args:
        resource_id: <p>The identifier of the resource.</p>
        streaming_properties: <p>The streaming properties to configure.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.modify_streaming_properties_request.ModifyStreamingPropertiesRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.modify_streaming_properties_result.ModifyStreamingPropertiesResult"
    ]:
        import capo_workspaces._operations.workspaces_service.modify_streaming_properties

        output, http_response = (
            capo_workspaces._operations.workspaces_service.modify_streaming_properties.modify_streaming_properties(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyStreamingProperties")
    )
    input_: capo_workspaces.types.modify_streaming_properties_request.ModifyStreamingPropertiesRequest = {
        "resource_id": resource_id
    }
    if streaming_properties is not None:
        input_["streaming_properties"] = streaming_properties

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output